Create an order
post
/ccstore/v1/orders
This endpoint is used to create an order for the current user i.e. when they navigate to an item and click "add to cart". The order, at this point, can be thought of as a shopping cart i.e. this is the container for all products the user may add, and is not a completed order - it is not in a submitted state at this point, rather, it is defined as "INCOMPLETE".
Dynamic Properties of order and order line items can be added in the the request using the key value pair structure ("dynamicPropertyKey" : "dynamicPropertyValue").
Dynamic Properties of order and order line items can be added in the the request using the key value pair structure ("dynamicPropertyKey" : "dynamicPropertyValue").
These property values can take the types of:
- boolean
- date
- float
- string
- timestamp
- enumerated
- big string
Note: The minimum required properties in the payload for this endpoint call (createOrder) to be successful are shippingGroup, shippingMethod and shoppingCart.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Root Schema : createOrder_request
Type:
Show Source
object
-
appliedPromotions(optional):
array appliedPromotions
The array of applied promotions
-
billingAddress(optional):
object billingAddress
The billing address details.
-
cartName(optional):
string
Cart name for this order.
-
combineLineItems(optional):
string
Value to determine if line items are to be combined. Can be yes or no.
-
isAnonymousCheckout(optional):
boolean
Set this to true if the order is for an anonymous user.
-
payments(optional):
array payments
Payment details for the order.
-
placeAsyncOrder(optional):
boolean
Set this to true to place the order asynchronously.
-
schedule(optional):
object schedule
Details of the schedule order to be created
-
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:
object shoppingCart
The shopping cart contents of the current order.
Example:
{
"isAnonymousCheckout":true,
"appliedPromotions":[
"explicitItemFreeDiscount"
],
"shippingMethod":{
"value":"ground"
},
"payments":[
{
"paymentGroupId":"",
"amount":100,
"customProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"giftCardNumber":"6035710988880101071",
"giftCardPin":"123",
"type":"physicalGiftCard"
},
{
"PONumber":"123456",
"type":"invoice"
},
{
"cardCVV":"123",
"customProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"nameOnCard":"test",
"cardTypeName":"Visa",
"cardType":"visa",
"endMonth":"02",
"type":"card",
"endYear":2018,
"cardNumber":"4055011111111111"
}
],
"shoppingCart":{
"coupons":[
{
"code":"FREETATTOO",
"level":"item",
"description":"Explicit Item Discount - FREETATTOO",
"id":"explicitItemFreeDiscount",
"totalAdjustment":"-21.99",
"status":"claimed"
}
],
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"childItems":[
{
"configurationOptionId":"configOptIDC1P11536825979556",
"addOnItem":true,
"quantity":5,
"priceListGroupId":"price_list_group_1536825979556",
"productId":"child1P1Prod1536825979556",
"childItems":[
],
"configurablePropertyId":"configPropIDC1P11536825979556",
"shopperInput":{
"fontSIID1536825979556":"Times New Roman",
"shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
},
"catRefId":"child1P1Sku1536825979556"
}
],
"assetKey":"12345",
"externalPrice":255.1,
"actionCode":"Add",
"serviceId":"service-123",
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"dynamicPropertyMode":"pickup",
"productId":"xprod2105",
"externalRecurringCharge":10,
"parentAssetKey":null,
"rootAssetKey":null,
"externalPriceQuantity":1,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"xsku2105",
"externalRecurringChargeDuration":"12",
"customerAccountId":"customerAcc-123",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"recurringCharge":10
}
],
"orderTotal":255.1
},
"placeAsyncOrder":false,
"shippingAddress":{
"lastName":"Test",
"country":"United States",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"prefix":"",
"address1":"Line 1",
"postalCode":"36123",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"Alabama",
"email":"steve.test@example.com",
"selectedState":"AL",
"state_ISOCode":"US-AL"
},
"billingAddress":{
"lastName":"Test",
"country":"United States",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"prefix":"",
"address1":"Line 1",
"postalCode":"36123",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"Alabama",
"selectedState":"AL",
"state_ISOCode":"US-AL"
},
"cartName":"Test Name",
"dynamicPropertyShippingInstructions":"Test Instructions"
}
Nested Schema : billingAddress
Type:
object
The billing address details.
Show Source
-
address1:
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city:
string
City.
-
companyName(optional):
string
Company name.
-
country:
string
Country.
-
county(optional):
string
County.
-
faxNumber(optional):
string
Fax number.
-
firstName:
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName:
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : schedule
Type:
object
Details of the schedule order to be created
Show Source
-
endDate(optional):
string
end date for the schedule.
-
name:
string
Name for the schedule.
-
schedule:
object schedule
schedule details for the schedule.
-
scheduleType:
string
Type of schedule. can be calendar/periodic.
-
startDate:
string
start date for the schedule.
-
state:
string
state for schedule.Can be active/inactive
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city:
string
City.
-
companyName(optional):
string
Company name.
-
country:
string
Country.
-
county(optional):
string
County.
-
email:
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName:
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName:
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
value:
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
object
The shopping cart contents of the current order.
Show Source
-
coupons(optional):
array coupons
The array of coupons applied to the order.
-
items:
array items
The array of products in the shopping cart.
-
orderTotal(optional):
number
The total price of the order.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Amount to be authorized from the gift card. Payment type:card, physicalGiftCard, paypalCheckout, payUWebLatamCheckout.
-
cardCVV(optional):
string
Credit/Debit card secret pin. Payment type:card.
-
cardNumber(optional):
string
Credit/Debit card number used for payment. Payment type:card.
-
cardType(optional):
string
Credit/Debit card type. e.g. visa. Payment type:card.
-
cardTypeName(optional):
string
Credit/Debit card type name. e.g. Visa. Payment type:card.
-
customProperties(optional):
object customProperties
Custom object with dynamic properties. This will be passed to the webhook request
-
endMonth(optional):
string
Credit/Debit card expiry month. Payment type:card.
-
endYear(optional):
string
Credit/Debit card expiry year. Payment type:card.
-
giftCardNumber(optional):
string
Gift card number used for payment. Payment type:physicalGiftCard.
-
giftCardPin(optional):
string
Gift card pin. Payment type:physicalGiftCard.
-
nameOnCard(optional):
string
Name on the credit/debit card. Payment type:card.
-
nickname(optional):
string
card nickname
-
PayerID(optional):
string
Payer ID relevant to paypal checkout type. Payment type:paypalCheckout.
-
paymentGroupId(optional):
string
Payment Group ID of the gift card payment group. Payment type:physicalGiftCard.
-
paymentId(optional):
string
Payment ID relevant to the payment type. Payment type:paypalCheckout, payUWebLatamCheckout.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
saveCard(optional):
boolean
Property that determines whether to save this card or not.
-
savedCardId(optional):
string
ID of the saved card
-
setAsDefault(optional):
boolean
Property to set this card as default card.
-
token(optional):
string
Token generated on the client-side for eg. in case of hosted or transparent payment processing.
-
type:
string
Payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard,cash
Nested Schema : customProperties
Type:
object
Custom object with dynamic properties. This will be passed to the webhook request
Nested Schema : schedule
Type:
object
schedule details for the schedule.
Show Source
-
daysOfWeek(optional):
array daysOfWeek
mention which days of week schedule should run. values can be 1 to 7.
-
monthsInYear(optional):
array monthsInYear
The months in year of the Scheduled order. Values can be 0 to 11.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order. Values can be 1 or 2.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.Values can be 1 to 5
Nested Schema : daysOfWeek
Type:
array
mention which days of week schedule should run. values can be 1 to 7.
Show Source
Nested Schema : monthsInYear
Type:
array
The months in year of the Scheduled order. Values can be 0 to 11.
Show Source
Nested Schema : weeksInMonth
Type:
array
The weeks in month of the Scheduled order.Values can be 1 to 5
Show Source
Nested Schema : items
Type:
Show Source
object
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items:
array items
The array of products in the shipping group.
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
locationId(optional):
string
The location ID of the store from which items are to be picked up (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
trackingNumber(optional):
string
The tracking number.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city:
string
City.
-
companyName(optional):
string
Company name.
-
country:
string
Country.
-
county(optional):
string
County.
-
email:
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName:
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName:
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
value:
string
The shipping method applied to the order.
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId:
string
The product variant ID.
-
commerceId(optional):
string
Repository ID
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in this shipping group.
-
recurringCharge(optional):
number
The recurring charge for the item.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
code:
string
The coupon code.
-
description(optional):
string
The coupon description.
-
id:
string
The coupon ID.
-
level:
string
The level of the coupon (whether the coupon is item level, etc).
-
status:
string
The current status of the coupon.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId:
string
The product variant ID.
-
childItems(optional):
array childItems
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
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).
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseSelections(optional):
array giftWithPurchaseSelections
The array of gift with purchase selections to be made.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in the cart.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : childItems
Type:
array
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseSelections
Type:
array
The array of gift with purchase selections to be made.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether this child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku reference ID.
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
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:
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). The value of this property should be -1 in case if the current item is a sub item of a configurable product
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in the cart.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
catRefId(optional):
string
The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out
-
giftWithPurchaseIdentifier:
integer
The identifier that links this gift with purchase to the giftWithPurchaseInfo.
-
giftWithPurchaseQuantity:
integer
The total quantity of the commerceItem that is giftWithPurchaseQuantity.
-
productId(optional):
string
ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out
-
promotionId:
string
The promotion ID.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : createOrder_response
Type:
Show Source
object
-
approvalSystemMessages(optional):
array approvalSystemMessages
An array of approval messages when order going in pending approval state
-
billingAddress(optional):
object billingAddress
The billing address details.
-
cartName(optional):
string
Cart name for this order.
-
creationDate(optional):
string
The creation date in ISO format.
-
creationSiteId(optional):
string
The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
-
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.
-
markers(optional):
array markers
Order markers
-
orderAction(optional):
string
The action performed on 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.
-
pricingMessages(optional):
object pricingMessages
The Pricing messages information.
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
scheduledOrder:(optional):
object scheduledOrder:
the schedule information of 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(optional):
object shoppingCart
The shopping cart contents of the current order.
-
siteId(optional):
string
The id of the site in which the order was created
-
sourceSystem(optional):
string
The system where the order originated.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order.
-
uuid(optional):
string
The unique ID for the order.
Nested Schema : approvalSystemMessages
Type:
array
An array of approval messages when order going in pending approval state
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
-
orderDiscount(optional):
number
The order discount.
-
orderDiscountDescList(optional):
array orderDiscountDescList
The list of all the order discounts.
-
secondaryCurrencyShipingAmount(optional):
number
shipping amount in monetry currency
-
shippingDiscount(optional):
number
The shipping discount.
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.
-
orderTotalBySite(optional):
object orderTotalBySite
The map containing order totals by site for all sites in a given order.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue(optional):
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum of shipping and tax)amount in monetry currency
-
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 : pricingMessages
Type:
object
The Pricing messages information.
Show Source
-
giftWithPurchaseMessages(optional):
array giftWithPurchaseMessages
The gift with purchase messages information.
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 : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : scheduledOrder:
Type:
object
the schedule information of order
Show Source
-
clonedOrders(optional):
array clonedOrders
Array of order ids created from scheduled order.
-
createDate(optional):
string
The create date of the Scheduled order.
-
endDate(optional):
string
The end date of the Scheduled order.
-
executionStatusList(optional):
array executionStatusList
list of orders with status that are placed with this schedule.
-
id(optional):
string
The ID of the Scheduled order.
-
lastError(optional):
object lastError
last error of this scheduled order.
-
lastScheduledRun(optional):
string
The last scheduled run of the Scheduled order.
-
name(optional):
string
The name of the Scheduled order.
-
nextScheduledRun(optional):
string
The next scheduled run of the Scheduled order.
-
repositoryId(optional):
string
The repository ID of the Scheduled order.
-
schedule(optional):
object schedule
The schedule of the Scheduled order.
-
siteId(optional):
string
The siteId of the Scheduled order.
-
startDate(optional):
string
The start date of the Scheduled order.
-
state(optional):
string
The status of the Scheduled order.
-
templateOrderId(optional):
string
The template order ID of the Scheduled order.
-
type(optional):
string
The type of the Scheduled order.
-
version(optional):
integer
The version of the Scheduled order.
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.
-
secondaryCurrencyShipingAmount(optional):
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
Shipping tax amount in monetry currency
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
object
The shopping cart contents of the current order.
Show Source
-
items(optional):
array items
The array of products in the shopping cart.
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon code.
-
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 promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
secondaryCurrencyTotalAdjustment(optional):
number
The total adjustment in monetary currency.
-
totalAdjustment(optional):
number
Total Adjustment by the promotion
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
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
-
key(optional):
string
Order marker key. In a marketing campaign marker, key signifies that it is a campaign marker and it also identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value(optional):
string
Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign 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
-
uiIntervention(optional):
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : orderTotalBySite
Type:
object
The map containing order totals by site for all sites in a given order.
Nested Schema : giftWithPurchaseMessages
Type:
array
The gift with purchase messages information.
Show Source
Nested Schema : items
Type:
Show Source
object
-
identifier(optional):
string
The pricing message identifier.
-
params(optional):
array params
The list of all message parameters.
-
priority(optional):
integer
The pricing message priority.
-
summary(optional):
string
The pricing message summary.
-
type(optional):
string
The pricing message type.
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 : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : clonedOrders
Type:
array
Array of order ids created from scheduled order.
Show Source
Nested Schema : executionStatusList
Type:
array
list of orders with status that are placed with this schedule.
Show Source
Nested Schema : lastError
Type:
object
last error of this scheduled order.
Show Source
-
errorDate(optional):
string
The date when error occurred
-
errorMessages(optional):
array errorMessages
An array of error messages
-
scheduleErrorId(optional):
string
error ID of the last failed schedule order
Nested Schema : schedule
Type:
object
The schedule of the Scheduled order.
Show Source
-
daysInMonth(optional):
array daysInMonth
The selected dates in a month in year for the Scheduled order.
-
daysOfWeek(optional):
array daysOfWeek
The days of week of the Scheduled order.
-
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.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.
Nested Schema : items
Type:
Show Source
object
-
errorMessages(optional):
array errorMessages
The error messages list.
-
executionDate(optional):
string
The date for previous scheduled run
-
id(optional):
string
The ID of the Scheduled order.
-
orderId(optional):
string
The ID of the Scheduled order.
-
orderSubmitted(optional):
boolean
The status of order.
-
orderTotal(optional):
number
Total order value.
-
repositoryId(optional):
string
The ID of the Scheduled order.
-
scheduledOrderId(optional):
string
The ID of the Scheduled order.
Nested Schema : daysInMonth
Type:
array
The selected dates in a month in year for the Scheduled order.
Show Source
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.
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(optional):
array items
The array of products in the shipping group.
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
priceInfo(optional):
object priceInfo
The shipping group price information.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge 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.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
submittedDate(optional):
string
The submitted date in ISO format.
-
taxPriceInfo(optional):
object taxPriceInfo
The shipping tax price info details.
-
trackingInfo(optional):
array trackingInfo
Tracking Information for the Order.
-
trackingNumber(optional):
string
The tracking number.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
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.
-
secondaryCurrencyShippingDiscount(optional):
number
The shipping discount in secondary currency in case of mix currency scenario.
-
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.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue(optional):
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum of shipping and tax)amount in monetry currency
-
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 : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
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:
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.
-
secondaryCurrencyShipingAmount(optional):
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
Shipping tax amount in monetry currency
-
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 : store
Type:
object
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location ID of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
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.
-
secondaryCurrencyTaxAmount(optional):
number
Shipping tax amount in monetry currency
-
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.
-
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 promotion ID.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
active(optional):
boolean
UIs this product active.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate(optional):
string
The Availability date of commerce Item.
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
backOrderQuantity(optional):
number
Back Order Quantity of the Items.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
The product variant ID.
-
commerceId(optional):
string
Repository ID
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedItemPriceInfo(optional):
array detailedItemPriceInfo
Detailed Item Price Information.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount(optional):
number
The discount amount.
-
displayName(optional):
string
Display Name.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.
-
listPrice(optional):
string
List Price.
-
onSale(optional):
boolean
Indicates whether the price is for an item that is on sale.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
preOrderQuantity(optional):
number
Pre Order Quantity of the Items.
-
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.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
relationshipType(optional):
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
route.
-
salePrice(optional):
string
Sale Price.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingSurchargeValue(optional):
number
shipping surcharge value.
-
siteId(optional):
string
The ID of the site on which the item was added.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
The unit price.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
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):
integer
The quantity.
-
tax(optional):
number
The tax amount.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
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 : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
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.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate(optional):
string
The Availability date of commerce Item.
-
backOrderQuantity(optional):
number
Back Order Quantity of the Items.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
The product variant ID.
-
childItems(optional):
array childItems
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
-
commerceItemId(optional):
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountInfo(optional):
array discountInfo
The discount information.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
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).
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
id(optional):
string
Repository ID of the commerce item.
-
itemDiscountInfos(optional):
array itemDiscountInfos
Array of promotions received by this item.
-
orderDiscountInfos(optional):
array orderDiscountInfos
Array of order promotions received by this item.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision(optional):
boolean
Point beyond which cancelling the commerce item would be restricted
-
preOrderQuantity(optional):
number
Pre Order Quantity of the Items.
-
price(optional):
number
The actual price of the product.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state at the commerce Item level
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
The unit price of the product.
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : childItems
Type:
array
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : itemDiscountInfos
Type:
array
Array of promotions received by this item.
Show Source
Nested Schema : orderDiscountInfos
Type:
array
Array of order promotions received by this item.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (externally configured) or not (externally configured).
-
amount(optional):
number
The total amount of this item including its child items amounts.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
skuid of the item.
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName(optional):
string
The name of the product.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
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).
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
id(optional):
string
Repository ID of the commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
number
The raw price of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
state(optional):
string
state at the commerce Item level
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
number
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
coupon(optional):
string
The coupon ID.
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
giftWithPurchaseDiscountInfo(optional):
array giftWithPurchaseDiscountInfo
The gift information.
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The promotion ID.
-
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 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
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount of discount this item received from the promotion.
-
couponCodes(optional):
array couponCodes
One or more coupon codes used to grant the item promotion providing the discount.
-
promotionId(optional):
string
The promotion ID that resulted in the discount.
Nested Schema : couponCodes
Type:
array
One or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount of discount this item received from the promotion.
-
couponCodes(optional):
array couponCodes
The array of coupon codes used to grant promotion providing the discount.
-
promotionId(optional):
string
The promotion ID that resulted in the discount.
Nested Schema : couponCodes
Type:
array
The array of coupon codes used to grant promotion providing the discount.
Show Source
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)
{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":6.5,
"amount":18.56,
"valueAddedTax":0,
"countyTax":4.640000000000001,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":7.42,
"countryTax":0
},
"shippingMethod":{
"shippingTax":0.65,
"cost":6.5,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10021",
"submittedDate":null,
"priceInfo":{
"amount":179,
"total":204.06,
"shipping":6.5,
"shippingSurchargeValue":0,
"tax":18.56,
"subTotal":179,
"currencyCode":"USD",
"totalWithoutTax":185.5
},
"recurringChargePriceInfo":{
"discounted":false,
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"manualAdjustmentTotal":0,
"amountIsFinal":false,
"discountAmount":0,
"tax":2.4,
"rawSubtotal":30,
"currencyCode":"USD"
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"Test",
"country":"US",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"address1":"Line 1",
"prefix":"",
"companyName":"",
"postalCode":"36123",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Steve",
"phoneNumber":"45454545",
"alias":"Address",
"faxNumber":"",
"middleName":"",
"state":"AL",
"email":"steve.test@example.com"
},
"trackingNumber":null,
"items":[
{
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"discountAmount":0,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"preOrderQuantity":0,
"assetKey":"12345",
"price":179,
"variant":[
{
"optionValue":"Red",
"optionName":"color"
},
{
"optionValue":"Large",
"optionName":"size"
}
],
"primaryImageAltText":"Antique Wood Chair",
"actionCode":"Add",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":179,
"pointOfNoRevision":false,
"productId":"xprod2105",
"parentAssetKey":null,
"active":true,
"catRefId":"xsku2105",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/antique-wood-chair/product/xprod2105",
"activationDate":"2017-06-27T15:30:00Z",
"backOrderQuantity":0,
"recurringCharge":10,
"status":"INITIAL",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/ST_AntiqueWoodChair_full.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":179,
"returnedQuantity":0,
"displayName":"Antique Wood Chair",
"shippingSurchargeValue":0,
"externalData":[
],
"commerceItemId":"ci3000411",
"onSale":false,
"serviceId":"service-123",
"serviceAccountId":"serviceAcc-123",
"primaryImageTitle":"Antique Wood Chair",
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":179,
"quantity":1,
"tax":17.91,
"orderDiscountShare":0,
"detailedUnitPrice":179,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"asset":false,
"listPrice":179
}
],
"email":"a@example.com",
"status":"INITIAL"
}
],
"creationTime":1.411984170268E12,
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"cost":6.5,
"value":"ground"
},
"payments":[
{
"paymentGroupId":"pg70441",
"amount":100,
"customPaymentProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"balance":null,
"gatewayName":"chaseGiftCard",
"giftCardNumber":null,
"uiIntervention":null,
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"AUTHORIZED",
"maskedCardNumber":"xxxxxxxxxxxxxxx1071"
},
{
"paymentGroupId":"pg70442",
"amount":158.5,
"customPaymentProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"gatewayName":"chaseCreditCard",
"uiIntervention":null,
"paymentMethod":"creditCard",
"isAmountRemaining":true,
"paymentState":"AUTHORIZED"
}
],
"priceListGroup":{
"repositoryId":"UsDollar"
},
"cartName":"Test Name",
"creationDate":"2014-01-01T00:30:00.000Z",
"uuid":"05a89e3c-346b-4d50-a55d-91316a50b152",
"orderAction":"order",
"priceInfo":{
"amount":179,
"total":204.06,
"shipping":6.5,
"shippingSurchargeValue":0,
"tax":18.56,
"subTotal":179,
"currencyCode":"USD"
},
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"orderDiscount":0,
"orderDiscountDescList":[
{
"promotionLevel":"item",
"coupon":"FREETATTOO",
"totalAdjustment":"-21.99",
"promotionDesc":"Explicit Item Discount - FREETATTOO",
"promotionId":"explicitItemFreeDiscount"
}
],
"shippingDiscount":0
},
"pricingMessages":{
"giftWithPurchaseMessages":[
{
"summary":"The cart has qualified for a free gift promotion.",
"identifier":"GWPQualified",
"params":[
],
"type":"information",
"priority":"-10"
}
]
},
"trackingInfo":[
],
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"itemDiscountInfos":[
{
"couponCodes":[
"TestCouponCode"
],
"amount":10,
"promotionId":"promo10001"
}
],
"externalPrice":175,
"commerceItemId":"ci3000411",
"price":179,
"variant":[
{
"optionValue":"Red",
"optionName":"color"
},
{
"optionValue":"Large",
"optionName":"size"
}
],
"actionCode":"Add",
"serviceId":"service-123",
"unitPrice":179,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"xprod2105",
"externalRecurringCharge":10,
"orderDiscountInfos":[
{
"couponCodes":[
],
"amount":29.9,
"promotionId":"orderDiscount"
},
{
"couponCodes":[
"coupon101"
],
"amount":5,
"promotionId":"promo10001"
}
],
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"externalPriceQuantity":1,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"xsku2105",
"externalRecurringChargeDuration":"12",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"recurringCharge":10
}
]
},
"shippingAddress":{
"lastName":"Test",
"country":"US",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"address1":"Line 1",
"prefix":"",
"companyName":"",
"postalCode":"36130",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"AL",
"email":"steve.test@example.com"
},
"id":"o10018",
"billingAddress":{
"lastName":"Test",
"country":"US",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"address1":"Line 1",
"prefix":"",
"companyName":"",
"postalCode":"36130",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"AL",
"email":"steve.test@example.com"
},
"quoteInfo":{
"providerNote":null,
"notes":[
{
"profileType":null,
"profileId":"120213",
"requestDate":1.477479521002E12,
"requesterNote":"This is a sample quote"
}
],
"rejectionDate":null,
"requestDate":"2016-10-26T10:58:41.002Z",
"errorInfo":null,
"externalID":null,
"rejectionNote":null,
"quoteDate":null,
"expirationDate":null
},
"markers":[
{
"repositoryId":"mark100001",
"value":"78900",
"key":"campaign_eloqua"
}
]
}
Default 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:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
51006 | The location used does not support in-store pickup | Enter a location that this store supports in-store pickup |
28102 | Product/Sku not found | The product ID you are using may be a typo or that product may not exist in the store |
28129 | The sku ID was not found for the product ID provided | Enter a valid sku ID that relates to the product ID queried |
25137 | An error occurred during inventory check for a configurable item | The quantity ordered is greater than the stock available. Reduce quantity to order. |
71006 | JSON Syntax error | Ensure the JSON syntax is correct. Look for correct closing braces or missing commas etc. |
28411 | Shopper input does not belong to sku specified | Ensure the shopper input is correct for the specified sku ID e.g. ensure color is applicable to the specified sku ID. | 51000 | An error has occured during the invocation of the web hook and the external pricing system. | A possible fix would be to check the webhook is configured correctly in Admin | 28089 | The request payload does not contain any shipping information. It must contain shipping information | Add shipping information to the payload | 28087 | No shipping method specified | Add a shipping method to the payload |
The error response:
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