Update current profile's order
post
/ccstore/v1/orders/current
Updates the persisted order(an order that will remain saved until it is deleted) for the logged in user with the data sent in the request and re-prices the order with the latest prices. Returns the updated order details along with the pricing response which is cached. At this point the order is in the "INCOMPLETE" state.
The only minimum required property in the request is the shopping cart data.
Dynamic Properties of order and items can be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). Please refer to the "Create an Order" endpoint which talks in a bit more detail of the dynamic properties.
Note: This endpoint is not part of the cart (current incomplete order) actions grouping.
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.
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 : updateCurrentProfileOrder_request
Type:
Show Source
object
-
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.
-
id(optional):
string
Updates the order corresponding to the passed orderId.
-
op:
string
Set to update for updating the current order, or create for creating a new incomplete order.
-
payments(optional):
array payments
The array of payments containing only gift card payments to be sent to reprice the order.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
Example:
{
"op":"update",
"payments":[
{
"amount":"100.0",
"giftCardNumber":"6035710988880101071",
"giftCardPin":"",
"type":"physicalGiftCard"
}
],
"shoppingCart":{
"coupons":[
{
"code":"coupon1",
"level":"order",
"description":"promo1",
"id":"promo20001",
"totalAdjustment":-1,
"status":"claimed"
},
{
"code":"coupon2",
"level":"",
"description":"",
"id":"",
"status":""
}
],
"numberOfItems":1,
"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",
"price":40,
"onSale":true,
"actionCode":"Add",
"serviceId":"service-123",
"unitPrice":40,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"dynamicPropertyMode":"pickup",
"productId":"xprod1047",
"externalRecurringCharge":10,
"parentAssetKey":null,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"xsku1242",
"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
}
]
},
"cartName":"My New Cart",
"id":"o10001",
"dynamicPropertyShippingInstructions":"Test Instructions"
}
Nested Schema : payments
Type:
array
The array of payments containing only gift card payments to be sent to reprice the order.
Show Source
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
coupons(optional):
array coupons
The array of coupons applied to the order.
-
items(optional):
array items
Items in the cart.
-
numberOfItems:
integer
Number of items in the cart.
Nested Schema : items
Type:
Show Source
object
-
amount:
string
The total balance on the gift card.
-
giftCardNumber:
string
Gift card number. Payment type:physicalGiftCard.
-
giftCardPin(optional):
string
Gift card pin. Payment type:physicalGiftCard.
-
type:
string
The type of the payment. e.g. physicalGiftCard.
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
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.
-
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(optional):
string
The coupon code.
-
description(optional):
string
The promotion 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(optional):
string
The promotion ID.
-
level(optional):
string
The level of the promotion (whether the coupon is item level, etc).
-
recurringCharge(optional):
number
The recurring charge for the item.
-
status(optional):
string
The current status of the coupon.
-
totalAdjustment(optional):
string
Adjustment done by the promotion.
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
Sku reference 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.
-
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.
-
price:
number
Price of the items.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
Quantity of the items.
-
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 : 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 : 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 : 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 : updateCurrentProfileOrder_response
Type:
Show Source
object
-
cartName(optional):
string
Cart name for this order.
-
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
Discount Information
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
gift with purchase order marker information
-
orderAction(optional):
string
The action performed on the order.
-
orderId(optional):
string
Order ID of the order to remove.
-
payments(optional):
array payments
Payment details for the pricing call, including additional properties specific to the payment type.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
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.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
-
siteId(optional):
string
The ID of the site in which the order was created
Nested Schema : discountInfo
Type:
object
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
Order Discount
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
Implicit Promotions for the order
-
secondaryCurrencyShippingDiscount(optional):
number
The shipping discount in secondary currency in case of mix currency scenario
-
shippingDiscount(optional):
number
Shipping Discount
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
The coupons that were not claimed
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 pricing call, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
Amount of order.
-
currencyCode(optional):
string
Currency code.
-
shipping(optional):
number
Shipping price of order.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub total.
-
tax(optional):
number
Tax.
-
total(optional):
number
Total amount of order.
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 : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items(optional):
array items
Items in the cart.
-
numberOfItems(optional):
integer
Number of items in the cart.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
Show Source
-
coupon code(optional):
array coupon code
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed
Show Source
-
coupon code(optional):
object coupon code
Coupon Code
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
coupon code(optional):
array coupon code
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
object
The coupons that were not claimed
Show Source
-
coupon code(optional):
object coupon code
Coupon Code
Nested Schema : coupon code
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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion ID
-
promotionLevel(optional):
string
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
Adjustment done by the promotion
Nested Schema : coupon code
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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion ID
-
promotionLevel(optional):
string
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
Adjustment done 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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion ID
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : coupon code
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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion ID
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : coupon code
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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion ID
-
promotionLevel(optional):
string
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
-
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.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity(optional):
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail(optional):
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
atg.gwp
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value(optional):
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Amount 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).
-
priceInfo(optional):
object priceInfo
The price information.
-
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.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
surcharge(optional):
number
The shipping surcharge.
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : priceInfo
Type:
object
The price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub-total.
-
tax(optional):
number
The total tax amount.
-
total(optional):
number
The order total.
Nested Schema : 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(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.
-
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
active or not.
-
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.
-
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.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountInfo(optional):
array discountInfo
The discount information.
-
displayName(optional):
string
The name of the product.
-
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.
-
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).
-
price(optional):
integer
The actual price of the product.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in the shipping group.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
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.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
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 of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
integer
The unit price of the product.
-
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
-
coupon(optional):
string
The coupon ID.
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions)
-
promotionDesc(optional):
string
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
The promotion ID.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of 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.
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
-
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
Sku reference 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.
-
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
The array of giftWithPurchaseCommerceItemMarkers.
-
id(optional):
string
Repository ID of the commerce 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
Price of the items.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
Quantity of the items.
-
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.
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
The array of giftWithPurchaseCommerceItemMarkers.
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):
integer
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):
integer
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):
integer
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
-
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.
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.
Example Response (application/json)
{
"shippingGroups":[
{
"priceInfo":{
"amount":37,
"total":37,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":37,
"currencyCode":"USD",
"totalWithoutTax":37
},
"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,
"cost":0,
"value":"hardgoodShippingGroup"
},
"shippingGroupId":"sg10012",
"shippingAddress":{
"lastName":null,
"country":null,
"address3":null,
"address2":null,
"city":null,
"address1":null,
"prefix":null,
"companyName":null,
"postalCode":null,
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":null,
"phoneNumber":null,
"alias":null,
"faxNumber":null,
"middleName":null,
"state":null,
"email":null
},
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":40,
"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":40,
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":40,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"xprod1049",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":40,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":40,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"parentAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku1242",
"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":40,
"recurringCharge":10,
"status":"INITIAL"
}
]
}
],
"orderId":"o10001",
"creationSiteId":"siteUS",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"payments":[
{
"paymentGroupId":"pg70448",
"amount":37,
"balance":"100.0",
"gatewayName":"chaseGiftCard",
"giftCardNumber":"6035710988880101071",
"uiIntervention":null,
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":true,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxxxxxxxxxxxx1071"
}
],
"cartName":"My New Cart",
"priceInfo":{
"amount":37,
"total":37,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":40,
"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":3,
"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"
}
]
},
"shoppingCart":{
"numberOfItems":1,
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v534243951836338001/products/1242_LARGE.jpg&height=100&width=100",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"price":40,
"onSale":true,
"primaryImageAltText":"Product Alternative Text",
"actionCode":"Add",
"serviceId":"service-123",
"unitPrice":40,
"serviceAccountId":"serviceAcc-123",
"primaryImageTitle":"Product title",
"childSKUs":[
{
"primaryThumbImageURL":null
}
],
"quantity":1,
"productId":"xprod1047",
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"parentAssetKey":null,
"originalCommerceItemId":null,
"externalRecurringChargeFrequency":"Monthly",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku1242",
"customerAccountId":"customerAcc-123",
"route":"/product-name/product/xprod2148",
"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
},
"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
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Note: A lot of common errors in this call are also found when creating the order. Please refer to "Create an Order" for any error codes and resolutions that may not appear here before seeking further guidance.
Error Code | Description | Possible Fix |
---|---|---|
28315 | The order update failed. | Ensure the request body is correct and there are no typos in the keys. |
28326 | The coupon code provided in the request was not found in the registry. | Ensure the coupon code exists. If this does not resolve the issue, ensure spelling of code is correct. |
28081 | There are no items in the shopping cart data provided. | Ensure the use of valid data in the shopping cart in the request 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