updateOrder
put
/ccstore/v1/orders/{id}
Update Order. Update an order. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user. Dynamic Properties of order and order line items can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
stringRequired:trueThe ID of order to update.
Header Parameters
- X-CCOrganization
-
Type:
stringCurrent organization context of the logged in user
Body Parameter
Root Schema : updateOrder_request
{
"isAnonymousCheckout":false,
"visitId":"27c79ed0-384f-4658-824d-c5b8518bfde0",
"appliedPromotions":[
"explicitItemFreeDiscount"
],
"shippingMethod":{
"value":"twoDay"
},
"payments":[
{
"cardCVV":"123",
"nameOnCard":"test",
"cardTypeName":"Visa",
"cardType":"visa",
"endMonth":"02",
"type":"card",
"endYear":2018,
"cardNumber":"4055011111111111"
}
],
"shoppingCart":{
"coupons":[
{
"code":"FREETATTOO",
"level":"item",
"description":"Explicit Item Discount - FREETATTOO",
"id":"explicitItemFreeDiscount",
"totalAdjustment":"-21.99",
"status":"claimed"
}
],
"items":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"dynamicPropertyMode":"pickup",
"productId":"prod20006",
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"externalData":[
],
"billingAccountId":"billingAcc-123",
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku40105",
"externalRecurringChargeDuration":"12",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"actionCode":"Add",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"recurringCharge":10
}
],
"orderTotal":109.46
},
"shippingAddress":{
"lastName":"h",
"country":"United States",
"address3":"",
"address2":"A2",
"city":"C1",
"prefix":"",
"address1":"A1",
"defaultCountryCode":null,
"postalCode":"36123",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"h",
"phoneNumber":"34534533",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"Alabama",
"selectedState":"AL",
"email":"h@h.com",
"state_ISOCode":"US-AL"
},
"id":"o10003",
"billingAddress":{
"lastName":"Test",
"country":"United States",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"prefix":"",
"address1":"Line 1",
"postalCode":"36123",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"Alabama",
"selectedState":"AL",
"state_ISOCode":"US-AL"
},
"dynamicPropertyShippingInstructions":"Test Instructions",
"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"
}
],
"visitorId":"-6820098066093706883"
}
- appliedPromotions
-
Type:
arrayappliedPromotionsAdditional Properties Allowed:The array of applied promotions. - billingAddress
-
Type:
objectbillingAddressAdditional Properties Allowed:The billing address details. - combineLineItems
-
Type:
stringValue to determine if line items are to be combined. Can be yes or no. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersAdditional Properties Allowed:giftWithPurchaseOrderMarker information. Required if giftWithPurchaseOrderMarker information is present. - isAnonymousCheckout
-
Type:
booleanReturns false if the order is for a logged-in user. - payments
-
Type:
arraypaymentsAdditional Properties Allowed:Payment details to update the order. - shippingAddress
-
Type:
objectshippingAddressRequired:trueAdditional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
arrayshippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
objectshippingMethodRequired:trueAdditional Properties Allowed:The shipping method details for the order. - shoppingCart
-
Type:
objectshoppingCartRequired:trueAdditional Properties Allowed:The shopping cart contents of the current order.
Nested Schema : appliedPromotions
Nested Schema : billingAddress
Type:
objectThe billing address details.
- address1
-
Type:
stringRequired:trueAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringRequired:trueCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringRequired:trueCountry. - county
-
Type:
stringCounty. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringRequired:trueFirst name. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringRequired:trueLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringRequired:truePostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringRequired:trueCountry code. - selectedState
-
Type:
stringRequired:trueState code. - state
-
Type:
stringRequired:trueState. - state_ISOCode
-
Type:
stringRequired:trueState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringRequired:trueAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringRequired:trueCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringRequired:trueCountry. - county
-
Type:
stringCounty. -
Type:
stringRequired:trueEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringRequired:trueFirst name. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringRequired:trueLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringRequired:truePostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringRequired:trueCountry code. - selectedState
-
Type:
stringRequired:trueState code. - state
-
Type:
stringRequired:trueState. - state_ISOCode
-
Type:
stringRequired:trueState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
- value
-
Type:
stringRequired:trueThe shipping method applied to the order.
Nested Schema : shoppingCart
Type:
objectThe shopping cart contents of the current order.
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberRequired:trueThe quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
booleanRequired:trueFlag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
integerRequired:trueAn identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - failedQuantity
-
Type:
numberRequired:trueThe amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site. - giftDetail
-
Type:
stringRequired:trueString identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
stringRequired:trueThe type of the gift. (sku, product) - key
-
Type:
stringRequired:trueatg.gwp - quantity
-
Type:
numberRequired:trueThe total quantity of sku for this gift selection. - removedQuantity
-
Type:
numberRequired:trueThe amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integerRequired:trueThe quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
numberRequired:trueThe quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
stringRequired:trueThe gift with purchase promotion id
Nested Schema : items
Type:
object- amount
-
Type:
numberAmount to be authorized from the gift card. Payment type:invoice,card, physicalGiftCard, paypalCheckout, payUWebLatamCheckout. - cardCVV
-
Type:
stringCredit/Debit card secret pin. Payment type:card. - cardNumber
-
Type:
stringCredit/Debit card number used for payment. Payment type:card. - cardType
-
Type:
stringCredit/Debit card type. e.g. visa. Payment type:card. - cardTypeName
-
Type:
stringCredit/Debit card type name. e.g. Visa. Payment type:card. - endMonth
-
Type:
stringCredit/Debit card expiry month. Payment type:card. - endYear
-
Type:
stringCredit/Debit card expiry year. Payment type:card. - giftCardNumber
-
Type:
stringGift card number used for payment. Payment type:physicalGiftCard. - giftCardPin
-
Type:
stringGift card pin. Payment type:physicalGiftCard. - nameOnCard
-
Type:
stringName on the credit/debit card. Payment type:card. - PayerID
-
Type:
stringPayer ID relevant to paypal checkout type. Payment type:paypalCheckout. - paymentGroupId
-
Type:
stringPayment Group Id of the gift card payment group. Payment type:physicalGiftCard. - paymentId
-
Type:
stringPayment ID relevant to the payment type. Payment type:paypalCheckout, payUWebLatamCheckout. - PONumber
-
Type:
stringPurchase order number. Pament type:invoice - type
-
Type:
stringRequired:truePayment type. e.g. paypalCheckout, payUWebLatamCheckout.
Nested Schema : items
Type:
object- items
-
Type:
arrayitemsRequired:trueAdditional Properties Allowed:The array of products in the shipping group. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address details. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:The shipping method details for the order.
Nested Schema : items
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
- value
-
Type:
stringThe shipping method applied to the order.
Nested Schema : items
Type:
object- catRefId
-
Type:
stringRequired:trueThe category to which the product belongs. - commerceItemId
-
Type:
stringThe unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no. - productId
-
Type:
stringRequired:trueID of the product in the cart. - quantity
-
Type:
integerRequired:trueThe quantity of the product in the shipping group.
Nested Schema : coupons
Nested Schema : items
Nested Schema : items
Type:
object- code
-
Type:
stringRequired:trueThe coupon code. - description
-
Type:
stringThe coupon description. - id
-
Type:
stringRequired:trueThe coupon ID. - level
-
Type:
stringRequired:trueThe level of the coupon (whether the coupon is item level, etc). - status
-
Type:
stringRequired:trueThe current status of the coupon.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringRequired:trueThe category to which the product belongs. - childItems
-
Type:
arraychildItemsAdditional Properties Allowed:The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself. - commerceItemId
-
Type:
stringThe unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
numberA price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable). - externalPriceQuantity
-
Type:
integerThe maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). - externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly. - giftWithPurchaseCommerceItemMarkers
-
Type:
arraygiftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in. - productId
-
Type:
stringRequired:trueID of the product in the cart. - quantity
-
Type:
integerRequired:trueThe quantity of the product in the cart. - recurringCharge
-
Type:
numberThe recurring charge for the item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : childItems
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe monetary amount for the recurring charge. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - tax
-
Type:
numberMonetary tax amount.
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : items
Type:
object- activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringRequired:trueSku reference id. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
numberRequired:trueA price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable). - externalPriceQuantity
-
Type:
integerRequired:trueThe 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
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly. - productId
-
Type:
stringRequired:trueID of the product in the cart. - quantity
-
Type:
integerRequired:trueThe quantity of the product in the cart. - recurringCharge
-
Type:
numberThe recurring charge for the item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe monetary amount for the recurring charge. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - tax
-
Type:
numberMonetary tax amount.
Nested Schema : externalData
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberRequired:trueThe quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integerRequired:trueThe gift hash code for this gift with purchase promotion. - key
-
Type:
stringRequired:trueatg.gwp - remainingQuantity
-
Type:
numberRequired:trueThe quantity of the commerce item that is not affected by gift with purchase. - selectedQuantity
-
Type:
numberRequired:trueThe quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
numberRequired:trueThe quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
stringRequired:trueThe gift with purchase promotion id.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateOrder_response
- approvalSystemMessages
-
Type:
arrayapprovalSystemMessagesAdditional Properties Allowed:An array of approval messages when order going in pending approval state - creationDate
-
Type:
stringThe creation date in ISO format. - creationTime
-
Type:
numberThe creation time in long seconds. - discountInfo
-
Type:
objectdiscountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
arraydynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
arraygiftWithPurchaseInfoAdditional Properties Allowed:The gift information. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersAdditional Properties Allowed:giftWithPurchaseOrderMarker information - id
-
Type:
stringThe order ID. - payments
-
Type:
arraypaymentsAdditional Properties Allowed:Payment details for the order, including additional properties specific to the payment type. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:The price information. - pricingMessages
-
Type:
objectpricingMessagesAdditional Properties Allowed:The Pricing messages information. - quoteInfo
-
Type:
objectquoteInfoAdditional Properties Allowed:the quote information of the order - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
arrayshippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:The shipping method details for the order. - shoppingCart
-
Type:
objectshoppingCartAdditional Properties Allowed:The shopping cart contents of the current order. - sourceSystem
-
Type:
stringThe system where the order originated. - trackingInfo
-
Type:
arraytrackingInfoAdditional Properties Allowed:Tracking Information for the Order. - uuid
-
Type:
stringThe unique ID for the order.
Nested Schema : approvalSystemMessages
Type:
arrayAn array of approval messages when order going in pending approval state
-
Type:
string
Nested Schema : discountInfo
Type:
objectThe discount information.
- orderDiscount
-
Type:
integerThe order discount. - orderDiscountDescList
-
Type:
arrayorderDiscountDescListAdditional Properties Allowed:The list of all the order discounts. - shippingDiscount
-
Type:
integerThe shipping discount.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Nested Schema : priceInfo
Type:
objectThe price information.
- amount
-
Type:
numberThe total order amount. - currencyCode
-
Type:
stringThe currency code. - shipping
-
Type:
numberThe total shipping cost. - shippingSurchargeValue
-
Type:
numberExtra handling costs for shipping the products. - subTotal
-
Type:
numberSub-total. - tax
-
Type:
numberThe total tax amount. - total
-
Type:
numberThe order total.
Nested Schema : pricingMessages
Type:
objectThe Pricing messages information.
- giftWithPurchaseMessages
-
Type:
arraygiftWithPurchaseMessagesAdditional Properties Allowed:The gift with purchase messages information.
Nested Schema : quoteInfo
Type:
objectthe quote information of the order
- errorInfo
-
Type:
arrayerrorInfoAdditional Properties Allowed:the array of errors, if any - expirationDate
-
Type:
stringthe expiration date of the quoted order, if any - externalId
-
Type:
stringthe external id for the quote - notes
-
Type:
arraynotesAdditional Properties Allowed:the notes (history) for the order - providerNote
-
Type:
stringthe provider note for the quoted order - quoteDate
-
Type:
numberthe date the order was quoted in milliseconds - rejectionDate
-
Type:
stringrejection date of the quoted order - rejectionNote
-
Type:
stringthe rejection note for an order whose quote has been rejected by user - requestDate
-
Type:
stringthe date when the quote was requested in ISO format
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - frequencyAmountTotals
-
Type:
arrayfrequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
arrayfrequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - shipping
-
Type:
numberCost of shipping the product. - subTotal
-
Type:
numberThe sub-total price of the recurring charge. - tax
-
Type:
numberMonetary tax amount. - total
-
Type:
numberThe total price of the recurring charge. - totalWithoutTax
-
Type:
numberTotal of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
- cost
-
Type:
numberThe total cost of shipping. - value
-
Type:
stringThe shipping method applied to the order.
Nested Schema : shoppingCart
Type:
objectThe shopping cart contents of the current order.
- items
-
Type:
arrayitemsAdditional Properties Allowed:The array of products in the shopping cart.
Nested Schema : trackingInfo
Nested Schema : orderDiscountDescList
Nested Schema : items
Type:
object- coupon
-
Type:
stringThe coupon code. - promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringThe promotion ID. - promotionLevel
-
Type:
stringThe promotion level. - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion.
Nested Schema : items
Type:
object- id
-
Type:
stringThe ID of the dynamic property. - label
-
Type:
stringThe label of the dynamic property. - value
-
Type:
stringThe value of the dynamic property.
Nested Schema : items
Type:
object- giftWithPurchaseDetail
-
Type:
stringString identifying the free gift, usually the repository id of the gift type. - giftWithPurchaseIdentifier
-
Type:
integerAn identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - giftWithPurchaseQuantityAvailableForSelection
-
Type:
numbergift quantity available for selection - giftWithPurchaseType
-
Type:
stringThe type of the gift. (sku, product) - promotionId
-
Type:
stringThe gift with purchase promotion id
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
booleanFlag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
integerAn identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - failedQuantity
-
Type:
numberThe amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site. - giftDetail
-
Type:
stringString identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
stringThe type of the gift. (sku, product) - key
-
Type:
stringatg.gwp - quantity
-
Type:
numberThe total quantity of sku for this gift selection. - removedQuantity
-
Type:
numberThe amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integerThe quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
numberThe quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
stringThe gift with purchase promotion id
Nested Schema : items
Type:
object- amount
-
Type:
numberAmount authorized from the payment group. - balance
-
Type:
numberTotal available balance on the gift card. - gatewayName
-
Type:
stringPayment gateway name. e.g. chaseCreditCard. - giftCardNumber
-
Type:
stringGift card number. - isAmountRemaining
-
Type:
booleanA boolean to decide if more payment can be made from this payment group. - maskedCardNumber
-
Type:
stringMasked gift card number. - paymentGroupId
-
Type:
stringPayment group ID. - paymentMethod
-
Type:
stringPayment method. e.g. physicalGiftCard/ creditCard. - paymentState
-
Type:
stringThe state of the payment group. e.g. AUTHORIZED. - uiIntervention
-
Type:
stringThis decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : giftWithPurchaseMessages
Nested Schema : items
Type:
object- identifier
-
Type:
stringThe pricing message identifier. - params
-
Type:
arrayparamsAdditional Properties Allowed:The list of all message parameters. - priority
-
Type:
integerThe pricing message priority. - summary
-
Type:
stringThe pricing message summary. - type
-
Type:
stringThe pricing message type.
Nested Schema : params
Nested Schema : items
Type:
object- promotionId
-
Type:
stringThe promotion id.
Nested Schema : errorInfo
Nested Schema : notes
Nested Schema : items
Type:
object- profileId
-
Type:
stringthe profile id of the user - profileType
-
Type:
stringthe profile type of the user that requested the quote - requestDate/quoteDate/rejectionDate
-
Type:
numberthe request/quote/rejection date for the note - requesterNote/providerNote/rejectionNote
-
Type:
stringthe requester/provider/rejection note
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's total e.g. Monthly. - total
-
Type:
stringThe total amount for the frequency.
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's tax e.g. Monthly. - tax
-
Type:
stringThe tax amount for the frequency.
Nested Schema : items
Type:
object- items
-
Type:
arrayitemsAdditional Properties Allowed:The array of products in the shipping group. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:The price information. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address details. - shippingMethod
-
Type:
objectshippingMethodAdditional Properties Allowed:The shipping method details for the order. - surcharge
-
Type:
numberThe shipping surcharge. - trackingInfo
-
Type:
arraytrackingInfoAdditional Properties Allowed:Tracking Information for the Order. - trackingNumber
-
Type:
stringThe tracking number.
Nested Schema : items
Nested Schema : priceInfo
Type:
objectThe price information.
- amount
-
Type:
numberThe total order amount. - currencyCode
-
Type:
stringThe currency code. - shipping
-
Type:
numberThe total shipping cost. - shippingSurchargeValue
-
Type:
numberExtra handling costs for shipping the products. - subTotal
-
Type:
numberSub-total. - tax
-
Type:
numberThe total tax amount. - total
-
Type:
numberThe order total.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - frequencyAmountTotals
-
Type:
arrayfrequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
arrayfrequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - shipping
-
Type:
numberCost of shipping the product. - subTotal
-
Type:
numberThe sub-total price of the recurring charge. - tax
-
Type:
numberMonetary tax amount. - total
-
Type:
numberThe total price of the recurring charge. - totalWithoutTax
-
Type:
numberTotal of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
- address1
-
Type:
stringAddress snippet. - address2
-
Type:
stringAddress snippet. - address3
-
Type:
stringAddress snippet. - alias
-
Type:
stringAddress alias. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringCounty. -
Type:
stringEmail address. - faxNumber
-
Type:
stringFax number. - firstName
-
Type:
stringFirst name - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringName prefix. - selectedCountry
-
Type:
stringCountry code. - selectedState
-
Type:
stringState code. - state
-
Type:
stringState. - state_ISOCode
-
Type:
stringState ISO code. - suffix
-
Type:
stringName suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
- cost
-
Type:
numberThe total cost of shipping. - shippingMethodDescription
-
Type:
stringThe description of the shipping method. - shippingTax
-
Type:
numberThe shipping tax. - value
-
Type:
stringThe shipping method applied to the order.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - active
-
Type:
booleanactive or not. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringThe category to which the product belongs. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountInfo
-
Type:
arraydiscountInfoAdditional Properties Allowed:The discount information. - displayName
-
Type:
stringThe name of the product. - dynamicProperties
-
Type:
arraydynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly. - price
-
Type:
integerThe actual price of the product. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product in the shipping group. - rawTotalPrice
-
Type:
integerThe raw price of the product. - recurringCharge
-
Type:
numberThe recurring charge for the item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
integerThe unit price of the product. - variant
-
Type:
arrayvariantAdditional Properties Allowed:List of variants for the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe monetary amount for the recurring charge. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - tax
-
Type:
numberMonetary tax amount.
Nested Schema : discountInfo
Nested Schema : dynamicProperties
Nested Schema : externalData
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- coupon
-
Type:
stringThe coupon ID. - promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringThe promotion ID. - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion.
Nested Schema : items
Type:
object- id
-
Type:
stringThe ID of the dynamic property. - label
-
Type:
stringThe label of the dynamic property. - value
-
Type:
stringThe value of the dynamic property.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe variant option name. - optionValue
-
Type:
stringThe variant option value.
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's total e.g. Monthly. - total
-
Type:
stringThe total amount for the frequency.
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's tax e.g. Monthly. - tax
-
Type:
stringThe tax amount for the frequency.
Nested Schema : items
Type:
object- carrierId
-
Type:
stringCarrier Id for Tracking. - carrierName
-
Type:
stringCarrier Name for Tracking. - carrierUrl
-
Type:
stringCarrier URL for Tracking. - trackingNumber
-
Type:
stringTracking Number.
Nested Schema : items
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringThe category to which the product belongs. - childItems
-
Type:
arraychildItemsAdditional Properties Allowed:The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself. - commerceItemId
-
Type:
stringThe unique line item ID distinguisher. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountInfo
-
Type:
arraydiscountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
arraydynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
numberA price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable). - externalPriceQuantity
-
Type:
integerThe maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). - externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly. - giftWithPurchaseCommerceItemMarkers
-
Type:
arraygiftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:The array of giftWithPurchaseCommerceItemMarkers. - id
-
Type:
stringRepository id of the commerce item. - price
-
Type:
integerThe actual price of the product. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product. - recurringCharge
-
Type:
numberThe recurring charge for the item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item. - skuProperties
-
Type:
arrayskuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
integerThe unit price of the product. - variant
-
Type:
arrayvariantAdditional Properties Allowed:List of variants for the product.
Nested Schema : childItems
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe monetary amount for the recurring charge. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - tax
-
Type:
numberMonetary tax amount.
Nested Schema : discountInfo
Nested Schema : dynamicProperties
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - amount
-
Type:
integerThe total amount of this item including its child items amounts. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - billingAccountId
-
Type:
stringThe billing account ID associated to the current item. - catRefId
-
Type:
stringskuid of the item. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - displayName
-
Type:
stringThe name of the product. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
numberA price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable). - externalPriceQuantity
-
Type:
integerThe maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). - externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly. - id
-
Type:
stringRepository id of the commerce item. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product. - rawTotalPrice
-
Type:
integerThe raw price of the product. - recurringCharge
-
Type:
numberThe recurring charge for the item. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item. - unitPrice
-
Type:
integerThe unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe monetary amount for the recurring charge. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - tax
-
Type:
numberMonetary tax amount.
Nested Schema : externalData
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- coupon
-
Type:
stringThe coupon ID. - giftWithPurchaseDiscountInfo
-
Type:
arraygiftWithPurchaseDiscountInfoAdditional Properties Allowed:The gift information. - promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringThe promotion ID. - promotionLevel
-
Type:
stringThe promotion level. - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion. - totalAdjustment
-
Type:
numberTotal adjustment by the promotion.
Nested Schema : giftWithPurchaseDiscountInfo
Nested Schema : items
Type:
object- giftWithPurchaseChoicesAvailable
-
Type:
booleanIf this gift with purchase has multiple gift choices. - giftWithPurchaseIdentifier
-
Type:
integerThe gift hash code for this gift with purchase promotion. - giftWithPurchaseQuantity
-
Type:
numberThe quantity that is gift quantity
Nested Schema : items
Type:
object- id
-
Type:
stringThe ID of the dynamic property. - label
-
Type:
stringThe label of the dynamic property. - value
-
Type:
stringThe value of the dynamic property.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringThe name to be associated with the externalData item. - values
-
Type:
objectvaluesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object- automaticQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integerThe gift hash code for this gift with purchase promotion. - key
-
Type:
stringatg.gwp - remainingQuantity
-
Type:
numberThe quantity of the commerce item that is not affected by gift with purchase. - selectedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
numberThe quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
stringThe gift with purchase promotion id.
Nested Schema : items
Type:
object- id
-
Type:
stringID of the Dynamic SKU Property. - name
-
Type:
stringName of the Dynamic SKU Property. - propertyType
-
Type:
stringType that indicates whether it is a base or a custom SKU property, - value
-
Type:
stringValue of the Dynamic SKU Property.
Nested Schema : items
Type:
object- optionName
-
Type:
stringThe variant option name. - optionValue
-
Type:
stringThe variant option value.
Nested Schema : items
Type:
object- carrierId
-
Type:
stringCarrier Id for Tracking. - carrierName
-
Type:
stringCarrier Name for Tracking. - carrierUrl
-
Type:
stringCarrier URL for Tracking. - trackingNumber
-
Type:
stringTracking Number.
Example application/json
{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":3.49,
"amount":9.96,
"valueAddedTax":0,
"countyTax":2.49,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":3.98,
"countryTax":0
},
"shippingMethod":{
"shippingTax":1.05,
"cost":10.5,
"value":"twoDay",
"shippingMethodDescription":"Two Days"
},
"shippingGroupId":"sg10047",
"submittedDate":null,
"priceInfo":{
"amount":89,
"total":109.46,
"shipping":10.5,
"shippingSurchargeValue":0,
"tax":9.96,
"subTotal":89,
"currencyCode":"USD",
"totalWithoutTax":99.5
},
"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":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"h",
"country":"US",
"address3":"",
"address2":"A2",
"city":"C1",
"address1":"A1",
"prefix":"",
"companyName":"",
"postalCode":"36123",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"h",
"phoneNumber":"34534533",
"alias":"Address##1",
"faxNumber":"",
"middleName":"",
"state":"AL",
"email":"h@h.com"
},
"trackingNumber":null,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_AviatorSunglasses_full.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":89,
"returnedQuantity":0,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"displayName":"Aviator Sunglasses",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"commerceItemId":"ci3000411",
"assetId":"asset10001",
"price":89,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"onSale":false,
"primaryImageAltText":"Aviator Sunglasses",
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"serviceAccountId":"serviceAcc-123",
"unitPrice":89,
"primaryImageTitle":"Aviator Sunglasses",
"quantity":1,
"productId":"prod20006",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":89,
"quantity":1,
"tax":8.91,
"orderDiscountShare":0,
"detailedUnitPrice":89,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"active":true,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40105",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/aviator-sunglasses/product/prod20006",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"listPrice":89,
"recurringCharge":10,
"status":"INITIAL"
}
],
"status":"INITIAL"
}
],
"creationTime":1.419259052037E12,
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"cost":10.5,
"value":"twoDay"
},
"payments":[
{
"paymentGroupId":"pg70442",
"amount":109.46,
"gatewayName":"chaseCreditCard",
"uiIntervention":null,
"paymentMethod":"creditCard",
"isAmountRemaining":true,
"paymentState":"AUTHORIZED"
}
],
"creationDate":"2014-12-22T14:37:32.037Z",
"orderProfileId":"110484",
"uuid":"09e8eb24-734d-4cda-b3b5-b57edd178c75",
"priceInfo":{
"amount":89,
"total":109.46,
"shipping":10.5,
"shippingSurchargeValue":20,
"tax":9.96,
"subTotal":89,
"currencyCode":"USD"
},
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"orderDiscount":0,
"orderDiscountDescList":[
{
"promotionLevel":"item",
"coupon":"FREETATTOO",
"totalAdjustment":"-21.99",
"promotionDesc":"Explicit Item Discount - FREETATTOO",
"promotionId":"explicitItemFreeDiscount"
}
],
"shippingDiscount":0
},
"pricingMessages":{
"giftWithPurchaseMessages":[
{
"summary":"The cart has qualified for a free gift promotion.",
"identifier":"GWPQualified",
"params":"[]",
"type":"information",
"priority":"-10"
}
]
},
"trackingInfo":[
],
"shoppingCart":{
"items":[
{
"unitPrice":89,
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod20006",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"externalData":[
],
"billingAccountId":"billingAcc-123",
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40105",
"commerceItemId":"ci3000411",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"discountInfo":[
],
"customerAccountId":"customerAcc-123",
"price":89,
"assetId":"asset10001",
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"recurringCharge":10
}
]
},
"shippingAddress":{
"lastName":"h",
"country":"US",
"address3":null,
"address2":"A2",
"city":"C1",
"address1":"A1",
"prefix":null,
"companyName":null,
"postalCode":"36123",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"h",
"phoneNumber":"34534533",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"AL",
"email":"h@h.com"
},
"id":"o10003",
"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 error response
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Request:
{
"isAnonymousCheckout": false,
"visitId": "27c79ed0-384f-4658-824d-c5b8518bfde0",
"appliedPromotions": ["explicitItemFreeDiscount"],
"shippingMethod": {"value": "twoDay"},
"payments": [{
"cardCVV": "123",
"nameOnCard": "test",
"cardTypeName": "Visa",
"cardType": "visa",
"endMonth": "02",
"type": "card",
"endYear": 2018,
"cardNumber": "4055011111111111"
}],
"shoppingCart": {
"coupons": [{
"code": "FREETATTOO",
"level": "item",
"description": "Explicit Item Discount - FREETATTOO",
"id": "explicitItemFreeDiscount",
"totalAdjustment": "-21.99",
"status": "claimed"
}],
"items": [{
"serviceAccountId": "serviceAcc-123",
"deactivationDate": "2018-06-27T12:59:59Z",
"quantity": 1,
"dynamicPropertyMode": "pickup",
"productId": "prod20006",
"externalRecurringCharge": 10,
"giftWithPurchaseCommerceItemMarkers": [],
"externalData": [],
"billingAccountId": "billingAcc-123",
"externalRecurringChargeFrequency": "Monthly",
"catRefId": "sku40105",
"externalRecurringChargeDuration": "12",
"customerAccountId": "customerAcc-123",
"assetId": "asset10001",
"actionCode": "Add",
"detailedRecurringChargeInfo": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"activationDate": "2017-06-27T15:30:00Z",
"serviceId": "service-123",
"recurringCharge": 10
}],
"orderTotal": 109.46
},
"shippingAddress": {
"lastName": "h",
"country": "United States",
"address3": "",
"address2": "A2",
"city": "C1",
"prefix": "",
"address1": "A1",
"defaultCountryCode": null,
"postalCode": "36123",
"jobTitle": "",
"companyName": "",
"county": "",
"suffix": "",
"selectedCountry": "US",
"firstName": "h",
"phoneNumber": "34534533",
"faxNumber": "",
"alias": "",
"middleName": "",
"state": "Alabama",
"selectedState": "AL",
"email": "h@h.com",
"state_ISOCode": "US-AL"
},
"id": "o10003",
"billingAddress": {
"lastName": "Test",
"country": "United States",
"address3": "",
"address2": "Line 2",
"city": "Montgomery",
"prefix": "",
"address1": "Line 1",
"postalCode": "36123",
"jobTitle": "",
"companyName": "",
"county": "",
"suffix": "",
"selectedCountry": "US",
"firstName": "Steve",
"phoneNumber": "45454545",
"faxNumber": "",
"alias": "",
"middleName": "",
"state": "Alabama",
"selectedState": "AL",
"state_ISOCode": "US-AL"
},
"dynamicPropertyShippingInstructions": "Test Instructions",
"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"
}],
"visitorId": "-6820098066093706883"
}
Sample Response Payload returned by endpoint:
{
"shippingGroups": [{
"taxPriceInfo": {
"cityTax": 3.49,
"amount": 9.96,
"valueAddedTax": 0,
"countyTax": 2.49,
"isTaxIncluded": false,
"miscTax": 0,
"districtTax": 0,
"stateTax": 3.98,
"countryTax": 0
},
"shippingMethod": {
"shippingTax": 1.05,
"cost": 10.5,
"value": "twoDay",
"shippingMethodDescription": "Two Days"
},
"shippingGroupId": "sg10047",
"submittedDate": null,
"priceInfo": {
"amount": 89,
"total": 109.46,
"shipping": 10.5,
"shippingSurchargeValue": 0,
"tax": 9.96,
"subTotal": 89,
"currencyCode": "USD",
"totalWithoutTax": 99.5
},
"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": []
},
"shipOnDate": null,
"trackingInfo": [],
"actualShipDate": null,
"shippingAddress": {
"lastName": "h",
"country": "US",
"address3": "",
"address2": "A2",
"city": "C1",
"address1": "A1",
"prefix": "",
"companyName": "",
"postalCode": "36123",
"jobTitle": "",
"county": "",
"suffix": "",
"firstName": "h",
"phoneNumber": "34534533",
"alias": "Address##1",
"faxNumber": "",
"middleName": "",
"state": "AL",
"email": "h@h.com"
},
"trackingNumber": null,
"items": [{
"primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_AviatorSunglasses_full.jpg&height=100&width=100",
"deactivationDate": "2018-06-27T12:59:59Z",
"rawTotalPrice": 89,
"returnedQuantity": 0,
"dynamicProperties": [{
"id": "dynamicPropertyMode",
"label": "Mode",
"value": "pickup"
}],
"displayName": "Aviator Sunglasses",
"shippingSurchargeValue": 0,
"discountAmount": 0,
"externalData": [],
"billingAccountId": "billingAcc-123",
"commerceItemId": "ci3000411",
"assetId": "asset10001",
"price": 89,
"variant": [
{
"optionValue": "Blue",
"optionName": "Color"
},
{
"optionValue": "Medium",
"optionName": "Size"
}
],
"onSale": false,
"primaryImageAltText": "Aviator Sunglasses",
"actionCode": "Add",
"serviceId": "service-123",
"stateDetailsAsUser": "The item has been initialized within the shipping group",
"serviceAccountId": "serviceAcc-123",
"unitPrice": 89,
"primaryImageTitle": "Aviator Sunglasses",
"quantity": 1,
"productId": "prod20006",
"salePrice": 0,
"detailedItemPriceInfo": [{
"discounted": false,
"amount": 89,
"quantity": 1,
"tax": 8.91,
"orderDiscountShare": 0,
"detailedUnitPrice": 89,
"currencyCode": "USD"
}],
"externalRecurringCharge": 10,
"active": true,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12",
"catRefId": "sku40105",
"skuProperties": [{
"propertyType": "sku-base",
"name": "UPC Code",
"id": "upcCode",
"value": "123456"
}],
"customerAccountId": "customerAcc-123",
"discountInfo": [],
"route": "/aviator-sunglasses/product/prod20006",
"detailedRecurringChargeInfo": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"activationDate": "2017-06-27T15:30:00Z",
"listPrice": 89,
"recurringCharge": 10,
"status": "INITIAL"
}],
"status": "INITIAL"
}],
"creationTime": 1419259052037,
"sourceSystem": "Cloud Commerce",
"dynamicProperties": [{
"id": "dynamicPropertyShippingInstructions",
"label": "Shipping Instructions",
"value": "Test Instructions"
}],
"approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
"shippingMethod": {
"cost": 10.5,
"value": "twoDay"
},
"payments": [{
"paymentGroupId": "pg70442",
"amount": 109.46,
"gatewayName": "chaseCreditCard",
"uiIntervention": null,
"paymentMethod": "creditCard",
"isAmountRemaining": true,
"paymentState": "AUTHORIZED"
}],
"creationDate": "2014-12-22T14:37:32.037Z",
"orderProfileId": "110484",
"uuid": "09e8eb24-734d-4cda-b3b5-b57edd178c75",
"priceInfo": {
"amount": 89,
"total": 109.46,
"shipping": 10.5,
"shippingSurchargeValue": 20,
"tax": 9.96,
"subTotal": 89,
"currencyCode": "USD"
},
"recurringChargePriceInfo": {
"amount": 30,
"total": 32.4,
"shipping": 0,
"subTotalByFrequency": [{
"amount": 30,
"frequency": "Monthly"
}],
"taxByFrequency": [{
"amount": 2.4,
"frequency": "Monthly"
}],
"tax": 2.4,
"subTotal": 30,
"currencyCode": "USD",
"totalWithoutTax": 30
},
"discountInfo": {
"orderDiscount": 0,
"orderDiscountDescList": [{
"promotionLevel": "item",
"coupon": "FREETATTOO",
"totalAdjustment": "-21.99",
"promotionDesc": "Explicit Item Discount - FREETATTOO",
"promotionId": "explicitItemFreeDiscount"
}],
"shippingDiscount": 0
},
"pricingMessages": {"giftWithPurchaseMessages": [{
"summary": "The cart has qualified for a free gift promotion.",
"identifier": "GWPQualified",
"params": "[]",
"type": "information",
"priority": "-10"
}]},
"trackingInfo": [],
"shoppingCart": {"items": [{
"unitPrice": 89,
"serviceAccountId": "serviceAcc-123",
"deactivationDate": "2018-06-27T12:59:59Z",
"quantity": 1,
"productId": "prod20006",
"dynamicProperties": [{
"id": "dynamicPropertyMode",
"label": "Mode",
"value": "pickup"
}],
"externalRecurringCharge": 10,
"giftWithPurchaseCommerceItemMarkers": [],
"externalData": [],
"billingAccountId": "billingAcc-123",
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12",
"catRefId": "sku40105",
"commerceItemId": "ci3000411",
"skuProperties": [{
"propertyType": "sku-base",
"name": "UPC Code",
"id": "upcCode",
"value": "123456"
}],
"discountInfo": [],
"customerAccountId": "customerAcc-123",
"price": 89,
"assetId": "asset10001",
"variant": [
{
"optionValue": "Blue",
"optionName": "Color"
},
{
"optionValue": "Medium",
"optionName": "Size"
}
],
"detailedRecurringChargeInfo": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"activationDate": "2017-06-27T15:30:00Z",
"serviceId": "service-123",
"recurringCharge": 10
}]},
"shippingAddress": {
"lastName": "h",
"country": "US",
"address3": null,
"address2": "A2",
"city": "C1",
"address1": "A1",
"prefix": null,
"companyName": null,
"postalCode": "36123",
"jobTitle": null,
"county": null,
"suffix": null,
"firstName": "h",
"phoneNumber": "34534533",
"faxNumber": null,
"alias": null,
"middleName": null,
"state": "AL",
"email": "h@h.com"
},
"id": "o10003",
"quoteInfo": {
"providerNote": null,
"notes": [{
"profileType": null,
"profileId": "120213",
"requestDate": 1477479521002,
"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"
}]
}