getScheduledOrder
get
/ccagent/v1/scheduledOrders/{id}
Get Scheduled Order. Loads a scheduled order details from the repository. Maps all required fields for scheduled order details. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID of the scheduled order to be retrieved.
Query Parameters
-
orderDetails: boolean
The flag indicating whether to fetch the template order details.
Header Parameters
-
X-CCOrganization: string
The organization Id to which the order belongs
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getScheduledOrder_response
Type:
Show Source
object-
createDate:
string
Scheduled Order creation date.
-
endDate:
string
Scheduled order end date.
-
executionStatusList:
array executionStatusList
The list of executions from this scheduled order.
-
id:
string
ID of the scheduled order.
-
lastScheduledRun:
string
Last scheduled run date of the scheduled order.
-
name:
string
Name of the Scheduled Order.
-
nextScheduledRun:
string
Next scheduled run date of the scheduled order.
-
profileId:
string
Profile ID of the shopper associated with the scheduled order.
-
repositoryId:
string
Repository ID of the scheduled order.
-
schedule:
object schedule
Schedule of this scheduled order
-
startDate:
string
Scheduled Order start date.
-
state:
string
The state of the scheduled order.
-
templateOrder:
object templateOrder
The template order details
-
templateOrderId:
string
The template order id.
Nested Schema : executionStatusList
Type:
arrayThe list of executions from this scheduled order.
Show Source
Nested Schema : schedule
Type:
objectSchedule of this scheduled order
Show Source
-
daysInMonth:
array daysInMonth
Days in a month this scheduled order has to be placed
-
daysOfWeek:
array daysOfWeek
Days in a week this scheduled order has to be placed
-
delay:
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
monthsInYear:
array monthsInYear
Months in a year this scheduled order has to be placed
-
occurrenceInDay:
integer
The number of times this scheduled order is placed in a day
-
period:
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
weeksInMonth:
array weeksInMonth
Weeks in a month this scheduled order has to be placed
Nested Schema : templateOrder
Type:
objectThe template order details
Show Source
-
billingMethod:
object billingMethod
billing Method information of the order.
-
creationDate:
string
Date on which the Order was created.
-
creationTime:
number
Order creation time.
-
discountInfo:
object discountInfo
Discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo:
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
gwpOrderMarker information
-
id:
string
Commerce id for this order.
-
isItemPriceOverrideAllowed:
boolean
Indicates whether an item price can be overridden.
-
orderCancelReason:
string
Reason through which the order has been cancelled.
-
orderComments:
array orderComments
The list of all logged comments for the order.
-
paymentGroup:
object paymentGroup
Payment Group for the order.
-
paymentGroups:
array paymentGroups
List of payment Groups for the order.
-
priceInfo:
object priceInfo
Price information of the order.
-
priceListGroup:
object priceListGroup
PriceList group of the order.
-
profile:
object profile
Profile Information for the order.
-
profileId:
string
The Repository Id of the profile to which this Order belongs to.
-
returnRequests:
array returnRequests
The list of the requests raised for the order.
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingGroups:
array shippingGroups
Shipping Group Information
-
shippingMethod:
object shippingMethod
Shipping method information.
-
shoppingCart:
object shoppingCart
Shopping cart information.
-
state:
integer
The order state.
-
stateDetailsAsUser:
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
stateString:
string
Order state as key string.
-
submittedDate:
string
Date on which the order was submitted.
-
taxPriceInfo:
object taxPriceInfo
The tax pricing details for the order.
-
totalAmountAuthorized:
number
total amount authorized for the order.
Nested Schema : items
Type:
Show Source
object-
currency:
string
currency set for the scheduled order.
-
errorMessages:
array errorMessages
The list of error messages for this execution.
-
executionDate:
string
The execution date.
-
id:
string
ID of the execution status.
-
orderId:
string
Order ID of the order submitted in that particular execution.
-
orderSubmitted:
boolean
The boolean indicating whether the order has been submitted successfully during the execution.
-
orderTotal:
number
Order total.
-
repositoryId:
string
The repository id of the execution status.
-
scheduledOrderId:
string
Scheuduled Order ID to which the order submitted in this particular execution belongs.
Nested Schema : errorMessages
Type:
arrayThe list of error messages for this execution.
Show Source
Nested Schema : daysInMonth
Type:
arrayDays in a month this scheduled order has to be placed
Show Source
Nested Schema : daysOfWeek
Type:
arrayDays in a week this scheduled order has to be placed
Show Source
Nested Schema : monthsInYear
Type:
arrayMonths in a year this scheduled order has to be placed
Show Source
Nested Schema : weeksInMonth
Type:
arrayWeeks in a month this scheduled order has to be placed
Show Source
Nested Schema : billingMethod
Type:
objectbilling Method information of the order.
Show Source
-
cost:
number
billing Cost for this order.
-
displayName:
string
billing method display name for this billing method.
-
value:
string
billing method name for this order.
Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : orderComments
Type:
arrayThe list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type:
objectPayment Group for the order.
Show Source
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
balance:
string
The gift card balance available.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
The credit card type.
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
paymentStatString:
string
The payment state as a key string.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : priceInfo
Type:
objectPrice information of the order.
Show Source
-
amount:
number
The raw number that represents the price.
-
billing:
number
The billing cost of the order.
-
currencyCode:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
subTotal:
number
The subtotal of the order before applying order-level promotions.
-
tax:
number
The tax on the order.
-
total:
number
The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
objectPriceList group of the order.
Show Source
-
active:
boolean
Active status of pricelist group.
-
currency:
object currency
Currency of the PriceList group.
-
deleted:
boolean
Pricelist group deleted status.
-
displayName:
string
Display Name.
-
id:
string
Id.
-
locale:
string
Locale.
-
repositoryId:
string
Repository Id.
Nested Schema : profile
Type:
objectProfile Information for the order.
Show Source
-
email:
string
Email Address corresponding to the profile.
-
firstName:
string
First name of profile.
-
isAnonymous:
boolean
Indicates whether this profile is an anonymous profile. By default, it is false.
-
lastName:
string
Last name of profile.
-
middleName:
string
Middle name of profile.
-
organization:
object organization
The Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Type:
arrayThe list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
state:
string
State for this shipping address.
-
suffix:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
value:
string
method type of shipment
Nested Schema : shoppingCart
Type:
objectShopping cart information.
Show Source
-
items:
array items
Items in the cart.
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
cityTax:
number
The monetary amount of city tax.
-
countryTax:
number
The monetary amount of country tax.
-
countyTax:
number
The monetary amount of county tax.
-
currencyCode:
string
The three character currency code.
-
discounted:
boolean
Whether the price was discounted.
-
districtTax:
number
Tax amount for the district.
-
stateTax:
number
Tax amount for the state.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
Nested Schema : items
Type:
Show Source
object-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
id:
string
The ID of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftWithPurchaseIdentifier:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
giftWithPurchaseQuantityAvailableForSelection:
number
gift quantity available for selection
-
giftWithPurchaseType:
string
The type of the gift. (sku, product)
-
promotionId:
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
atg.gwp
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value:
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object-
comment:
string
The comment string.
-
creationDate:
string
Date on which the comment was created.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
objectBilling address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
state:
string
State for this billing address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
balance:
string
The gift card balance available.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
paymentStateString:
string
The payment state as a key String.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : billingAddress
Type:
objectBilling address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
state:
string
State for this billing address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : currency
Type:
objectCurrency of the PriceList group.
Show Source
-
currencyCode:
string
Currency Code.
-
displayName:
string
Display Name.
-
fractionalDigits:
integer
Fractional Digits.
-
numericCode:
string
Numeric Code.
-
repositoryId:
string
Repository Id.
-
symbol:
string
currency Symbol.
Nested Schema : organization
Type:
objectThe Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
Nested Schema : items
Type:
Show Source
object-
createdDate:
string
The creation date of the return request.
-
returnRequestId:
string
The return request id.
-
state:
string
The status of the return request.
-
stateKey:
string
State key for return request which is not localized
-
totalRefund:
number
The total amount to be refunded on return.
-
totalReturnQuantity:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
Show Source
object-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingMethod:
object shippingMethod
Shipping method information.
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
Shipping tracking number.
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
state:
string
State for this shipping address.
-
suffix:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
value:
string
method type of shipment.
Nested Schema : items
Type:
Show Source
object-
carrierId:
string
Carrier Id for Tracking.
-
carrierName:
string
Carrier Name for Tracking.
-
carrierUrl:
string
Carrier URL for Tracking.
-
trackingNumber:
string
Tracking Number
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
Catalog Reference Id of commerce item.
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
Unique id of the line item
-
configuratorId:
string
Configuration id of the configurable product
-
discountAmount:
number
Total discount applied to commerce item.
-
discountInfo:
object discountInfo
Discount information.
-
displayName:
string
Display name of commerce item.
-
externalPrice:
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity:
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
imageInfo:
object imageInfo
Shipping method information.
-
isPriceOverridden:
boolean
Indicates if commerce item price is overridden or not.
-
onSale:
boolean
indicates if product is on sale or not
-
overriddenPrice:
number
overridden price of commerce item.
-
price:
number
The raw number that represents the price.
-
priceOverridenBy:
string
Name of the agent who has overridden item price.
-
priceOverrideReason:
object priceOverrideReason
Price override reason map.
-
productId:
string
Product Id of commerce item.
-
quantity:
number
Quantity of the items.
-
rawTotalPrice:
number
The raw total price.
-
returnedQuantity:
number
Quantity for which return request has been raised.
-
stateDescription:
string
Item state as a key string.
-
stateDetailsAsUser:
string
State description of the commerce item.
-
status:
integer
State of the commerce item.
-
subTotal:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
-
tax:
number
The amount of tax paid for this item.
-
unitPrice:
number
Sale price or list price of commerceItem.
-
variant:
array variant
Product Variant Information.
Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arrayThe array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : imageInfo
Type:
objectShipping method information.
Show Source
-
primaryThumbImageURL:
string
ThumbNail Image URL
Nested Schema : priceOverrideReason
Type:
objectPrice override reason map.
Show Source
-
displayValue:
string
price override reason value.
-
key:
string
price override reason key.
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
Sku Id of the child item
-
displayName:
string
Display name of the child product
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
route:
string
Product path
-
selectedOptions:
array selectedOptions
Child Product Variant Information.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this GWP promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by GWP.
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Example Response (application/json)
{
"lastError":null,
"endDate":"2016-12-08T00:00:00.000Z",
"executionStatusList":[
{
"errorMessages":[
"Exception While cloning an order."
],
"scheduledOrderId":"sco1001",
"orderId":null,
"repositoryId":"600005",
"executionDate":"2016-11-23T00:00:00.000Z",
"currency":"USD",
"id":"600005",
"orderSubmitted":false,
"orderTotal":null
}
],
"type":"scheduledOrder",
"version":25,
"lastScheduledRun":"2016-11-23T00:00:00.000Z",
"schedule":{
"daysInMonth":[
],
"weeksInMonth":[
],
"monthsInYear":[
1,
3,
5,
7,
9,
11
],
"daysOfWeek":[
],
"occurrenceInDay":1
},
"templateOrderId":"o30414",
"clonedOrders":[
],
"profileId":"120939",
"templateOrder":{
"totalAmountAuthorized":0,
"creationTime":"1479726890000",
"orderComments":[
],
"dynamicProperties":[
],
"stateString":"TEMPLATE",
"submittedDate":null,
"paymentGroups":[
{
"PONumber":"",
"paymentGroupId":"pg30412",
"paymentStateString":"INITIAL",
"amountAuthorized":0,
"amount":51.7,
"totalDue":51.7,
"billingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"paymentState":0,
"type":"invoice",
"paidAmount":0,
"refundAmount":0
}
],
"priceInfo":{
"amount":21.99,
"total":51.7,
"shipping":25,
"shippingSurchargeValue":0,
"tax":4.71,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"pricingMessages":{
},
"paymentGroup":{
"PONumber":"",
"paymentGroupId":"pg30412",
"paymentStateString":"INITIAL",
"amountAuthorized":0,
"amount":51.7,
"totalDue":51.7,
"billingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"paymentState":0,
"type":"invoice",
"paidAmount":0,
"refundAmount":0
},
"shoppingCart":{
"items":[
{
"unitPrice":21.99,
"quantity":1,
"productId":"Product_36Exy",
"rawTotalPrice":21.99,
"returnedQuantity":0,
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":21.99,
"quantity":1,
"tax":2.2,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"displayName":"The Girl with the Dragon Tattoo",
"shippingSurchargeValue":0,
"giftWithPurchaseCommerceItemMarkers":[
],
"discountAmount":0,
"imageInfo":{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100"
},
"tax":2.2,
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"price":21.99,
"variant":[
],
"onSale":false,
"stateDescription":"INITIAL",
"listPrice":21.99,
"stateDetailsAsUser":"Added to order",
"status":0
}
]
},
"id":"o30414",
"state":4001,
"stateDetailsAsUser":"Scheduled order template",
"taxPriceInfo":{
"cityTax":1.65,
"amount":4.71,
"valueAddedTax":0,
"countyTax":1.1800000000000002,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.88,
"countryTax":0
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":1.65,
"amount":4.71,
"valueAddedTax":0,
"countyTax":1.1800000000000002,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.88,
"countryTax":0
},
"shippingMethod":{
"shippingTax":2.51,
"cost":25,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"shippingGroupId":"sg40414",
"submittedDate":null,
"priceInfo":{
"amount":21.99,
"total":51.7,
"shipping":25,
"shippingSurchargeValue":0,
"tax":4.71,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":"Address",
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"items":[
{
"unitPrice":21.99,
"primaryImageTitle":"The Girl with the Dragon Tattoo",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100",
"quantity":1,
"productId":"Product_36Exy",
"rawTotalPrice":21.99,
"returnedQuantity":0,
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":21.99,
"quantity":1,
"tax":2.2,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"displayName":"The Girl with the Dragon Tattoo",
"shippingSurchargeValue":0,
"discountAmount":0,
"active":true,
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"route":"/product/Product_36Exy",
"price":21.99,
"variant":[
],
"onSale":false,
"primaryImageAltText":"The Girl with the Dragon Tattoo",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"listPrice":21.99,
"status":"INITIAL"
}
],
"trackingNumber":null,
"status":"INITIAL"
}
],
"shippingMethod":{
"shippingTax":2.51,
"cost":25,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"profile":{
"firstName":"Shiv",
"lastName":"Shankar",
"middleName":null,
"email":"s@example.com"
},
"priceListGroup":{
"deleted":false,
"displayName":"Default Price Group",
"repositoryId":"defaultPriceGroup",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
}
},
"returnRequests":[
],
"creationDate":"2016-11-21T11:14:50.000Z",
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"orderCancelReason":null,
"profileId":"120939",
"exchangeRequests":[
],
"giftWithPurchaseInfo":[
],
"shippingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":"Address",
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"giftWithPurchaseOrderMarkers":[
]
},
"repositoryId":"sco10002",
"name":"Monthly Order",
"siteId":"siteUS",
"nextScheduledRun":"1969-12-31T23:59:59.999Z",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002"
}
],
"state":"active",
"id":"sco10002",
"startDate":"2016-12-01T00:00:00.000Z",
"createDate":"2016-11-21T11:15:15.000Z"
}Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|100101|The shopper profile does not belong to organization passed in the header|
|100102|Organization passed in the header is invalid or does not exist|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code