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:
string
Required:true
The ID of order to update.
Header Parameters
- X-CCOrganization
-
Type:
string
Current 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:
array
appliedPromotionsAdditional Properties Allowed:The array of applied promotions. - billingAddress
-
Type:
object
billingAddressAdditional Properties Allowed:The billing address details. - combineLineItems
-
Type:
string
Value to determine if line items are to be combined. Can be yes or no. - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersAdditional Properties Allowed:giftWithPurchaseOrderMarker information. Required if giftWithPurchaseOrderMarker information is present. - isAnonymousCheckout
-
Type:
boolean
Returns false if the order is for a logged-in user. - payments
-
Type:
array
paymentsAdditional Properties Allowed:Payment details to update the order. - shippingAddress
-
Type:
object
shippingAddressRequired:true
Additional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
array
shippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
object
shippingMethodRequired:true
Additional Properties Allowed:The shipping method details for the order. - shoppingCart
-
Type:
object
shoppingCartRequired:true
Additional Properties Allowed:The shopping cart contents of the current order.
Nested Schema : appliedPromotions
Nested Schema : billingAddress
Type:
object
The billing address details.
- address1
-
Type:
string
Required:true
Address snippet. - address2
-
Type:
string
Address snippet. - address3
-
Type:
string
Address snippet. - alias
-
Type:
string
Address alias. - city
-
Type:
string
Required:true
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Required:true
Country. - county
-
Type:
string
County. - faxNumber
-
Type:
string
Fax number. - firstName
-
Type:
string
Required:true
First name. - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Required:true
Last name. - middleName
-
Type:
string
Middle name. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Required:true
Postal code. - prefix
-
Type:
string
Name prefix. - selectedCountry
-
Type:
string
Required:true
Country code. - selectedState
-
Type:
string
Required:true
State code. - state
-
Type:
string
Required:true
State. - state_ISOCode
-
Type:
string
Required:true
State ISO code. - suffix
-
Type:
string
Name suffix.
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Nested Schema : shippingAddress
Type:
object
The shipping address details.
- address1
-
Type:
string
Required:true
Address snippet. - address2
-
Type:
string
Address snippet. - address3
-
Type:
string
Address snippet. - alias
-
Type:
string
Address alias. - city
-
Type:
string
Required:true
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Required:true
Country. - county
-
Type:
string
County. -
Type:
string
Required:true
Email address. - faxNumber
-
Type:
string
Fax number. - firstName
-
Type:
string
Required:true
First name. - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Required:true
Last name. - middleName
-
Type:
string
Middle name. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Required:true
Postal code. - prefix
-
Type:
string
Name prefix. - selectedCountry
-
Type:
string
Required:true
Country code. - selectedState
-
Type:
string
Required:true
State code. - state
-
Type:
string
Required:true
State. - state_ISOCode
-
Type:
string
Required:true
State ISO code. - suffix
-
Type:
string
Name suffix.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
- value
-
Type:
string
Required:true
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
object
The shopping cart contents of the current order.
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
Required:true
The quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
boolean
Required:true
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
integer
Required:true
An 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:
number
Required:true
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site. - giftDetail
-
Type:
string
Required:true
String identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
string
Required:true
The type of the gift. (sku, product) - key
-
Type:
string
Required:true
atg.gwp - quantity
-
Type:
number
Required:true
The total quantity of sku for this gift selection. - removedQuantity
-
Type:
number
Required:true
The amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integer
Required:true
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
number
Required:true
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order. - value
-
Type:
string
Required:true
The gift with purchase promotion id
Nested Schema : items
Type:
object
- amount
-
Type:
number
Amount to be authorized from the gift card. Payment type:invoice,card, physicalGiftCard, paypalCheckout, payUWebLatamCheckout. - cardCVV
-
Type:
string
Credit/Debit card secret pin. Payment type:card. - cardNumber
-
Type:
string
Credit/Debit card number used for payment. Payment type:card. - cardType
-
Type:
string
Credit/Debit card type. e.g. visa. Payment type:card. - cardTypeName
-
Type:
string
Credit/Debit card type name. e.g. Visa. Payment type:card. - endMonth
-
Type:
string
Credit/Debit card expiry month. Payment type:card. - endYear
-
Type:
string
Credit/Debit card expiry year. Payment type:card. - giftCardNumber
-
Type:
string
Gift card number used for payment. Payment type:physicalGiftCard. - giftCardPin
-
Type:
string
Gift card pin. Payment type:physicalGiftCard. - nameOnCard
-
Type:
string
Name on the credit/debit card. Payment type:card. - PayerID
-
Type:
string
Payer ID relevant to paypal checkout type. Payment type:paypalCheckout. - paymentGroupId
-
Type:
string
Payment Group Id of the gift card payment group. Payment type:physicalGiftCard. - paymentId
-
Type:
string
Payment ID relevant to the payment type. Payment type:paypalCheckout, payUWebLatamCheckout. - PONumber
-
Type:
string
Purchase order number. Pament type:invoice - type
-
Type:
string
Required:true
Payment type. e.g. paypalCheckout, payUWebLatamCheckout.
Nested Schema : items
Type:
object
- items
-
Type:
array
itemsRequired:true
Additional Properties Allowed:The array of products in the shipping group. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address details. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:The shipping method details for the order.
Nested Schema : items
Nested Schema : shippingAddress
Type:
object
The shipping address details.
- address1
-
Type:
string
Address snippet. - address2
-
Type:
string
Address snippet. - address3
-
Type:
string
Address snippet. - alias
-
Type:
string
Address alias. - city
-
Type:
string
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Country. - county
-
Type:
string
County. -
Type:
string
Email address. - faxNumber
-
Type:
string
Fax number. - firstName
-
Type:
string
First name - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Last name. - middleName
-
Type:
string
Middle name. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Postal code. - prefix
-
Type:
string
Name prefix. - selectedCountry
-
Type:
string
Country code. - selectedState
-
Type:
string
State code. - state
-
Type:
string
State. - state_ISOCode
-
Type:
string
State ISO code. - suffix
-
Type:
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
- value
-
Type:
string
The shipping method applied to the order.
Nested Schema : items
Type:
object
- catRefId
-
Type:
string
Required:true
The category to which the product belongs. - commerceItemId
-
Type:
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no. - productId
-
Type:
string
Required:true
ID of the product in the cart. - quantity
-
Type:
integer
Required:true
The quantity of the product in the shipping group.
Nested Schema : coupons
Nested Schema : items
Nested Schema : items
Type:
object
- code
-
Type:
string
Required:true
The coupon code. - description
-
Type:
string
The coupon description. - id
-
Type:
string
Required:true
The coupon ID. - level
-
Type:
string
Required:true
The level of the coupon (whether the coupon is item level, etc). - status
-
Type:
string
Required:true
The current status of the coupon.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Required:true
The category to which the product belongs. - childItems
-
Type:
array
childItemsAdditional 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:
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no. - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
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
-
Type:
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
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in. - productId
-
Type:
string
Required:true
ID of the product in the cart. - quantity
-
Type:
integer
Required:true
The quantity of the product in the cart. - recurringCharge
-
Type:
number
The recurring charge for the item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : childItems
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
- amount
-
Type:
number
The monetary amount for the recurring charge. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - orderDiscountShare
-
Type:
number
The order Discount Share. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - tax
-
Type:
number
Monetary tax amount.
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : items
Type:
object
- activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Required:true
Sku reference id. - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
Required:true
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
-
Type:
integer
Required:true
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
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly. - productId
-
Type:
string
Required:true
ID of the product in the cart. - quantity
-
Type:
integer
Required:true
The quantity of the product in the cart. - recurringCharge
-
Type:
number
The recurring charge for the item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
- amount
-
Type:
number
The monetary amount for the recurring charge. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - orderDiscountShare
-
Type:
number
The order Discount Share. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - tax
-
Type:
number
Monetary tax amount.
Nested Schema : externalData
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
Required:true
The quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integer
Required:true
The gift hash code for this gift with purchase promotion. - key
-
Type:
string
Required:true
atg.gwp - remainingQuantity
-
Type:
number
Required:true
The quantity of the commerce item that is not affected by gift with purchase. - selectedQuantity
-
Type:
number
Required:true
The quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
number
Required:true
The quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
string
Required:true
The 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:
array
approvalSystemMessagesAdditional Properties Allowed:An array of approval messages when order going in pending approval state - creationDate
-
Type:
string
The creation date in ISO format. - creationTime
-
Type:
number
The creation time in long seconds. - discountInfo
-
Type:
object
discountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Read-only list of dynamic properties for the order along with meta-data. - giftWithPurchaseInfo
-
Type:
array
giftWithPurchaseInfoAdditional Properties Allowed:The gift information. - giftWithPurchaseOrderMarkers
-
Type:
array
giftWithPurchaseOrderMarkersAdditional Properties Allowed:giftWithPurchaseOrderMarker information - id
-
Type:
string
The order ID. - payments
-
Type:
array
paymentsAdditional Properties Allowed:Payment details for the order, including additional properties specific to the payment type. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:The price information. - pricingMessages
-
Type:
object
pricingMessagesAdditional Properties Allowed:The Pricing messages information. - quoteInfo
-
Type:
object
quoteInfoAdditional Properties Allowed:the quote information of the order - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address details. - shippingGroups
-
Type:
array
shippingGroupsAdditional Properties Allowed:The shipping groups for the order. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:The shipping method details for the order. - shoppingCart
-
Type:
object
shoppingCartAdditional Properties Allowed:The shopping cart contents of the current order. - sourceSystem
-
Type:
string
The system where the order originated. - trackingInfo
-
Type:
array
trackingInfoAdditional Properties Allowed:Tracking Information for the Order. - uuid
-
Type:
string
The unique ID for the order.
Nested Schema : approvalSystemMessages
Type:
array
An array of approval messages when order going in pending approval state
-
Type:
string
Nested Schema : discountInfo
Type:
object
The discount information.
- orderDiscount
-
Type:
integer
The order discount. - orderDiscountDescList
-
Type:
array
orderDiscountDescListAdditional Properties Allowed:The list of all the order discounts. - shippingDiscount
-
Type:
integer
The shipping discount.
Nested Schema : dynamicProperties
Nested Schema : giftWithPurchaseInfo
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Nested Schema : priceInfo
Type:
object
The price information.
- amount
-
Type:
number
The total order amount. - currencyCode
-
Type:
string
The currency code. - shipping
-
Type:
number
The total shipping cost. - shippingSurchargeValue
-
Type:
number
Extra handling costs for shipping the products. - subTotal
-
Type:
number
Sub-total. - tax
-
Type:
number
The total tax amount. - total
-
Type:
number
The order total.
Nested Schema : pricingMessages
Type:
object
The Pricing messages information.
- giftWithPurchaseMessages
-
Type:
array
giftWithPurchaseMessagesAdditional Properties Allowed:The gift with purchase messages information.
Nested Schema : quoteInfo
Type:
object
the quote information of the order
- errorInfo
-
Type:
array
errorInfoAdditional Properties Allowed:the array of errors, if any - expirationDate
-
Type:
string
the expiration date of the quoted order, if any - externalId
-
Type:
string
the external id for the quote - notes
-
Type:
array
notesAdditional Properties Allowed:the notes (history) for the order - providerNote
-
Type:
string
the provider note for the quoted order - quoteDate
-
Type:
number
the date the order was quoted in milliseconds - rejectionDate
-
Type:
string
rejection date of the quoted order - rejectionNote
-
Type:
string
the rejection note for an order whose quote has been rejected by user - requestDate
-
Type:
string
the date when the quote was requested in ISO format
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - frequencyAmountTotals
-
Type:
array
frequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
array
frequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - shipping
-
Type:
number
Cost of shipping the product. - subTotal
-
Type:
number
The sub-total price of the recurring charge. - tax
-
Type:
number
Monetary tax amount. - total
-
Type:
number
The total price of the recurring charge. - totalWithoutTax
-
Type:
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
object
The shipping address details.
- address1
-
Type:
string
Address snippet. - address2
-
Type:
string
Address snippet. - address3
-
Type:
string
Address snippet. - alias
-
Type:
string
Address alias. - city
-
Type:
string
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Country. - county
-
Type:
string
County. -
Type:
string
Email address. - faxNumber
-
Type:
string
Fax number. - firstName
-
Type:
string
First name - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Last name. - middleName
-
Type:
string
Middle name. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Postal code. - prefix
-
Type:
string
Name prefix. - selectedCountry
-
Type:
string
Country code. - selectedState
-
Type:
string
State code. - state
-
Type:
string
State. - state_ISOCode
-
Type:
string
State ISO code. - suffix
-
Type:
string
Name suffix.
Nested Schema : shippingGroups
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
- cost
-
Type:
number
The total cost of shipping. - value
-
Type:
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
object
The shopping cart contents of the current order.
- items
-
Type:
array
itemsAdditional Properties Allowed:The array of products in the shopping cart.
Nested Schema : trackingInfo
Nested Schema : orderDiscountDescList
Nested Schema : items
Type:
object
- coupon
-
Type:
string
The coupon code. - promotionDesc
-
Type:
string
This field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
string
The promotion ID. - promotionLevel
-
Type:
string
The promotion level. - promotionLongDesc
-
Type:
string
The description of the promotion. - promotionName
-
Type:
string
The display name of the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - label
-
Type:
string
The label of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- giftWithPurchaseDetail
-
Type:
string
String identifying the free gift, usually the repository id of the gift type. - giftWithPurchaseIdentifier
-
Type:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - giftWithPurchaseQuantityAvailableForSelection
-
Type:
number
gift quantity available for selection - giftWithPurchaseType
-
Type:
string
The type of the gift. (sku, product) - promotionId
-
Type:
string
The gift with purchase promotion id
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of free sku for this gift selection that has already been auto added to the order. - autoRemove
-
Type:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies. - data
-
Type:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one. - failedQuantity
-
Type:
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
-
Type:
string
String identifying the free gift, usually the repository id of the gift type. - giftType
-
Type:
string
The type of the gift. (sku, product) - key
-
Type:
string
atg.gwp - quantity
-
Type:
number
The total quantity of sku for this gift selection. - removedQuantity
-
Type:
number
The amount of free quantity that has since been manually removed by a Shopper. - selectedQuantity
-
Type:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order. - targetedQuantity
-
Type:
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
-
Type:
string
The gift with purchase promotion id
Nested Schema : items
Type:
object
- amount
-
Type:
number
Amount authorized from the payment group. - balance
-
Type:
number
Total available balance on the gift card. - gatewayName
-
Type:
string
Payment gateway name. e.g. chaseCreditCard. - giftCardNumber
-
Type:
string
Gift card number. - isAmountRemaining
-
Type:
boolean
A boolean to decide if more payment can be made from this payment group. - maskedCardNumber
-
Type:
string
Masked gift card number. - paymentGroupId
-
Type:
string
Payment group ID. - paymentMethod
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard. - paymentState
-
Type:
string
The state of the payment group. e.g. AUTHORIZED. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : giftWithPurchaseMessages
Nested Schema : items
Type:
object
- identifier
-
Type:
string
The pricing message identifier. - params
-
Type:
array
paramsAdditional Properties Allowed:The list of all message parameters. - priority
-
Type:
integer
The pricing message priority. - summary
-
Type:
string
The pricing message summary. - type
-
Type:
string
The pricing message type.
Nested Schema : params
Nested Schema : items
Type:
object
- promotionId
-
Type:
string
The promotion id.
Nested Schema : errorInfo
Nested Schema : notes
Nested Schema : items
Type:
object
- profileId
-
Type:
string
the profile id of the user - profileType
-
Type:
string
the profile type of the user that requested the quote - requestDate/quoteDate/rejectionDate
-
Type:
number
the request/quote/rejection date for the note - requesterNote/providerNote/rejectionNote
-
Type:
string
the requester/provider/rejection note
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's total e.g. Monthly. - total
-
Type:
string
The total amount for the frequency.
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's tax e.g. Monthly. - tax
-
Type:
string
The tax amount for the frequency.
Nested Schema : items
Type:
object
- items
-
Type:
array
itemsAdditional Properties Allowed:The array of products in the shipping group. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:The price information. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address details. - shippingMethod
-
Type:
object
shippingMethodAdditional Properties Allowed:The shipping method details for the order. - surcharge
-
Type:
number
The shipping surcharge. - trackingInfo
-
Type:
array
trackingInfoAdditional Properties Allowed:Tracking Information for the Order. - trackingNumber
-
Type:
string
The tracking number.
Nested Schema : items
Nested Schema : priceInfo
Type:
object
The price information.
- amount
-
Type:
number
The total order amount. - currencyCode
-
Type:
string
The currency code. - shipping
-
Type:
number
The total shipping cost. - shippingSurchargeValue
-
Type:
number
Extra handling costs for shipping the products. - subTotal
-
Type:
number
Sub-total. - tax
-
Type:
number
The total tax amount. - total
-
Type:
number
The order total.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - frequencyAmountTotals
-
Type:
array
frequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
array
frequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - shipping
-
Type:
number
Cost of shipping the product. - subTotal
-
Type:
number
The sub-total price of the recurring charge. - tax
-
Type:
number
Monetary tax amount. - total
-
Type:
number
The total price of the recurring charge. - totalWithoutTax
-
Type:
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
object
The shipping address details.
- address1
-
Type:
string
Address snippet. - address2
-
Type:
string
Address snippet. - address3
-
Type:
string
Address snippet. - alias
-
Type:
string
Address alias. - city
-
Type:
string
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Country. - county
-
Type:
string
County. -
Type:
string
Email address. - faxNumber
-
Type:
string
Fax number. - firstName
-
Type:
string
First name - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Last name. - middleName
-
Type:
string
Middle name. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Postal code. - prefix
-
Type:
string
Name prefix. - selectedCountry
-
Type:
string
Country code. - selectedState
-
Type:
string
State code. - state
-
Type:
string
State. - state_ISOCode
-
Type:
string
State ISO code. - suffix
-
Type:
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
- cost
-
Type:
number
The total cost of shipping. - shippingMethodDescription
-
Type:
string
The description of the shipping method. - shippingTax
-
Type:
number
The shipping tax. - value
-
Type:
string
The shipping method applied to the order.
Nested Schema : trackingInfo
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - active
-
Type:
boolean
active or not. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
The category to which the product belongs. - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountInfo
-
Type:
array
discountInfoAdditional Properties Allowed:The discount information. - displayName
-
Type:
string
The name of the product. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly. - price
-
Type:
integer
The actual price of the product. - productId
-
Type:
string
ID of the product in the cart. - quantity
-
Type:
integer
The quantity of the product in the shipping group. - rawTotalPrice
-
Type:
integer
The raw price of the product. - recurringCharge
-
Type:
number
The recurring charge for the item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - skuProperties
-
Type:
array
skuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
integer
The unit price of the product. - variant
-
Type:
array
variantAdditional Properties Allowed:List of variants for the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
- amount
-
Type:
number
The monetary amount for the recurring charge. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - orderDiscountShare
-
Type:
number
The order Discount Share. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - tax
-
Type:
number
Monetary tax amount.
Nested Schema : discountInfo
Nested Schema : dynamicProperties
Nested Schema : externalData
Nested Schema : skuProperties
Nested Schema : variant
Nested Schema : items
Type:
object
- coupon
-
Type:
string
The coupon ID. - promotionDesc
-
Type:
string
This field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
string
The promotion ID. - promotionLongDesc
-
Type:
string
The description of the promotion. - promotionName
-
Type:
string
The display name of the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - label
-
Type:
string
The label of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- id
-
Type:
string
ID of the Dynamic SKU Property. - name
-
Type:
string
Name of the Dynamic SKU Property. - propertyType
-
Type:
string
Type that indicates whether it is a base or a custom SKU property, - value
-
Type:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The variant option name. - optionValue
-
Type:
string
The variant option value.
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's total e.g. Monthly. - total
-
Type:
string
The total amount for the frequency.
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's tax e.g. Monthly. - tax
-
Type:
string
The tax amount for the frequency.
Nested Schema : items
Type:
object
- carrierId
-
Type:
string
Carrier Id for Tracking. - carrierName
-
Type:
string
Carrier Name for Tracking. - carrierUrl
-
Type:
string
Carrier URL for Tracking. - trackingNumber
-
Type:
string
Tracking Number.
Nested Schema : items
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
The category to which the product belongs. - childItems
-
Type:
array
childItemsAdditional 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:
string
The unique line item ID distinguisher. - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - discountInfo
-
Type:
array
discountInfoAdditional Properties Allowed:The discount information. - dynamicProperties
-
Type:
array
dynamicPropertiesAdditional Properties Allowed:Array of custom properties at order line item level. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
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
-
Type:
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
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersAdditional Properties Allowed:The array of giftWithPurchaseCommerceItemMarkers. - id
-
Type:
string
Repository id of the commerce item. - price
-
Type:
integer
The actual price of the product. - productId
-
Type:
string
ID of the product in the cart. - quantity
-
Type:
integer
The quantity of the product. - recurringCharge
-
Type:
number
The recurring charge for the item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - skuProperties
-
Type:
array
skuPropertiesAdditional Properties Allowed:Sku properties Information - unitPrice
-
Type:
integer
The unit price of the product. - variant
-
Type:
array
variantAdditional Properties Allowed:List of variants for the product.
Nested Schema : childItems
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
- amount
-
Type:
number
The monetary amount for the recurring charge. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - orderDiscountShare
-
Type:
number
The order Discount Share. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - tax
-
Type:
number
Monetary 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:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - amount
-
Type:
integer
The total amount of this item including its child items amounts. - assetId
-
Type:
string
The asset ID corresponding to the current item. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
skuid of the item. - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
object
detailedRecurringChargeInfoAdditional Properties Allowed:Detailed Item Price Information. - displayName
-
Type:
string
The name of the product. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
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
-
Type:
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
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly. - id
-
Type:
string
Repository id of the commerce item. - productId
-
Type:
string
ID of the product in the cart. - quantity
-
Type:
integer
The quantity of the product. - rawTotalPrice
-
Type:
integer
The raw price of the product. - recurringCharge
-
Type:
number
The recurring charge for the item. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item. - unitPrice
-
Type:
integer
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
- amount
-
Type:
number
The monetary amount for the recurring charge. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - orderDiscountShare
-
Type:
number
The order Discount Share. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - tax
-
Type:
number
Monetary tax amount.
Nested Schema : externalData
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- coupon
-
Type:
string
The coupon ID. - giftWithPurchaseDiscountInfo
-
Type:
array
giftWithPurchaseDiscountInfoAdditional Properties Allowed:The gift information. - promotionDesc
-
Type:
string
This field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
string
The promotion ID. - promotionLevel
-
Type:
string
The promotion level. - promotionLongDesc
-
Type:
string
The description of the promotion. - promotionName
-
Type:
string
The display name of the promotion. - totalAdjustment
-
Type:
number
Total adjustment by the promotion.
Nested Schema : giftWithPurchaseDiscountInfo
Nested Schema : items
Type:
object
- giftWithPurchaseChoicesAvailable
-
Type:
boolean
If this gift with purchase has multiple gift choices. - giftWithPurchaseIdentifier
-
Type:
integer
The gift hash code for this gift with purchase promotion. - giftWithPurchaseQuantity
-
Type:
number
The quantity that is gift quantity
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - label
-
Type:
string
The label of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
The name to be associated with the externalData item. - values
-
Type:
object
valuesAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
object
- automaticQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing. - data
-
Type:
integer
The gift hash code for this gift with purchase promotion. - key
-
Type:
string
atg.gwp - remainingQuantity
-
Type:
number
The quantity of the commerce item that is not affected by gift with purchase. - selectedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper. - targetedQuantity
-
Type:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing. - value
-
Type:
string
The gift with purchase promotion id.
Nested Schema : items
Type:
object
- id
-
Type:
string
ID of the Dynamic SKU Property. - name
-
Type:
string
Name of the Dynamic SKU Property. - propertyType
-
Type:
string
Type that indicates whether it is a base or a custom SKU property, - value
-
Type:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
The variant option name. - optionValue
-
Type:
string
The variant option value.
Nested Schema : items
Type:
object
- carrierId
-
Type:
string
Carrier Id for Tracking. - carrierName
-
Type:
string
Carrier Name for Tracking. - carrierUrl
-
Type:
string
Carrier URL for Tracking. - trackingNumber
-
Type:
string
Tracking 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:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The 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" }] }