Price an order
post
/ccstore/v1/orders/price
This endpoint is responsible for pricing the items in the cart. It will return the price of the order along with full order details and any pricing messages that may be available. These messages include things like a promotional change e.g. informing a shopper their order has qualified for a free gift etc. The cart at any price order call is "INCOMPLETE"; as even at the final call during checkout, at the point of the call, the order is still incomplete. Additionally, the pricing response will be cached.
Note: The minimum required properties for the request payload are order ID, shipping method, payment, shopping cart, shipping address, reprice property - set to true/false
Request
Supported Media Types
- application/json
Query Parameters
-
includeShippingGroups(optional): boolean
Specify if shipping groups information should be mapped in response payload. If true, shipping groups information would be sent. By default, it is false.Default Value:
false
Header Parameters
-
X-CCAsset-Language(optional): string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Root Schema : priceOrder_request
Type:
Show Source
object
-
checkout:
boolean
The option to check in case the data is updated from checkout page.
-
combineLineItems(optional):
string
Value to determine if line items are to be combined. Can be yes or no.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
gift with purchase order marker information. Required if gift with purchase order marker information is present.
-
orderId(optional):
string
The ID of order to reprice. This parameter is mandatory if reprice flag is true. Currently this and reprice parameter is used only for orders in pending approval state.
-
payments(optional):
array payments
The array of payments containing gift card payments or a payment card's issue identification number (IIN) to be sent when repricing the order. Properties are specific to the given payment type e.g. if 'type' is iinPaymentType include only 'IIN', if physicalGiftCard include all other properties
-
populateShippingMethods(optional):
boolean
This flag identifies whether to validate the full address or only the state, country and zip code. Full address is validated when this is set to false.
-
reprice(optional):
boolean
Currently this flag is used in combination with orderId parameter. If flag is true orderId is mandatory. Used only for orders in pending approval state.
-
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:
{
"orderId":"o10001",
"shippingMethod":{
"value":"ground"
},
"payments":[
{
"amount":"100.0",
"giftCardNumber":"6035710988880101071",
"giftCardPin":"",
"type":"physicalGiftCard"
}
],
"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",
"stockStatus":true,
"actionCode":"Add",
"serviceId":"service-123",
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"dynamicPropertyMode":"pickup",
"productId":"xprod2165",
"externalRecurringCharge":10,
"parentAssetKey":null,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"xsku2165",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"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
}
]
},
"reprice":true,
"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"
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type:
array
gift with purchase order marker information. Required if gift with purchase order marker information is present.
Show Source
Nested Schema : payments
Type:
array
The array of payments containing gift card payments or a payment card's issue identification number (IIN) to be sent when repricing the order. Properties are specific to the given payment type e.g. if 'type' is iinPaymentType include only 'IIN', if physicalGiftCard include all other properties
Show Source
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.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
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:
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
atg.gwp
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
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:
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object
-
amount:
string
The total balance on the gift card. It will be empty if the gift card is added for the first time.
-
giftCardNumber:
string
Gift card number. Payment type:physicalGiftCard.
-
giftCardPin(optional):
string
Gift card pin. Payment type:physicalGiftCard.
-
IIN(optional):
string
The issuer identification number (first 6 digits) of the IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout. (iinPaymentType only)
-
type:
string
The type of the payment. e.g. physicalGiftCard/iinPaymentType.
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).
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
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.
-
commerceItemId(optional):
string
Unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
-
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.
-
siteId(optional):
string
The ID of the site on which the item was added.
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 : items
Type:
Show Source
object
-
code:
string
The coupon code.
-
description(optional):
string
The coupon description.
-
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.
-
id:
string
The coupon ID.
-
level:
string
The level of the coupon (whether the coupon is item level, etc).
-
recurringCharge(optional):
number
The recurring charge for the item.
-
status:
string
The current status of the coupon.
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 : 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.
-
currentPrice:
number
The current price of the 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.
-
discountInfo(optional):
object discountInfo
Discount 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.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
-
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.
-
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
-
stockStatus:
string
The stock status of the product.
-
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 : discountInfo
Type:
object
Discount information.
Show Source
-
coupon:
string
Coupon code.
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
giftWithPurchaseDiscountInfo(optional):
array giftWithPurchaseDiscountInfo
The gift selection information.
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
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 : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
array
giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
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 the child item is an add-on (externally 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.
-
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 : giftWithPurchaseDiscountInfo
Type:
array
The gift selection information.
Show Source
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
-
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
-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this gift with purchase promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The gift with purchase promotion ID.
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 : priceOrder_response
Type:
Show Source
object
-
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.
-
discountInfo(optional):
object discountInfo
The discount information.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
gift with purchase order marker information.
-
markers(optional):
array markers
Order markers
-
numberOfItems(optional):
integer
The number of items in the cart.
-
orderAction(optional):
string
The action performed on the order.
-
orderId(optional):
string
The ID of order to reprice.
-
payments(optional):
array payments
Payment details for the pricing call, including additional properties specific to the payment type.
-
priceInfo(optional):
object priceInfo
The order price information.
-
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.
-
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
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 : giftWithPurchaseOrderMarkers
Type:
array
gift with purchase order marker information.
Show Source
Nested Schema : payments
Type:
array
Payment details for the pricing call, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type:
object
The order price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
primaryCurrencyTotal(optional):
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. -
secondaryCurrencyShippingAmount(optional):
number
This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. -
secondaryCurrencyShippingSurchargeValue(optional):
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount(optional):
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency. -
secondaryCurrencyTotal(optional):
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency. -
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
The sub-total amount.
-
tax(optional):
number
The total tax amount.
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
The order total.
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 : 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 : 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
-
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.
-
secondaryCurrencyTotalAdjustment(optional):
number
The total adjustment in monetary currency.
-
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
-
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):
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
-
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.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
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.
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
Identifier 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 to be used from the payment group.
-
balance(optional):
number
Total available balance on the gift card.
-
gatewayName(optional):
string
Payment gateway name. e.g. chaseGiftCard.
-
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. INITIAL.
-
uiIntervention(optional):
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
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 : 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(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).
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
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
-
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 : 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.
-
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).
-
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.
-
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).
-
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.
-
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 of the commerce Item
-
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 : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
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
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
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(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.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id(optional):
string
Repository ID of the commerce item.
-
onSale(optional):
boolean
Whether the product is on sale.
-
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
The boolean that indicates if the item has passed pointOfNoRevision.
-
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.
-
state(optional):
string
state of the commerce Item
-
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 : 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 : giftWithPurchaseCommerceItemMarkers
Type:
array
giftWithPurchaseCommerceItemMarker information.
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.
-
itemDiscountInfos(optional):
array itemDiscountInfos
Array of promotions received by this 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.
-
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 : itemDiscountInfos
Type:
array
Array of 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 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
-
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 selection 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.
-
secondaryCurrencyTotalAdjustment(optional):
number
The total adjustment in monetary currency.
-
totalAdjustment(optional):
number
Total adjustment by the promotion.
Nested Schema : giftWithPurchaseDiscountInfo
Type:
array
The gift selection information.
Show Source
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
-
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
-
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
Example Response (application/json)
{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0.88,
"amount":2.51,
"valueAddedTax":0,
"countyTax":0.63,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1,
"countryTax":0
},
"priceInfo":{
"amount":19,
"total":27.46,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":2.51,
"subTotal":19,
"currencyCode":"USD",
"totalWithoutTax":24.95
},
"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,
"shippingDiscount":0,
"discountDescList":[
]
},
"shippingMethod":{
"shippingTax":0.6,
"cost":5.95,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10015",
"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":null
},
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":19,
"returnedQuantity":0,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"price":19,
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":19,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"xprod2065",
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":19,
"quantity":1,
"tax":1.91,
"orderDiscountShare":0,
"detailedUnitPrice":19,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"parentAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku2065",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"siteId":"siteUS",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"listPrice":19,
"recurringCharge":10,
"status":"INITIAL"
}
],
"email":"a@example.com"
}
],
"orderId":"o10001",
"creationSiteId":"siteUS",
"shippingMethod":{
"cost":6.5,
"value":"ground"
},
"payments":[
{
"paymentGroupId":"pg70448",
"amount":27.46,
"balance":"100.0",
"gatewayName":"chaseGiftCard",
"giftCardNumber":"6035710988880101071",
"uiIntervention":null,
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":true,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxxxxxxxxxxxx1071"
}
],
"orderAction":"order",
"priceInfo":{
"amount":19,
"total":27.46,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":2.51,
"subTotal":19,
"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":{
"unclaimedCouponMultiPromotions":{
"coupon2":[
{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
]
},
"orderCouponsMap":{
"coupon1":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
"coupon2":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
{
"promotionLevel":"item",
"totalAdjustment":"-0.66",
"promotionDesc":"Implicit Item Discount - 3PercentOff",
"promotionId":"implicitItemPercentDiscount"
}
],
"claimedCouponMultiPromotions":{
"coupon1":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo3",
"promotionId":"promo20003"
}
],
"coupon2":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
]
},
"unclaimedCouponsMap":{
"coupon2":{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
}
},
"pricingMessages":{
"giftWithPurchaseMessages":[
{
"summary":"The cart has qualified for a free gift promotion.",
"identifier":"GWPQualified",
"params":"[]",
"type":"information",
"priority":"-10"
}
]
},
"numberOfItems":1,
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"itemDiscountInfos":[
{
"couponCodes":[
"TestCouponCode"
],
"amount":10,
"promotionId":"promo10001"
}
],
"assetKey":"12345",
"commerceItemId":"ci3000411",
"price":19,
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"unitPrice":19,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"xprod2065",
"externalRecurringCharge":10,
"orderDiscountInfos":[
{
"couponCodes":[
],
"amount":29.9,
"promotionId":"orderDiscount"
},
{
"couponCodes":[
"coupon101"
],
"amount":5,
"promotionId":"promo10001"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"parentAssetKey":null,
"originalCommerceItemId":null,
"externalRecurringChargeFrequency":"Monthly",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku2065",
"discountInfo":[
],
"customerAccountId":"customerAcc-123",
"siteId":"siteUS",
"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
}
]
},
"siteId":"siteUS",
"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":[
],
"giftWithPurchaseOrderMarkers":[
{
"quantity":1,
"selectedQuantity":0,
"removedQuantity":0,
"data":"-1275480226",
"automaticQuantity":0,
"giftType":"product",
"autoRemove":true,
"giftDetail":"camera_1",
"repositoryId":"200001",
"failedQuantity":0,
"value":"promo10002",
"targetedQuantity":0,
"key":"atg.gwp"
}
]
}
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 |
---|---|---|
28088 | Invalid shipping method | Select/Enter a valid shipping method |
40001 | An error occurred whilst calculating tax | The data passed in the payload may be invalid or the payment gateway may be down. Ensure the valid data passed and that the a valid payment gateway is setup in Admin. |
28120 | An error occurred when trying to automatically add a gift-with-purchase item to the order | Check that the item trying to be added is in stock. Check the inventory via admin UI or ccdebug endpoints. |
28301 | An error occurred during pricing operation | Retry or try again later |
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