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: string
ID of the scheduled order to be retrieved.
Query Parameters
-
orderDetails(optional): boolean
The flag indicating whether to fetch the template order details.
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the order belongs
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getScheduledOrder_response
Type:
Show Source
object
-
createDate(optional):
string
The create date of the Scheduled order.
-
endDate(optional):
string
The end date of the Scheduled order.
-
id(optional):
string
The id of the Scheduled order.
-
name(optional):
string
The name of the Scheduled order.
-
nextScheduledRun(optional):
string
The next scheduled run of the Scheduled order.
-
profileId(optional):
string
The profile id of the user of Scheduled order.
-
schedule(optional):
object schedule
The schedule of the Scheduled order.
-
scheduleType(optional):
string
The schedule type of the Scheduled order.
-
startDate(optional):
string
The start date of the Scheduled order.
-
state(optional):
string
The status of the Scheduled order.
-
templateOrder(optional):
object templateOrder
The Order of the Scheduled order.
-
templateOrderId(optional):
string
The template order id of the Scheduled order.
Nested Schema : schedule
Type:
object
The schedule of the Scheduled order.
Show Source
-
daysOfWeek(optional):
array daysOfWeek
The days of week of the Scheduled order.
-
delay(optional):
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
interval(optional):
integer
The interval in term of number of days of the Scheduled order.
-
monthsInYear(optional):
array monthsInYear
The months in year of the Scheduled order.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order.
-
period(optional):
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
selectedDates(optional):
array selectedDates
The selected dates in a month in year for the Scheduled order.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.
Nested Schema : templateOrder
Type:
object
The Order of the Scheduled order.
Show Source
-
billingAddress(optional):
object billingAddress
The billing address details.
-
creationDate(optional):
string
The creation date in ISO format.
-
creationTime(optional):
number
The creation time in long seconds.
-
discountInfo(optional):
object discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
gift with purchase order marker information
-
id(optional):
string
The order ID.
-
lastModifiedDate(optional):
string
The order recent modified date in ISO format.
-
orderLocale(optional):
string
The locale in which order submitted.
-
orderProfileId(optional):
string
The profile-id of the order.
-
orderStatus(optional):
string
Status of the order.
-
paymentGroupId(optional):
string
The payment group ID used for the order.
-
payments(optional):
array payments
Payment details for the order, including additional properties specific to the payment type.
-
priceInfo(optional):
object priceInfo
The price information.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
shoppingCart/order(optional):
object shoppingCart/order
The shopping-cart or order contents of the current order.
-
submittedDate(optional):
string
The order submitted date in ISO format.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order.
-
uuid(optional):
string
The unique ID for the order.
Nested Schema : selectedDates
Type:
array
The selected dates in a month in year for the Scheduled order.
Show Source
Nested Schema : billingAddress
Type:
object
The billing address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : discountInfo
Type:
object
The discount information.
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
The order discount.
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
The implicit order discounts with the order.
-
shippingDiscount(optional):
number
The shipping discount.
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
The unclaimed coupons with the order.
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
array
gift with purchase order marker information
Show Source
Nested Schema : payments
Type:
array
Payment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type:
object
The price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub-total.
-
tax(optional):
number
The total tax amount.
-
total(optional):
number
The order total.
Nested Schema : priceListGroup
Type:
object
The price list group object.
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group.
Nested Schema : quoteInfo
Type:
object
the quote information of the order
Show Source
-
errorInfo(optional):
array errorInfo
the array of errors, if any
-
expirationDate(optional):
string
the expiration date of the quoted order, if any
-
externalId(optional):
string
the external id for the quote
-
notes(optional):
array notes
the notes (history) for the order
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
string
rejection date of the quoted order
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
string
the date when the quote was requested in ISO format
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : shoppingCart/order
Type:
object
The shopping-cart or order contents of the current order.
Show Source
-
items(optional):
array items
The array of products in the shopping cart.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : orderImplicitDiscountList
Type:
array
The implicit order discounts with the order.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
object
The unclaimed coupons with the order.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
The promotion description.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
string
The total adjustment.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc(optional):
string
Promotion description.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftWithPurchaseIdentifier(optional):
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(optional):
number
gift quantity available for selection
-
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)
-
promotionId(optional):
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
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(optional):
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(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
atg.gwp
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
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(optional):
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Amount authorized from the payment group.
-
balance(optional):
number
Total available balance on the gift card.
-
gatewayName(optional):
string
Payment gateway name. e.g. chaseCreditCard.
-
giftCardNumber(optional):
string
Gift card number.
-
isAmountRemaining(optional):
boolean
A boolean to decide if more payment can be made from this payment group.
-
maskedCardNumber(optional):
string
Masked gift card number.
-
paymentGroupId(optional):
string
Payment group id.
-
paymentMethod(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard.
-
paymentState(optional):
string
The state of the payment group. e.g. AUTHORIZED.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
savedCardId(optional):
string
Id of the saved card associated with the payment group.
-
uiIntervention(optional):
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : items
Type:
Show Source
object
-
profileId(optional):
string
the profile id of the user
-
profileType(optional):
string
the profile type of the user that requested the quote
-
requestDate/quoteDate/rejectionDate(optional):
number
the request/quote/rejection date for the note
-
requesterNote/providerNote/rejectionNote(optional):
string
the requester/provider/rejection note
Nested Schema : items
Type:
Show Source
object
-
actualShipDate(optional):
string
The actual ship date in ISO format.
-
discountInfo(optional):
object discountInfo
The shipping group price information.
-
items(optional):
array items
The array of products in the shipping group.
-
priceInfo(optional):
object priceInfo
The shipping group price information.
-
shipOnDate(optional):
string
The ship on date in ISO format.
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingGroupId(optional):
string
The shipping group ID.
-
shippingMethod(optional):
object shippingMethod
The shipping method details.
-
status(optional):
string
The shipping group status.
-
submittedDate(optional):
string
The submitted date in ISO format.
-
taxPriceInfo(optional):
object taxPriceInfo
The shipping tax price info details.
-
trackingNumber(optional):
string
The tracking number.
Nested Schema : discountInfo
Type:
object
The shipping group price information.
Show Source
-
discountDescList(optional):
array discountDescList
The list of all the order discounts.
-
orderDiscount(optional):
number
The orderDiscount.
-
shippingDiscount(optional):
number
The shipping discount.
Nested Schema : priceInfo
Type:
object
The shipping group price information.
Show Source
-
amount(optional):
number
The shipping method amount.
-
currencyCode(optional):
string
The shipping method amount.
-
shipping(optional):
number
The shipping amount.
-
shippingSurchargeValue(optional):
number
The shipping surcharge value amount.
-
subTotal(optional):
number
The shipping group subtotal.
-
tax(optional):
number
The shipping method tax amount.
-
total(optional):
number
The total cost of shipping.
-
totalWithoutTax(optional):
number
The shipping items total.
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
shippingMethodDescription(optional):
string
The description of the shipping method.
-
shippingTax(optional):
number
The shipping tax.
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : taxPriceInfo
Type:
object
The shipping tax price info details.
Show Source
-
amount(optional):
number
The shipping method amount.
-
cityTax(optional):
number
The shipping group subtotal.
-
countryTax(optional):
number
The country tax total.
-
countyTax(optional):
number
The county tax amount.
-
districtTax(optional):
string
The shipping method applied to the order.
-
isTaxIncluded(optional):
boolean
Flag that states whether is tax included.
-
miscTax(optional):
string
The miscellaneous tax amount.
-
stateTax(optional):
number
The shipping method tax amount.
-
valueAddedTax(optional):
number
The value added tax .
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon code.
-
promotionDesc(optional):
string
The promotion description.
-
promotionId(optional):
string
The promotion id.
-
promotionLevel(optional):
string
The promotion level.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
UIs this product active.
-
catRefId(optional):
string
The category to which the product belongs.
-
detailedItemPriceInfo(optional):
object detailedItemPriceInfo
Detailed Item Price Information.
-
discountAmount(optional):
string
The discount amount.
-
displayName(optional):
string
Display Name.
-
listPrice(optional):
string
List Price.
-
onSale(optional):
boolean
Indicates whether the price is for an item that is on sale.
-
primaryImageAltText(optional):
string
Primary Image Alternative Text.
-
primaryImageTitle(optional):
string
Primary Image Title.
-
primaryThumbImageURL(optional):
string
Primary Thumb Image URL.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in this shipping group.
-
rawTotalPrice(optional):
string
Raw Total Price.
-
route(optional):
string
route.
-
salePrice(optional):
string
Sale Price.
-
shippingSurchargeValue(optional):
number
shipping surcharge value.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
unitPrice(optional):
number
The unit price.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : detailedItemPriceInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The amount.
-
currencyCode(optional):
string
The currency code.
-
detailedUnitPrice(optional):
number
Detailed Unit Price.
-
discounted(optional):
boolean
Is this item discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
number
The quantity.
-
tax(optional):
number
The tax amount.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
active or not.
-
catRefId(optional):
string
The category to which the product belongs.
-
discountInfo(optional):
array discountInfo
The discount information.
-
displayName(optional):
string
The name of the product.
-
externalPrice(optional):
number
A 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(optional):
integer
The 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(optional):
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
price(optional):
integer
The actual price of the product.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
unitPrice(optional):
integer
The unit price of the product.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.
-
giftWithPurchaseDiscountInfo(optional):
array giftWithPurchaseDiscountInfo
The gift information.
-
promotionDesc(optional):
string
The promotion description.
-
promotionId(optional):
string
The promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
totalAdjustment(optional):
number
Total adjustment by the promotion.
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseChoicesAvailable(optional):
boolean
If this gift with purchase has multiple gift choices.
-
giftWithPurchaseIdentifier(optional):
integer
The gift hash code for this gift with purchase promotion.
-
giftWithPurchaseQuantity(optional):
number
The quantity that is gift quantity
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data(optional):
integer
The gift hash code for this gift with purchase promotion.
-
key(optional):
string
atg.gwp
-
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value(optional):
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
carrierId(optional):
string
Carrier Id for Tracking.
-
carrierName(optional):
string
Carrier Name for Tracking.
-
carrierUrl(optional):
string
Carrier URL for Tracking.
-
trackingNumber(optional):
string
Tracking Number.
Example Response (application/json)
{
"lastError":null,
"endDate":"2016-12-08T00:00:00.000Z",
"executionStatusList":[
{
"errorMessages":[
"Exception While cloning an order."
],
"scheduledOrderId":"sco1001",
"orderId":null,
"repositoryId":"600005",
"executionDate":"2016-11-23T00:00:00.000Z",
"currency":"USD",
"id":"600005",
"orderSubmitted":false,
"orderTotal":null
}
],
"type":"scheduledOrder",
"version":25,
"lastScheduledRun":"2016-11-23T00:00:00.000Z",
"schedule":{
"daysInMonth":[
],
"weeksInMonth":[
],
"monthsInYear":[
1,
3,
5,
7,
9,
11
],
"daysOfWeek":[
],
"occurrenceInDay":1
},
"templateOrderId":"o30414",
"clonedOrders":[
],
"profileId":"120939",
"templateOrder":{
"totalAmountAuthorized":0,
"creationTime":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@example.com"
},
"paymentState":0,
"type":"invoice",
"paidAmount":0,
"refundAmount":0
}
],
"priceInfo":{
"amount":21.99,
"total":51.7,
"shipping":25,
"shippingSurchargeValue":0,
"tax":4.71,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"pricingMessages":{
},
"paymentGroup":{
"PONumber":"",
"paymentGroupId":"pg30412",
"paymentStateString":"INITIAL",
"amountAuthorized":0,
"amount":51.7,
"totalDue":51.7,
"billingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"paymentState":0,
"type":"invoice",
"paidAmount":0,
"refundAmount":0
},
"shoppingCart":{
"items":[
{
"unitPrice":21.99,
"quantity":1,
"productId":"Product_36Exy",
"rawTotalPrice":21.99,
"returnedQuantity":0,
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":21.99,
"quantity":1,
"tax":2.2,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"displayName":"The Girl with the Dragon Tattoo",
"shippingSurchargeValue":0,
"giftWithPurchaseCommerceItemMarkers":[
],
"discountAmount":0,
"imageInfo":{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100"
},
"tax":2.2,
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"price":21.99,
"variant":[
],
"onSale":false,
"stateDescription":"INITIAL",
"listPrice":21.99,
"stateDetailsAsUser":"Added to order",
"status":0
}
]
},
"id":"o30414",
"state":4001,
"stateDetailsAsUser":"Scheduled order template",
"taxPriceInfo":{
"cityTax":1.65,
"amount":4.71,
"valueAddedTax":0,
"countyTax":1.1800000000000002,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.88,
"countryTax":0
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":1.65,
"amount":4.71,
"valueAddedTax":0,
"countyTax":1.1800000000000002,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.88,
"countryTax":0
},
"shippingMethod":{
"shippingTax":2.51,
"cost":25,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"shippingGroupId":"sg40414",
"submittedDate":null,
"priceInfo":{
"amount":21.99,
"total":51.7,
"shipping":25,
"shippingSurchargeValue":0,
"tax":4.71,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":"Address",
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"items":[
{
"unitPrice":21.99,
"primaryImageTitle":"The Girl with the Dragon Tattoo",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100",
"quantity":1,
"productId":"Product_36Exy",
"rawTotalPrice":21.99,
"returnedQuantity":0,
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":21.99,
"quantity":1,
"tax":2.2,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"displayName":"The Girl with the Dragon Tattoo",
"shippingSurchargeValue":0,
"discountAmount":0,
"active":true,
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"route":"/product/Product_36Exy",
"price":21.99,
"variant":[
],
"onSale":false,
"primaryImageAltText":"The Girl with the Dragon Tattoo",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"listPrice":21.99,
"status":"INITIAL"
}
],
"trackingNumber":null,
"status":"INITIAL"
}
],
"shippingMethod":{
"shippingTax":2.51,
"cost":25,
"displayName":"Standard",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"profile":{
"firstName":"Shiv",
"lastName":"Shankar",
"middleName":null,
"email":"s@example.com"
},
"priceListGroup":{
"deleted":false,
"displayName":"Default Price Group",
"repositoryId":"defaultPriceGroup",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
}
},
"returnRequests":[
],
"creationDate":"2016-11-21T11:14:50.000Z",
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"orderCancelReason":null,
"profileId":"120939",
"exchangeRequests":[
],
"giftWithPurchaseInfo":[
],
"shippingAddress":{
"lastName":"Shankar",
"country":"US",
"address3":"",
"address2":"E",
"city":"Tempe",
"prefix":"",
"address1":"S",
"postalCode":"36123",
"companyName":"",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Shiva",
"phoneNumber":"909090090",
"stateName":"Alabama",
"faxNumber":"",
"alias":"Address",
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"s@example.com"
},
"giftWithPurchaseOrderMarkers":[
]
},
"repositoryId":"sco10002",
"name":"Monthly Order",
"siteId":"siteUS",
"nextScheduledRun":"1969-12-31T23:59:59.999Z",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002"
}
],
"state":"active",
"id":"sco10002",
"startDate":"2016-12-01T00:00:00.000Z",
"createDate":"2016-11-21T11:15:15.000Z"
}
Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|100101|The shopper profile does not belong to organization passed in the header|
|100102|Organization passed in the header is invalid or does not exist|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code