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
-
Type:
string
Required:true
ID of the scheduled order to be retrieved.
Query Parameters
- orderDetails
-
Type:
boolean
The flag indicating whether to fetch the template order details.
Header Parameters
- X-CCOrganization
-
Type:
string
The organization Id to which the order belongs
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getScheduledOrder_response
- createDate
-
Type:
string
Scheduled Order creation date. - endDate
-
Type:
string
Scheduled order end date. - executionStatusList
-
Type:
array
executionStatusListThe list of executions from this scheduled order. - id
-
Type:
string
ID of the scheduled order. - lastScheduledRun
-
Type:
string
Last scheduled run date of the scheduled order. - name
-
Type:
string
Name of the Scheduled Order. - nextScheduledRun
-
Type:
string
Next scheduled run date of the scheduled order. - profileId
-
Type:
string
Profile ID of the shopper associated with the scheduled order. - repositoryId
-
Type:
string
Repository ID of the scheduled order. - schedule
-
Type:
object
scheduleSchedule of this scheduled order - startDate
-
Type:
string
Scheduled Order start date. - state
-
Type:
string
The state of the scheduled order. - templateOrder
-
Type:
object
templateOrderThe template order details - templateOrderId
-
Type:
string
The template order id.
Nested Schema : executionStatusList
Nested Schema : schedule
Type:
object
Schedule of this scheduled order
- daysInMonth
-
Type:
array
daysInMonthDays in a month this scheduled order has to be placed - daysOfWeek
-
Type:
array
daysOfWeekDays in a week this scheduled order has to be placed - monthsInYear
-
Type:
array
monthsInYearMonths in a year this scheduled order has to be placed - occurrenceInDay
-
Type:
integer
The number of times this scheduled order is placed in a day - weeksInMonth
-
Type:
array
weeksInMonthWeeks in a month this scheduled order has to be placed
Nested Schema : templateOrder
Type:
object
The template order details
- billingMethod
-
Type:
object
billingMethodbilling Method information of the order. - creationDate
-
Type:
string
Date on which the Order was created. - creationTime
-
Type:
number
Order creation time. - discountInfo
-
Type:
object
discountInfoDiscount information. - dynamicProperties
-
Type:
array
dynamicPropertiesRead-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
array
giftWithPurchaseInfoThe gift information. - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersgwpOrderMarker information - id
-
Type:
string
Commerce id for this order. - isItemPriceOverrideAllowed
-
Type:
boolean
Indicates whether an item price can be overridden. - orderCancelReason
-
Type:
string
Reason through which the order has been cancelled. - orderComments
-
Type:
array
orderCommentsThe list of all logged comments for the order. - paymentGroup
-
Type:
object
paymentGroupPayment Group for the order. - paymentGroups
-
Type:
array
paymentGroupsList of payment Groups for the order. - priceInfo
-
Type:
object
priceInfoPrice information of the order. - priceListGroup
-
Type:
object
priceListGroupPriceList group of the order. - profile
-
Type:
object
profileProfile Information for the order. - profileId
-
Type:
string
The Repository Id of the profile to which this Order belongs to. - returnRequests
-
Type:
array
returnRequestsThe list of the requests raised for the order. - shippingAddress
-
Type:
object
shippingAddressshipping address for the order. - shippingGroups
-
Type:
array
shippingGroupsShipping Group Information - shippingMethod
-
Type:
object
shippingMethodShipping method information. - shoppingCart
-
Type:
object
shoppingCartShopping cart information. - state
-
Type:
integer
The order state. - stateDetailsAsUser
-
Type:
string
Order State description for this order. - stateString
-
Type:
string
Order state as key string. - submittedDate
-
Type:
string
Date on which the order was submitted. - taxPriceInfo
-
Type:
object
taxPriceInfoThe tax pricing details for the order. - totalAmountAuthorized
-
Type:
number
total amount authorized for the order.
Nested Schema : items
Type:
object
- currency
-
Type:
string
currency set for the scheduled order. - errorMessages
-
Type:
array
errorMessagesThe list of error messages for this execution. - executionDate
-
Type:
string
The execution date. - id
-
Type:
string
ID of the execution status. - orderId
-
Type:
string
Order ID of the order submitted in that particular execution. - orderSubmitted
-
Type:
boolean
The boolean indicating whether the order has been submitted successfully during the execution. - orderTotal
-
Type:
number
Order total. - repositoryId
-
Type:
string
The repository id of the execution status. - scheduledOrderId
-
Type:
string
Scheuduled Order ID to which the order submitted in this particular execution belongs.
Nested Schema : errorMessages
Nested Schema : daysInMonth
Nested Schema : daysOfWeek
Nested Schema : monthsInYear
Nested Schema : weeksInMonth
Nested Schema : billingMethod
Type:
object
billing Method information of the order.
- cost
-
Type:
number
billing Cost for this order. - displayName
-
Type:
string
billing method display name for this billing method. - value
-
Type:
string
billing method name for this order.
Nested Schema : discountInfo
Type:
object
Discount information.
- claimedCouponMultiPromotions
-
Type:
object
claimedCouponMultiPromotionsThe coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsThe coupons that were not claimed - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - balance
-
Type:
string
The gift card balance available. - billingAddress
-
Type:
object
billingAddressBilling address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
The credit card type. - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - paymentStatString
-
Type:
string
The payment state as a key string. - PONumber
-
Type:
string
Purchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
object
Price information of the order.
- amount
-
Type:
number
The raw number that represents the price. - billing
-
Type:
number
The billing cost of the order. - currencyCode
-
Type:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars. - subTotal
-
Type:
number
The subtotal of the order before applying order-level promotions. - tax
-
Type:
number
The tax on the order. - total
-
Type:
number
The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
- active
-
Type:
boolean
Active status of pricelist group. - currency
-
Type:
object
currencyCurrency of the PriceList group. - deleted
-
Type:
boolean
Pricelist group deleted status. - displayName
-
Type:
string
Display Name. - id
-
Type:
string
Id. - locale
-
Type:
string
Locale. - repositoryId
-
Type:
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
-
Type:
string
Email Address corresponding to the profile. - firstName
-
Type:
string
First name of profile. - isAnonymous
-
Type:
boolean
Indicates whether this profile is an anonymous profile. By default, it is false. - lastName
-
Type:
string
Last name of profile. - middleName
-
Type:
string
Middle name of profile. - organization
-
Type:
object
organizationThe Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - state
-
Type:
string
State for this shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment
Nested Schema : shoppingCart
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
- coupon code
-
Type:
array
coupon codeCoupon Code, corresponding to which promotions were applied
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- coupon code
-
Type:
array
coupon codeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level - totalAdjustment
-
Type:
number
Adjustment done by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : coupon code
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- giftWithPurchaseDetail
-
Type:
string
String identifying the free gift, usually the repository id of the gift type. - giftWithPurchaseIdentifier
-
Type:
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
-
Type:
number
gift quantity available for selection - giftWithPurchaseType
-
Type:
string
The type of the gift. (sku, product) - promotionId
-
Type:
string
The gift with purchase promotion id
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
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
-
Type:
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
-
Type:
string
String identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
string
The type of the gift. (sku, product) - key
-
Type:
string
atg.gwp - quantity
-
Type:
number
The total quantity of sku for this gift selection. - removedQuantity
-
Type:
number
The amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
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
-
Type:
string
The gift with purchase promotion id
Nested Schema : items
Type:
object
- comment
-
Type:
string
The comment string. - creationDate
-
Type:
string
Date on which the comment was created. - repositoryId
-
Type:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : items
Type:
object
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - balance
-
Type:
string
The gift card balance available. - billingAddress
-
Type:
object
billingAddressBilling address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - paymentStateString
-
Type:
string
The payment state as a key String. - PONumber
-
Type:
string
Purchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - state
-
Type:
string
State for this billing address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
- currencyCode
-
Type:
string
Currency Code. - displayName
-
Type:
string
Display Name. - fractionalDigits
-
Type:
integer
Fractional Digits. - numericCode
-
Type:
string
Numeric Code. - repositoryId
-
Type:
string
Repository Id. - symbol
-
Type:
string
currency Symbol.
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
- id
-
Type:
string
The id of the organization. - name
-
Type:
string
The name of of the organization.
Nested Schema : items
Type:
object
- createdDate
-
Type:
string
The creation date of the return request. - returnRequestId
-
Type:
string
The return request id. - state
-
Type:
string
The status of the return request. - totalRefund
-
Type:
number
The total amount to be refunded on return. - totalReturnQuantity
-
Type:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
object
- shippingAddress
-
Type:
object
shippingAddressshipping address for the order. - shippingMethod
-
Type:
object
shippingMethodShipping method information. - trackingInfo
-
Type:
array
trackingInfoTracking Information for the Order. - trackingNumber
-
Type:
string
Shipping tracking number.
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - state
-
Type:
string
State for this shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object
- carrierId
-
Type:
string
Carrier Id for Tracking. - carrierName
-
Type:
string
Carrier Name for Tracking. - carrierUrl
-
Type:
string
Carrier URL for Tracking. - trackingNumber
-
Type:
string
Tracking Number
Nested Schema : items
Type:
object
- catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsChild items of the commerce item - commerceItemId
-
Type:
string
Unique id of the line item - configuratorId
-
Type:
string
Configuration id of the configurable product - discountAmount
-
Type:
number
Total discount applied to commerce item. - discountInfo
-
Type:
object
discountInfoDiscount information. - displayName
-
Type:
string
Display name of commerce item. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersThe array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
object
imageInfoShipping method information. - isPriceOverridden
-
Type:
boolean
Indicates if commerce item price is overridden or not. - onSale
-
Type:
boolean
indicates if product is on sale or not - overriddenPrice
-
Type:
number
overridden price of commerce item. - price
-
Type:
number
The raw number that represents the price. - priceOverridenBy
-
Type:
string
Name of the agent who has overridden item price. - priceOverrideReason
-
Type:
object
priceOverrideReasonPrice override reason map. - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
The raw total price. - returnedQuantity
-
Type:
number
Quantity for which return request has been raised. - stateDescription
-
Type:
string
Item state as a key string. - stateDetailsAsUser
-
Type:
string
State description of the commerce item. - status
-
Type:
integer
State of the commerce item. - subTotal
-
Type:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
number
The amount of tax paid for this item. - unitPrice
-
Type:
number
Sale price or list price of commerceItem. - variant
-
Type:
array
variantProduct Variant Information.
Nested Schema : discountInfo
Type:
object
Discount information.
- orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : imageInfo
Type:
object
Shipping method information.
- primaryThumbImageURL
-
Type:
string
ThumbNail Image URL
Nested Schema : priceOverrideReason
Type:
object
Price override reason map.
- displayValue
-
Type:
string
price override reason value. - key
-
Type:
string
price override reason key.
Nested Schema : items
Type:
object
- catRefId
-
Type:
string
Sku Id of the child item - displayName
-
Type:
string
Display name of the child product - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Product path - selectedOptions
-
Type:
array
selectedOptionsChild Product Variant Information.
Nested Schema : selectedOptions
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integer
The gift hash code for this GWP promotion. - key
-
Type:
string
atg.gwp - remainingQuantity
-
Type:
number
The quantity of the commerce item that is not affected by GWP. - selectedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
string
The gift with purchase promotion id.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Example 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":1.47972689E12,
"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@s.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@s.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@s.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@s.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@s.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.
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|
Body
Root Schema : errorModel
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAn optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code
Examples
Sample Response Payload returned by endpoint:
{ "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@s.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@s.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@s.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@s.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@s.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" }