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:
stringThe create date of the Scheduled order. - endDate
-
Type:
stringThe end date of the Scheduled order. - id
-
Type:
stringThe id of the Scheduled order. - name
-
Type:
stringThe name of the Scheduled order. - nextScheduledRun
-
Type:
stringThe next scheduled run of the Scheduled order. - profileId
-
Type:
stringThe profile id of the user of Scheduled order. - schedule
-
Type:
objectscheduleAdditional Properties Allowed:The schedule of the Scheduled order. - scheduleType
-
Type:
stringThe schedule type of the Scheduled order. - startDate
-
Type:
stringThe start date of the Scheduled order. - state
-
Type:
stringThe status of the Scheduled order. - templateOrder
-
Type:
objecttemplateOrderAdditional Properties Allowed:The Order of the Scheduled order. - templateOrderId
-
Type:
stringThe template order id of the Scheduled order.
Nested Schema : schedule
Type:
objectThe schedule of the Scheduled order.
- daysOfWeek
-
Type:
arraydaysOfWeekAdditional Properties Allowed:The days of week of the Scheduled order. - interval
-
Type:
integerThe interval in term of number of days of the Scheduled order. - monthsInYear
-
Type:
arraymonthsInYearAdditional Properties Allowed:The months in year of the Scheduled order. - occurenceInDay
-
Type:
integerThe occurence in day on the Scheduled order. - selectedDates
-
Type:
arrayselectedDatesAdditional Properties Allowed:The selected dates in a month in year for the Scheduled order. - weeksInMonth
-
Type:
arrayweeksInMonthAdditional Properties Allowed:The weeks in month of the Scheduled order.
Nested Schema : templateOrder
Type:
objectThe Order of the Scheduled order.
- billingAddress
-
Type:
objectbillingAddressAdditional Properties Allowed:The billing address details. - creationDate
-
Type:
stringThe creation date in ISO format. - creationTime
-
Type:
numberThe creation time in long seconds. - discountInfo
-
Type:
objectdiscountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
arraydynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
arraygiftWithPurchaseInfoAdditional Properties Allowed:The gift information. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersAdditional Properties Allowed:gift with purchase order marker information - id
-
Type:
stringThe order ID. - lastModifiedDate
-
Type:
stringThe order recent modified date in ISO format. - orderLocale
-
Type:
stringThe locale in which order submitted. - orderProfileId
-
Type:
stringThe profile-id of the order. - orderStatus
-
Type:
stringStatus of the order. - paymentGroupId
-
Type:
stringThe payment group ID used for the order. - payments
-
Type:
arraypaymentsAdditional Properties Allowed:Payment details for the order, including additional properties specific to the payment type. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:The price information. - priceListGroup
-
Type:
objectpriceListGroupAdditional Properties Allowed:The price list group object. - quoteInfo
-
Type:
objectquoteInfoAdditional Properties Allowed:the quote information of the order - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
arrayshippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:The shipping method details for the order. - shoppingCart/order
-
Type:
objectshoppingCart/orderAdditional Properties Allowed:The shopping-cart or order contents of the current order. - submittedDate
-
Type:
stringThe order submitted date in ISO format. - trackingInfo
-
Type:
arraytrackingInfoAdditional Properties Allowed:Tracking Information for the Order. - uuid
-
Type:
stringThe unique ID for the order.
Nested Schema : daysOfWeek
Nested Schema : monthsInYear
Nested Schema : selectedDates
Nested Schema : weeksInMonth
Nested Schema : billingAddress
Type:
objectThe billing address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : discountInfo
Type:
objectThe discount information.
- claimedCouponMultiPromotions
-
Type:
objectclaimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were claimed - orderCouponsMap
-
Type:
arrayorderCouponsMapAdditional Properties Allowed:The list of all the coupons with the order. - orderDiscount
-
Type:
integerThe order discount. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListAdditional Properties Allowed:The implicit order discounts with the order. - shippingDiscount
-
Type:
integerThe shipping discount. - unclaimedCouponMultiPromotions
-
Type:
objectunclaimedCouponMultiPromotionsAdditional Properties Allowed:The coupons that were not claimed - unclaimedCouponsMap
-
Type:
objectunclaimedCouponsMapAdditional Properties Allowed:The unclaimed coupons with the order.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Nested Schema : priceInfo
Type:
objectThe price information.
- amount
-
Type:
numberThe total order amount. - currencyCode
-
Type:
stringThe currency code. - shipping
-
Type:
numberThe total shipping cost. - shippingSurchargeValue
-
Type:
numberExtra handling costs for shipping the products. - subTotal
-
Type:
numberSub-total. - tax
-
Type:
numberThe total tax amount. - total
-
Type:
numberThe order total.
Nested Schema : priceListGroup
Type:
objectThe price list group object.
- repositoryId
-
Type:
stringRepository ID of the price list group.
Nested Schema : quoteInfo
Type:
objectthe quote information of the order
- errorInfo
-
Type:
arrayerrorInfoAdditional Properties Allowed:the array of errors, if any - expirationDate
-
Type:
stringthe expiration date of the quoted order, if any - externalId
-
Type:
stringthe external id for the quote - notes
-
Type:
arraynotesAdditional Properties Allowed:the notes (history) for the order - providerNote
-
Type:
stringthe provider note for the quoted order - quoteDate
-
Type:
numberthe date the order was quoted in milliseconds - rejectionDate
-
Type:
stringrejection date of the quoted order - rejectionNote
-
Type:
stringthe rejection note for an order whose quote has been rejected by user - requestDate
-
Type:
stringthe date when the quote was requested in ISO format
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
- cost
-
Type:
numberThe total cost of shipping. - value
-
Type:
stringThe shipping method applied to the order.
Nested Schema : shoppingCart/order
Type:
objectThe shopping-cart or order contents of the current order.
- items
-
Type:
arrayitemsAdditional Properties Allowed:The array of products in the shopping cart.
Nested Schema : trackingInfo
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed
- coupon code
-
Type:
arraycoupon codeAdditional Properties Allowed:Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
- coupon code
-
Type:
arraycoupon codeAdditional Properties Allowed:Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe unclaimed coupons with the order.
- coupon code
-
Type:
arraycoupon codeAdditional Properties Allowed:Coupon 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:
stringThe promotion description. - promotionId
-
Type:
stringThe promotion ID. - promotionLevel
-
Type:
stringThe promotion level. - totalAdjustment
-
Type:
stringThe total adjustment.
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringThe promotion description. - promotionId
-
Type:
stringThe promotion ID. - promotionLevel
-
Type:
stringThe promotion level. - totalAdjustment
-
Type:
stringThe total adjustment.
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringPromotion Description - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level
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- 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- amount
-
Type:
numberAmount authorized from the payment group. - balance
-
Type:
numberTotal available balance on the gift card. - gatewayName
-
Type:
stringPayment gateway name. e.g. chaseCreditCard. - giftCardNumber
-
Type:
stringGift card number. - isAmountRemaining
-
Type:
booleanA boolean to decide if more payment can be made from this payment group. - maskedCardNumber
-
Type:
stringMasked gift card number. - paymentGroupId
-
Type:
stringPayment group id. - paymentMethod
-
Type:
stringPayment method. e.g. physicalGiftCard/ creditCard. - paymentState
-
Type:
stringThe state of the payment group. e.g. AUTHORIZED. - PONumber
-
Type:
stringPurchase order number for invoice payment. Payment type:invoice - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : errorInfo
Nested Schema : notes
Nested Schema : items
Type:
object- profileId
-
Type:
stringthe profile id of the user - profileType
-
Type:
stringthe profile type of the user that requested the quote - requestDate/quoteDate/rejectionDate
-
Type:
numberthe request/quote/rejection date for the note - requesterNote/providerNote/rejectionNote
-
Type:
stringthe requester/provider/rejection note
Nested Schema : items
Type:
object- actualShipDate
-
Type:
stringThe actual ship date in ISO format. - discountInfo
-
Type:
objectdiscountInfoAdditional Properties Allowed:The shipping group price information. - items
-
Type:
arrayitemsAdditional Properties Allowed:The array of products in the shipping group. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:The shipping group price information. - shipOnDate
-
Type:
stringThe ship on date in ISO format. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroupId
-
Type:
stringThe shipping group ID. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:The shipping method details. - status
-
Type:
stringThe shipping group status. - submittedDate
-
Type:
stringThe submitted date in ISO format. - taxPriceInfo
-
Type:
objecttaxPriceInfoAdditional Properties Allowed:The shipping tax price info details. - trackingNumber
-
Type:
stringThe tracking number.
Nested Schema : discountInfo
Type:
objectThe shipping group price information.
- discountDescList
-
Type:
arraydiscountDescListAdditional Properties Allowed:The list of all the order discounts. - orderDiscount
-
Type:
numberThe orderDiscount. - shippingDiscount
-
Type:
numberThe shipping discount.
Nested Schema : items
Nested Schema : priceInfo
Type:
objectThe shipping group price information.
- amount
-
Type:
numberThe shipping method amount. - currencyCode
-
Type:
stringThe shipping method amount. - shipping
-
Type:
numberThe shipping amount. - shippingSurchargeValue
-
Type:
numberThe shipping surcharge value amount. - subTotal
-
Type:
numberThe shipping group subtotal. - tax
-
Type:
numberThe shipping method tax amount. - total
-
Type:
numberThe total cost of shipping. - totalWithoutTax
-
Type:
numberThe shipping items total.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details.
- cost
-
Type:
numberThe total cost of shipping. - shippingMethodDescription
-
Type:
stringThe description of the shipping method. - shippingTax
-
Type:
numberThe shipping tax. - value
-
Type:
stringThe shipping method applied to the order.
Nested Schema : taxPriceInfo
Type:
objectThe shipping tax price info details.
- amount
-
Type:
numberThe shipping method amount. - cityTax
-
Type:
numberThe shipping group subtotal. - countryTax
-
Type:
numberThe country tax total. - countyTax
-
Type:
numberThe county tax amount. - districtTax
-
Type:
stringThe shipping method applied to the order. - isTaxIncluded
-
Type:
booleanFlag that states whether is tax included. - miscTax
-
Type:
stringThe miscellaneous tax amount. - stateTax
-
Type:
numberThe shipping method tax amount. - valueAddedTax
-
Type:
numberThe value added tax .
Nested Schema : discountDescList
Nested Schema : items
Type:
object- coupon
-
Type:
stringThe coupon code. - promotionDesc
-
Type:
stringThe promotion description. - promotionId
-
Type:
stringThe promotion id. - promotionLevel
-
Type:
stringThe promotion level.
Nested Schema : items
Type:
object- active
-
Type:
booleanUIs this product active. - catRefId
-
Type:
stringThe category to which the product belongs. - detailedItemPriceInfo
-
Type:
objectdetailedItemPriceInfoAdditional Properties Allowed:Detailed Item Price Information. - discountAmount
-
Type:
stringThe discount amount. - displayName
-
Type:
stringDisplay Name. - listPrice
-
Type:
stringList Price. - onSale
-
Type:
booleanIndicates whether the price is for an item that is on sale. - primaryImageAltText
-
Type:
stringPrimary Image Alternative Text. - primaryImageTitle
-
Type:
stringPrimary Image Title. - primaryThumbImageURL
-
Type:
stringPrimary Thumb Image URL. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product in this shipping group. - rawTotalPrice
-
Type:
stringRaw Total Price. - route
-
Type:
stringroute. - salePrice
-
Type:
stringSale Price. - shippingSurchargeValue
-
Type:
numbershipping surcharge value. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
numberThe unit price. - variant
-
Type:
arrayvariantAdditional Properties Allowed:List of variants for the product.
Nested Schema : detailedItemPriceInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe amount. - currencyCode
-
Type:
stringThe currency code. - detailedUnitPrice
-
Type:
numberDetailed Unit Price. - discounted
-
Type:
booleanIs this item discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
numberThe quantity. - tax
-
Type:
numberThe tax amount.
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe variant option name. - optionValue
-
Type:
stringThe variant option value.
Nested Schema : items
Nested Schema : items
Type:
object- active
-
Type:
booleanactive or not. - catRefId
-
Type:
stringThe category to which the product belongs. - discountInfo
-
Type:
arraydiscountInfoAdditional Properties Allowed:The discount information. - displayName
-
Type:
stringThe name of the product. - externalPrice
-
Type:
numberA price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable). - externalPriceQuantity
-
Type:
integerThe maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). - giftWithPurchaseCommerceItemMarkers
-
Type:
arraygiftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:The array of giftWithPurchaseCommerceItemMarkers. - price
-
Type:
integerThe actual price of the product. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product. - rawTotalPrice
-
Type:
integerThe raw price of the product. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
integerThe unit price of the product. - variant
-
Type:
arrayvariantAdditional Properties Allowed:List of variants for the product.
Nested Schema : discountInfo
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- coupon
-
Type:
stringThe coupon ID. - giftWithPurchaseDiscountInfo
-
Type:
arraygiftWithPurchaseDiscountInfoAdditional Properties Allowed:The gift information. - promotionDesc
-
Type:
stringThe promotion description. - promotionId
-
Type:
stringThe promotion ID. - promotionLevel
-
Type:
stringThe promotion level. - totalAdjustment
-
Type:
numberTotal adjustment by the promotion.
Nested Schema : giftWithPurchaseDiscountInfo
Nested Schema : items
Type:
object- giftWithPurchaseChoicesAvailable
-
Type:
booleanIf this gift with purchase has multiple gift choices. - giftWithPurchaseIdentifier
-
Type:
integerThe gift hash code for this gift with purchase promotion. - giftWithPurchaseQuantity
-
Type:
numberThe quantity that is gift quantity
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 gift with purchase promotion. - key
-
Type:
stringatg.gwp - remainingQuantity
-
Type:
numberThe quantity of the commerce item that is not affected by gift with purchase. - 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- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe variant option name. - optionValue
-
Type:
stringThe variant option value.
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.
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:
arrayerrorsAdditional Properties Allowed:An 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"
}