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:
stringRequired:trueID of the scheduled order to be retrieved.
Query Parameters
- orderDetails
-
Type:
booleanThe flag indicating whether to fetch the template order details.
Header Parameters
- X-CCOrganization
-
Type:
stringThe 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:
stringScheduled Order creation date. - endDate
-
Type:
stringScheduled order end date. - executionStatusList
-
Type:
arrayexecutionStatusListThe list of executions from this scheduled order. - id
-
Type:
stringID of the scheduled order. - lastScheduledRun
-
Type:
stringLast scheduled run date of the scheduled order. - name
-
Type:
stringName of the Scheduled Order. - nextScheduledRun
-
Type:
stringNext scheduled run date of the scheduled order. - profileId
-
Type:
stringProfile ID of the shopper associated with the scheduled order. - repositoryId
-
Type:
stringRepository ID of the scheduled order. - schedule
-
Type:
objectscheduleSchedule of this scheduled order - startDate
-
Type:
stringScheduled Order start date. - state
-
Type:
stringThe state of the scheduled order. - templateOrder
-
Type:
objecttemplateOrderThe template order details - templateOrderId
-
Type:
stringThe template order id.
Nested Schema : executionStatusList
Nested Schema : schedule
Type:
objectSchedule of this scheduled order
- daysInMonth
-
Type:
arraydaysInMonthDays in a month this scheduled order has to be placed - daysOfWeek
-
Type:
arraydaysOfWeekDays in a week this scheduled order has to be placed - monthsInYear
-
Type:
arraymonthsInYearMonths in a year this scheduled order has to be placed - occurrenceInDay
-
Type:
integerThe number of times this scheduled order is placed in a day - weeksInMonth
-
Type:
arrayweeksInMonthWeeks in a month this scheduled order has to be placed
Nested Schema : templateOrder
Type:
objectThe template order details
- billingMethod
-
Type:
objectbillingMethodbilling Method information of the order. - creationDate
-
Type:
stringDate on which the Order was created. - creationTime
-
Type:
numberOrder creation time. - discountInfo
-
Type:
objectdiscountInfoDiscount information. - dynamicProperties
-
Type:
arraydynamicPropertiesRead-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
arraygiftWithPurchaseInfoThe gift information. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersgwpOrderMarker information - id
-
Type:
stringCommerce id for this order. - isItemPriceOverrideAllowed
-
Type:
booleanIndicates whether an item price can be overridden. - orderCancelReason
-
Type:
stringReason through which the order has been cancelled. - orderComments
-
Type:
arrayorderCommentsThe list of all logged comments for the order. - paymentGroup
-
Type:
objectpaymentGroupPayment Group for the order. - paymentGroups
-
Type:
arraypaymentGroupsList of payment Groups for the order. - priceInfo
-
Type:
objectpriceInfoPrice information of the order. - priceListGroup
-
Type:
objectpriceListGroupPriceList group of the order. - profile
-
Type:
objectprofileProfile Information for the order. - profileId
-
Type:
stringThe Repository Id of the profile to which this Order belongs to. - returnRequests
-
Type:
arrayreturnRequestsThe list of the requests raised for the order. - shippingAddress
-
Type:
objectshippingAddressshipping address for the order. - shippingGroups
-
Type:
arrayshippingGroupsShipping Group Information - shippingMethod
-
Type:
objectshippingMethodShipping method information. - shoppingCart
-
Type:
objectshoppingCartShopping cart information. - state
-
Type:
integerThe order state. - stateDetailsAsUser
-
Type:
stringOrder State description for this order. - stateString
-
Type:
stringOrder state as key string. - submittedDate
-
Type:
stringDate on which the order was submitted. - taxPriceInfo
-
Type:
objecttaxPriceInfoThe tax pricing details for the order. - totalAmountAuthorized
-
Type:
numbertotal amount authorized for the order.
Nested Schema : items
Type:
object- currency
-
Type:
stringcurrency set for the scheduled order. - errorMessages
-
Type:
arrayerrorMessagesThe list of error messages for this execution. - executionDate
-
Type:
stringThe execution date. - id
-
Type:
stringID of the execution status. - orderId
-
Type:
stringOrder ID of the order submitted in that particular execution. - orderSubmitted
-
Type:
booleanThe boolean indicating whether the order has been submitted successfully during the execution. - orderTotal
-
Type:
numberOrder total. - repositoryId
-
Type:
stringThe repository id of the execution status. - scheduledOrderId
-
Type:
stringScheuduled 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:
objectbilling Method information of the order.
- cost
-
Type:
numberbilling Cost for this order. - displayName
-
Type:
stringbilling method display name for this billing method. - value
-
Type:
stringbilling method name for this order.
Nested Schema : discountInfo
Type:
objectDiscount information.
- claimedCouponMultiPromotions
-
Type:
objectclaimedCouponMultiPromotionsThe coupons that were claimed - orderCouponsMap
-
Type:
arrayorderCouponsMapMap of coupons. - orderDiscount
-
Type:
numberDiscount given on an order. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integerThe shipping discount. - unclaimedCouponMultiPromotions
-
Type:
objectunclaimedCouponMultiPromotionsThe coupons that were not claimed - unclaimedCouponsMap
-
Type:
arrayunclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
objectPayment Group for the order.
- amount
-
Type:
numberThe amount associated with this Payment Group. - amountAuthorized
-
Type:
numberThe amount authorized with this Payment Group. - balance
-
Type:
stringThe gift card balance available. - billingAddress
-
Type:
objectbillingAddressBilling address for the order. - cardNumber
-
Type:
stringThe masked credit card number. - cardType
-
Type:
stringThe credit card type. - firstName
-
Type:
stringFirst name associated with this Payment Group. - lastName
-
Type:
stringLast name associated with this Payment Group. - paidAmount
-
Type:
numberThe amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integerId of this payment Group. - paymentState
-
Type:
stringThe Payment Group state. - paymentStateDetailsAsUser
-
Type:
stringThe payment state description as string. - paymentStatString
-
Type:
stringThe payment state as a key string. - PONumber
-
Type:
stringPurchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
numberThe amount that has been credited to-date for this Payment Group. - token
-
Type:
stringToken associated with this Payment Group. - totalDue
-
Type:
numberThe current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
objectPrice information of the order.
- amount
-
Type:
numberThe raw number that represents the price. - billing
-
Type:
numberThe billing cost of the order. - currencyCode
-
Type:
stringIndicates the currency of the price. For example, USD indicates that the price is in US dollars. - subTotal
-
Type:
numberThe subtotal of the order before applying order-level promotions. - tax
-
Type:
numberThe tax on the order. - total
-
Type:
numberThe current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
objectPriceList group of the order.
- active
-
Type:
booleanActive status of pricelist group. - currency
-
Type:
objectcurrencyCurrency of the PriceList group. - deleted
-
Type:
booleanPricelist group deleted status. - displayName
-
Type:
stringDisplay Name. - id
-
Type:
stringId. - locale
-
Type:
stringLocale. - repositoryId
-
Type:
stringRepository Id.
Nested Schema : profile
Type:
objectProfile Information for the order.
-
Type:
stringEmail Address corresponding to the profile. - firstName
-
Type:
stringFirst name of profile. - isAnonymous
-
Type:
booleanIndicates whether this profile is an anonymous profile. By default, it is false. - lastName
-
Type:
stringLast name of profile. - middleName
-
Type:
stringMiddle name of profile. - organization
-
Type:
objectorganizationThe Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
- address1
-
Type:
stringAddress Line 1 for this shipping address. - address2
-
Type:
stringAddress Line 2 for this shipping address. - address3
-
Type:
stringAddress Line 3 for this shipping address. - city
-
Type:
stringCity for this shipping address. - companyName
-
Type:
stringCompany name for this shipping address. - country
-
Type:
stringCountry for this shipping address. - county
-
Type:
stringCounty for this shipping address. -
Type:
stringEmail for this shipping address. - faxNumber
-
Type:
stringFax number for this shipping address. - firstName
-
Type:
stringFirst name for this shipping address. - jobTitle
-
Type:
stringJob title for this shipping address. - lastName
-
Type:
stringLast name for this shipping address. - middleName
-
Type:
stringMiddle name for this shipping address. - phoneNumber
-
Type:
stringPhone number for this shipping address. - postalCode
-
Type:
stringPostal code for this shipping address. - prefix
-
Type:
stringPrefix for this shipping address. - state
-
Type:
stringState for this shipping address. - suffix
-
Type:
stringSuffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
- cost
-
Type:
numbershipping cost. - displayName
-
Type:
stringDisplay Name of shipment. - value
-
Type:
stringmethod type of shipment
Nested Schema : shoppingCart
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - cityTax
-
Type:
numberThe monetary amount of city tax. - countryTax
-
Type:
numberThe monetary amount of country tax. - countyTax
-
Type:
numberThe monetary amount of county tax. - currencyCode
-
Type:
stringThe three character currency code. - discounted
-
Type:
booleanWhether the price was discounted. - districtTax
-
Type:
numberTax amount for the district. - stateTax
-
Type:
numberTax amount for the state.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed
- coupon code
-
Type:
arraycoupon codeCoupon Code, corresponding to which promotions were applied
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
- coupon code
-
Type:
arraycoupon codeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringPromotion Description - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level - totalAdjustment
-
Type:
numberAdjustment done by the promotion
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringPromotion Description - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level
Nested Schema : items
Type:
object- couponInfo
-
Type:
arraycouponInfoThe coupon Info. - promotionValue
-
Type:
stringThe value for promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- id
-
Type:
stringThe ID of the dynamic property. - value
-
Type:
stringThe value of the dynamic property.
Nested Schema : items
Type:
object- giftWithPurchaseDetail
-
Type:
stringString identifying the free gift, usually the repository id of the gift type. - giftWithPurchaseIdentifier
-
Type:
integerAn 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:
numbergift quantity available for selection - giftWithPurchaseType
-
Type:
stringThe type of the gift. (sku, product) - promotionId
-
Type:
stringThe gift with purchase promotion id
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
booleanFlag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
integerGift 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:
numberThe amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site. - giftDetail
-
Type:
stringString identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
stringThe type of the gift. (sku, product) - key
-
Type:
stringatg.gwp - quantity
-
Type:
numberThe total quantity of sku for this gift selection. - removedQuantity
-
Type:
numberThe amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integerThe quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
stringThe gift with purchase promotion id
Nested Schema : items
Type:
object- comment
-
Type:
stringThe comment string. - creationDate
-
Type:
stringDate on which the comment was created. - repositoryId
-
Type:
stringThe repository id of the comment record.
Nested Schema : billingAddress
Type:
objectBilling address for the order.
- address1
-
Type:
stringAddress line 1 for this billing address. - address2
-
Type:
stringAddress line 2 for this billing address. - address3
-
Type:
stringAddress line 3 for this billing address. - city
-
Type:
stringCity for this billing address. - companyName
-
Type:
stringCompany name for this billing address. - country
-
Type:
stringCountry for this billing address. - county
-
Type:
stringCounty for this billing address. -
Type:
stringEmail for this billing address. - faxNumber
-
Type:
stringFax number for this billing address. - firstName
-
Type:
stringFirst name for this billing address. - jobTitle
-
Type:
stringJob title for this billing address. - lastName
-
Type:
stringLast name for this billing address. - middleName
-
Type:
stringMiddle name for this billing address. - phoneNumber
-
Type:
stringPhone number for this billing address. - postalCode
-
Type:
stringPostal code for this billing address. - prefix
-
Type:
stringPrefix for this billing address. - state
-
Type:
stringState for this billing address. - suffix
-
Type:
stringSuffix for this billing address.
Nested Schema : items
Type:
object- amount
-
Type:
numberThe amount associated with this Payment Group. - amountAuthorized
-
Type:
numberThe amount authorized with this Payment Group. - balance
-
Type:
stringThe gift card balance available. - billingAddress
-
Type:
objectbillingAddressBilling address for the order. - cardNumber
-
Type:
stringThe masked credit card number. - cardType
-
Type:
stringPayment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
stringFirst name associated with this Payment Group. - lastName
-
Type:
stringLast name associated with this Payment Group. - paidAmount
-
Type:
numberThe amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integerId of this payment Group. - paymentState
-
Type:
stringThe Payment Group state. - paymentStateDetailsAsUser
-
Type:
stringThe payment state description as string. - paymentStateString
-
Type:
stringThe payment state as a key String. - PONumber
-
Type:
stringPurchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
numberThe amount that has been credited to-date for this Payment Group. - token
-
Type:
stringToken associated with this Payment Group. - totalDue
-
Type:
numberThe current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP
Nested Schema : billingAddress
Type:
objectBilling address for the order.
- address1
-
Type:
stringAddress line 1 for this billing address. - address2
-
Type:
stringAddress line 2 for this billing address. - address3
-
Type:
stringAddress line 3 for this billing address. - city
-
Type:
stringCity for this billing address. - companyName
-
Type:
stringCompany name for this billing address. - country
-
Type:
stringCountry for this billing address. - county
-
Type:
stringCounty for this billing address. -
Type:
stringEmail for this billing address. - faxNumber
-
Type:
stringFax number for this billing address. - firstName
-
Type:
stringFirst name for this billing address. - jobTitle
-
Type:
stringJob title for this billing address. - lastName
-
Type:
stringLast name for this billing address. - middleName
-
Type:
stringMiddle name for this billing address. - phoneNumber
-
Type:
stringPhone number for this billing address. - postalCode
-
Type:
stringPostal code for this billing address. - prefix
-
Type:
stringPrefix for this billing address. - state
-
Type:
stringState for this billing address. - suffix
-
Type:
stringSuffix for this billing address.
Nested Schema : currency
Type:
objectCurrency of the PriceList group.
- currencyCode
-
Type:
stringCurrency Code. - displayName
-
Type:
stringDisplay Name. - fractionalDigits
-
Type:
integerFractional Digits. - numericCode
-
Type:
stringNumeric Code. - repositoryId
-
Type:
stringRepository Id. - symbol
-
Type:
stringcurrency Symbol.
Nested Schema : organization
Type:
objectThe Organization associated with the B2B customer profile.
- id
-
Type:
stringThe id of the organization. - name
-
Type:
stringThe name of of the organization.
Nested Schema : items
Type:
object- createdDate
-
Type:
stringThe creation date of the return request. - returnRequestId
-
Type:
stringThe return request id. - state
-
Type:
stringThe status of the return request. - totalRefund
-
Type:
numberThe total amount to be refunded on return. - totalReturnQuantity
-
Type:
integerThe total quantity for which return request has been raised.
Nested Schema : items
Type:
object- shippingAddress
-
Type:
objectshippingAddressshipping address for the order. - shippingMethod
-
Type:
objectshippingMethodShipping method information. - trackingInfo
-
Type:
arraytrackingInfoTracking Information for the Order. - trackingNumber
-
Type:
stringShipping tracking number.
Nested Schema : shippingAddress
Type:
objectshipping address for the order.
- address1
-
Type:
stringAddress Line 1 for this shipping address. - address2
-
Type:
stringAddress Line 2 for this shipping address. - address3
-
Type:
stringAddress Line 3 for this shipping address. - city
-
Type:
stringCity for this shipping address. - companyName
-
Type:
stringCompany name for this shipping address. - country
-
Type:
stringCountry for this shipping address. - county
-
Type:
stringCounty for this shipping address. -
Type:
stringEmail for this shipping address. - faxNumber
-
Type:
stringFax number for this shipping address. - firstName
-
Type:
stringFirst name for this shipping address. - jobTitle
-
Type:
stringJob title for this shipping address. - lastName
-
Type:
stringLast name for this shipping address. - middleName
-
Type:
stringMiddle name for this shipping address. - phoneNumber
-
Type:
stringPhone number for this shipping address. - postalCode
-
Type:
stringPostal code for this shipping address. - prefix
-
Type:
stringPrefix for this shipping address. - state
-
Type:
stringState for this shipping address. - suffix
-
Type:
stringSuffix for this shipping address.
Nested Schema : shippingMethod
Type:
objectShipping method information.
- cost
-
Type:
numbershipping cost. - displayName
-
Type:
stringDisplay Name of shipment. - value
-
Type:
stringmethod type of shipment.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object- carrierId
-
Type:
stringCarrier Id for Tracking. - carrierName
-
Type:
stringCarrier Name for Tracking. - carrierUrl
-
Type:
stringCarrier URL for Tracking. - trackingNumber
-
Type:
stringTracking Number
Nested Schema : items
Type:
object- catRefId
-
Type:
stringCatalog Reference Id of commerce item. - childItems
-
Type:
arraychildItemsChild items of the commerce item - commerceItemId
-
Type:
stringUnique id of the line item - configuratorId
-
Type:
stringConfiguration id of the configurable product - discountAmount
-
Type:
numberTotal discount applied to commerce item. - discountInfo
-
Type:
objectdiscountInfoDiscount information. - displayName
-
Type:
stringDisplay name of commerce item. - externalPrice
-
Type:
numberThe Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integerQuantity of the product, the customer is allowed to buy at the external price. - giftWithPurchaseCommerceItemMarkers
-
Type:
arraygiftWithPurchaseCommerceItemMarkersThe array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
objectimageInfoShipping method information. - isPriceOverridden
-
Type:
booleanIndicates if commerce item price is overridden or not. - onSale
-
Type:
booleanindicates if product is on sale or not - overriddenPrice
-
Type:
numberoverridden price of commerce item. - price
-
Type:
numberThe raw number that represents the price. - priceOverridenBy
-
Type:
stringName of the agent who has overridden item price. - priceOverrideReason
-
Type:
objectpriceOverrideReasonPrice override reason map. - productId
-
Type:
stringProduct Id of commerce item. - quantity
-
Type:
numberQuantity of the items. - rawTotalPrice
-
Type:
numberThe raw total price. - returnedQuantity
-
Type:
numberQuantity for which return request has been raised. - stateDescription
-
Type:
stringItem state as a key string. - stateDetailsAsUser
-
Type:
stringState description of the commerce item. - status
-
Type:
integerState of the commerce item. - subTotal
-
Type:
numberThe base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
numberThe amount of tax paid for this item. - unitPrice
-
Type:
numberSale price or list price of commerceItem. - variant
-
Type:
arrayvariantProduct Variant Information.
Nested Schema : discountInfo
Type:
objectDiscount information.
- orderCouponsMap
-
Type:
arrayorderCouponsMapMap of coupons. - orderDiscount
-
Type:
numberDiscount given on an order. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integerThe shipping discount. - unclaimedCouponsMap
-
Type:
arrayunclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : imageInfo
Type:
objectShipping method information.
- primaryThumbImageURL
-
Type:
stringThumbNail Image URL
Nested Schema : priceOverrideReason
Type:
objectPrice override reason map.
- displayValue
-
Type:
stringprice override reason value. - key
-
Type:
stringprice override reason key.
Nested Schema : items
Type:
object- catRefId
-
Type:
stringSku Id of the child item - displayName
-
Type:
stringDisplay name of the child product - productId
-
Type:
stringProduct Id of the child item - quantity
-
Type:
numberQuantity of the child item - route
-
Type:
stringProduct path - selectedOptions
-
Type:
arrayselectedOptionsChild Product Variant Information.
Nested Schema : selectedOptions
Nested Schema : items
Type:
object- optionName
-
Type:
stringName of the Dynamic attribute. - optionValue
-
Type:
stringValue of the Dynamic attribute.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- couponInfo
-
Type:
arraycouponInfoThe coupon Info. - promotionValue
-
Type:
stringThe value for promotion.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringDescription of the promotion. - promotionId
-
Type:
stringId of the promotion. - promotionLevel
-
Type:
stringLevel of the promotion. - totalAdjustment
-
Type:
stringTotal adjustment caused by the promotion.
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integerThe gift hash code for this GWP promotion. - key
-
Type:
stringatg.gwp - remainingQuantity
-
Type:
numberThe quantity of the commerce item that is not affected by GWP. - selectedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
stringThe gift with purchase promotion id.
Nested Schema : items
Type:
object- optionName
-
Type:
stringName of the Dynamic attribute. - optionValue
-
Type:
stringValue 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:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAn optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe 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"
}