priceOrder
post
/ccstore/v1/orders/price
Price Order. Price 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.
Request
Supported Media Types
- application/json
Header Parameters
- X-CCOrganization
-
Type:
stringCurrent organization context of the logged in user
Body Parameter
Root Schema : priceOrder_request
{
"orderId":"o10001",
"shippingMethod":{
"value":"ground"
},
"payments":[
{
"amount":"100.0",
"giftCardNumber":"6035710988880101071",
"giftCardPin":"",
"type":"physicalGiftCard"
}
],
"shoppingCart":{
"coupons":[
{
"code":"FREETATTOO",
"level":"item",
"description":"Explicit Item Discount - FREETATTOO",
"id":"explicitItemFreeDiscount",
"totalAdjustment":"-21.99",
"status":"claimed"
}
],
"items":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"dynamicPropertyMode":"pickup",
"productId":"xprod2165",
"externalRecurringCharge":10,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"xsku2165",
"externalRecurringChargeDuration":"12",
"discountInfo":[
],
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"stockStatus":true,
"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
}
]
},
"reprice":true,
"shippingAddress":{
"lastName":"Test",
"country":"United States",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"prefix":"",
"address1":"Line 1",
"postalCode":"36123",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"selectedCountry":"US",
"firstName":"Steve",
"phoneNumber":"45454545",
"faxNumber":"",
"alias":"",
"middleName":"",
"state":"Alabama",
"email":"steve.test@example.com",
"selectedState":"AL",
"state_ISOCode":"US-AL"
}
}
- checkout
-
Type:
booleanRequired:trueThe option to check in case the data is updated from checkout page. - combineLineItems
-
Type:
stringValue to determine if line items are to be combined. Can be yes or no. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersgift with purchase order marker information. Required if gift with purchase order marker information is present. - orderId
-
Type:
stringThe ID of order to reprice. This parameter is mandatory if reprice flag is true. Currently this and reprice parameter is used only for orders in pending approval state. - payments
-
Type:
arraypaymentsThe array of payments containing gift card payments or a payment card's issue identification number (IIN) to be sent when repricing the order. Properties are specific to the given payment type e.g. if 'type' is iinPaymentType include only 'IIN', if physicalGiftCard include all other properties - populateShippingMethods
-
Type:
booleanThis flag identifies whether to validate the full address or only the state, country and zip code. Full address is validated when this is set to false. - reprice
-
Type:
booleanCurrently this flag is used in combination with orderId parameter. If flag is true orderId is mandatory. Used only for orders in pending approval state. - shippingAddress
-
Type:
objectshippingAddressRequired:trueThe shipping address details. - shippingGroups
-
Type:
arrayshippingGroupsThe shipping groups for the order. - shippingMethod
-
Type:
objectshippingMethodRequired:trueThe shipping method details for the order. - shoppingCart
-
Type:
objectshoppingCartRequired:trueThe shopping cart contents of the current order.
Nested Schema : giftWithPurchaseOrderMarkers
Nested Schema : payments
Type:
arrayThe array of payments containing gift card payments or a payment card's issue identification number (IIN) to be sent when repricing the order. Properties are specific to the given payment type e.g. if 'type' is iinPaymentType include only 'IIN', if physicalGiftCard include all other properties
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:trueIdentifier 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:
stringRequired:trueThe total balance on the gift card. It will be empty if the gift card is added for the first time. - giftCardNumber
-
Type:
stringRequired:trueGift card number. Payment type:physicalGiftCard. - giftCardPin
-
Type:
stringGift card pin. Payment type:physicalGiftCard. - IIN
-
Type:
stringThe issuer identification number (first 6 digits) of the IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout. (iinPaymentType only) - type
-
Type:
stringRequired:trueThe type of the payment. e.g. physicalGiftCard/iinPaymentType.
Nested Schema : items
Type:
object- items
-
Type:
arrayitemsRequired:trueThe array of products in the shipping group. - shippingAddress
-
Type:
objectshippingAddressRequired:trueThe shipping address details. - shippingMethod
-
Type:
objectshippingMethodRequired:trueThe shipping method details for the order.
Nested Schema : items
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 : shippingMethod
Type:
objectThe shipping method details for the order.
- value
-
Type:
stringRequired:trueThe shipping method applied to the order.
Nested Schema : items
Type:
object- catRefId
-
Type:
stringRequired:trueThe category to which the product belongs. - commerceItemId
-
Type:
stringUnique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - 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 this shipping group. - recurringCharge
-
Type:
numberThe recurring charge for the 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 : coupons
Nested Schema : items
Nested Schema : items
Type:
object- code
-
Type:
stringRequired:trueThe coupon code. - description
-
Type:
stringThe coupon description. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - 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:
stringRequired:trueThe coupon ID. - level
-
Type:
stringRequired:trueThe level of the coupon (whether the coupon is item level, etc). - recurringCharge
-
Type:
numberThe recurring charge for the item. - status
-
Type:
stringRequired:trueThe current status of the coupon.
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 : 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:
arraychildItemsThe 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. - currentPrice
-
Type:
integerRequired:trueThe current price of the item. - customerAccountId
-
Type:
stringThe customer account ID associated to the current item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - discountInfo
-
Type:
objectdiscountInfoDiscount information. - externalData
-
Type:
arrayexternalDataExternal 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:
arraygiftWithPurchaseCommerceItemMarkersgiftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in. - giftWithPurchaseSelections
-
Type:
arraygiftWithPurchaseSelectionsThe array of gift with purchase selections to be made. - 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. - stockStatus
-
Type:
stringRequired:trueThe stock status of 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
Type:
objectDiscount information.
- coupon
-
Type:
stringRequired:trueCoupon code. - giftWithPurchaseDiscountInfo
-
Type:
arraygiftWithPurchaseDiscountInfoThe gift selection information. - promotionDesc
-
Type:
stringRequired:trueThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringRequired:truePromotion 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 : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : giftWithPurchaseSelections
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:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - externalData
-
Type:
arrayexternalDataExternal 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:trueThe 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 : 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- 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:trueThe 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.
Nested Schema : items
Type:
object- catRefId
-
Type:
stringThe product variant Id. Include this Id when you are wishing to mark this as a gift with purchase selection you wish to change out - giftWithPurchaseIdentifier
-
Type:
integerRequired:trueThe identifier that links this gift with purchase to the giftWithPurchaseInfo. - giftWithPurchaseQuantity
-
Type:
integerRequired:trueThe total quantity of the commerceItem that is giftWithPurchaseQuantity. - productId
-
Type:
stringID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out - promotionId
-
Type:
stringRequired:trueThe promotion id.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : priceOrder_response
- discountInfo
-
Type:
objectdiscountInfoThe discount information. - giftWithPurchaseInfo
-
Type:
arraygiftWithPurchaseInfoThe gift information. - giftWithPurchaseOrderMarkers
-
Type:
arraygiftWithPurchaseOrderMarkersgift with purchase order marker information. - numberOfItems
-
Type:
integerThe number of items in the cart. - orderId
-
Type:
stringThe ID of order to reprice. - payments
-
Type:
arraypaymentsPayment details for the pricing call, including additional properties specific to the payment type. - priceInfo
-
Type:
objectpriceInfoThe price information. - pricingMessages
-
Type:
objectpricingMessagesThe Pricing messages information. - quoteInfo
-
Type:
objectquoteInfothe quote information of the order - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoRecurring charge price information. - shippingGroups
-
Type:
arrayshippingGroupsThe shipping groups for the order. - shippingMethod
-
Type:
objectshippingMethodThe shipping method details for the order. - shoppingCart
-
Type:
objectshoppingCartThe shopping cart contents of the current order. - siteId
-
Type:
stringThe id of the site in which the order was created
Nested Schema : discountInfo
Type:
objectThe discount information.
- claimedCouponMultiPromotions
-
Type:
objectclaimedCouponMultiPromotionsThe coupons that were claimed - orderCouponsMap
-
Type:
arrayorderCouponsMapThe list of all the coupons with the order. - orderDiscount
-
Type:
integerThe order discount. - orderImplicitDiscountList
-
Type:
arrayorderImplicitDiscountListThe implicit order discounts with the order. - shippingDiscount
-
Type:
integerThe shipping discount. - unclaimedCouponMultiPromotions
-
Type:
objectunclaimedCouponMultiPromotionsThe coupons that were not claimed - unclaimedCouponsMap
-
Type:
objectunclaimedCouponsMapThe unclaimed coupons with the order.
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:
arraygiftWithPurchaseMessagesThe gift with purchase messages information.
Nested Schema : quoteInfo
Type:
objectthe quote information of the order
- errorInfo
-
Type:
arrayerrorInfothe 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:
arraynotesthe 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:
arrayfrequencyAmountTotalsThe total for each recurring charge frequency - frequencyTaxTotals
-
Type:
arrayfrequencyTaxTotalsThe 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 : 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:
arrayitemsThe array of products in the shopping cart.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed
- coupon code
-
Type:
arraycoupon codeCoupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Nested Schema : orderImplicitDiscountList
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
- coupon code
-
Type:
arraycoupon codeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe unclaimed coupons with the order.
- coupon code
-
Type:
arraycoupon codeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion. - totalAdjustment
-
Type:
numberAdjustment done by the promotion
Nested Schema : items
Type:
object- 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:
stringThe total adjustment.
Nested Schema : items
Type:
object- 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:
stringThe total adjustment.
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion.
Nested Schema : coupon code
Nested Schema : items
Type:
object- promotionDesc
-
Type:
stringThis field returns name of the promotion. Retained for backward compatibility - promotionId
-
Type:
stringPromotion Id - promotionLevel
-
Type:
stringPromotion Level - promotionLongDesc
-
Type:
stringThe description of the promotion. - promotionName
-
Type:
stringThe display name of the promotion.
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:
integerIdentifier 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 to be used from the payment group. - balance
-
Type:
numberTotal available balance on the gift card. - gatewayName
-
Type:
stringPayment gateway name. e.g. chaseGiftCard. - 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. INITIAL. - 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:
arrayparamsThe 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 : items
Type:
object- promotionId
-
Type:
stringThe promotion id.
Nested Schema : errorInfo
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:
arrayitemsThe array of products in the shipping group. - shippingAddress
-
Type:
objectshippingAddressThe shipping address details. - shippingMethod
-
Type:
objectshippingMethodThe 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.
- 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 : 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:
booleanUIs this product active. - 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. - detailedItemPriceInfo
-
Type:
objectdetailedItemPriceInfoDetailed Item Price Information. - detailedRecurringChargeInfo
-
Type:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - discountAmount
-
Type:
stringThe discount amount. - displayName
-
Type:
stringDisplay Name. - dynamicProperties
-
Type:
arraydynamicPropertiesArray of custom properties at order line item level. - externalData
-
Type:
arrayexternalDataExternal 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. - listPrice
-
Type:
stringList Price. - onSale
-
Type:
booleanIndicates whether the price is for an item that is on sale. - primaryImageAltText
-
Type:
stringPrimary Image Alternative Text. - primaryImageTitle
-
Type:
stringPrimary Image Title. - primaryThumbImageURL
-
Type:
stringPrimary Thumb Image URL. - productId
-
Type:
stringID of the product in the cart. - quantity
-
Type:
integerThe quantity of the product in this shipping group. - rawTotalPrice
-
Type:
stringRaw Total Price. - recurringCharge
-
Type:
numberThe recurring charge for the item. - route
-
Type:
stringroute. - salePrice
-
Type:
stringSale Price. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item. - shippingSurchargeValue
-
Type:
numbershipping surcharge value. - unitPrice
-
Type:
numberThe unit price. - variant
-
Type:
arrayvariantList of variants for the product.
Nested Schema : detailedItemPriceInfo
Type:
objectDetailed Item Price Information.
- amount
-
Type:
numberThe amount. - currencyCode
-
Type:
stringThe currency code. - detailedUnitPrice
-
Type:
numberDetailed Unit Price. - discounted
-
Type:
booleanIs this item discounted. - orderDiscountShare
-
Type:
numberThe order Discount Share. - quantity
-
Type:
numberThe quantity. - tax
-
Type:
numberThe tax amount.
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 : dynamicProperties
Nested Schema : externalData
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:
objectvaluesThe 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- optionName
-
Type:
stringThe variant option name. - optionValue
-
Type:
stringThe variant option value.
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:
arraychildItemsThe 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:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - discountInfo
-
Type:
arraydiscountInfoThe discount information. - dynamicProperties
-
Type:
arraydynamicPropertiesArray of custom properties at order line item level. - externalData
-
Type:
arrayexternalDataExternal 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:
arraygiftWithPurchaseCommerceItemMarkersgiftWithPurchaseCommerceItemMarker information. - id
-
Type:
stringRepository id of the commerce item. - onSale
-
Type:
booleanWhether the product is on sale. - 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. - unitPrice
-
Type:
integerThe unit price of 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 : dynamicProperties
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
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:
objectdetailedRecurringChargeInfoDetailed Item Price Information. - displayName
-
Type:
stringThe name of the product. - externalData
-
Type:
arrayexternalDataExternal 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:
objectvaluesThe 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:
arraygiftWithPurchaseDiscountInfoThe gift selection 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:
objectvaluesThe 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.
Example application/json
{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0.88,
"amount":2.51,
"valueAddedTax":0,
"countyTax":0.63,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1,
"countryTax":0
},
"priceInfo":{
"amount":19,
"total":27.46,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":2.51,
"subTotal":19,
"currencyCode":"USD",
"totalWithoutTax":24.95
},
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shippingMethod":{
"shippingTax":0.6,
"cost":5.95,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10015",
"shippingAddress":{
"lastName":"Test",
"country":"US",
"address3":"",
"address2":"Line 2",
"city":"Montgomery",
"address1":"Line 1",
"prefix":"",
"companyName":"",
"postalCode":"36123",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Steve",
"phoneNumber":"45454545",
"alias":"Address",
"faxNumber":"",
"middleName":"",
"state":"AL",
"email":null
},
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":19,
"returnedQuantity":0,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"commerceItemId":"ci3000411",
"assetId":"asset10001",
"price":19,
"onSale":false,
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"unitPrice":19,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"xprod2065",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":19,
"quantity":1,
"tax":1.91,
"orderDiscountShare":0,
"detailedUnitPrice":19,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku2065",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"listPrice":19,
"recurringCharge":10,
"status":"INITIAL"
}
]
}
],
"orderId":"o10001",
"shippingMethod":{
"cost":6.5,
"value":"ground"
},
"payments":[
{
"paymentGroupId":"pg70448",
"amount":27.46,
"balance":"100.0",
"gatewayName":"chaseGiftCard",
"giftCardNumber":"6035710988880101071",
"uiIntervention":null,
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":true,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxxxxxxxxxxxx1071"
}
],
"priceInfo":{
"amount":19,
"total":27.46,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":2.51,
"subTotal":19,
"currencyCode":"USD"
},
"recurringChargePriceInfo":{
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"tax":2.4,
"subTotal":30,
"currencyCode":"USD",
"totalWithoutTax":30
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
"coupon2":[
{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
]
},
"orderCouponsMap":{
"coupon1":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
"coupon2":{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
{
"promotionLevel":"item",
"totalAdjustment":"-0.66",
"promotionDesc":"Implicit Item Discount - 3PercentOff",
"promotionId":"implicitItemPercentDiscount"
}
],
"claimedCouponMultiPromotions":{
"coupon1":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo1",
"promotionId":"promo20001"
},
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo3",
"promotionId":"promo20003"
}
],
"coupon2":[
{
"promotionLevel":"order",
"totalAdjustment":-1,
"promotionDesc":"promo2",
"promotionId":"promo20002"
}
]
},
"unclaimedCouponsMap":{
"coupon2":{
"promotionLevel":"order",
"promotionDesc":"promo4",
"promotionId":"promo20004"
}
}
},
"pricingMessages":{
"giftWithPurchaseMessages":[
{
"summary":"The cart has qualified for a free gift promotion.",
"identifier":"GWPQualified",
"params":"[]",
"type":"information",
"priority":"-10"
}
]
},
"numberOfItems":1,
"shoppingCart":{
"items":[
{
"unitPrice":19,
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"xprod2065",
"externalRecurringCharge":10,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"externalData":[
],
"billingAccountId":"billingAcc-123",
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"xsku2065",
"commerceItemId":"ci3000411",
"discountInfo":[
],
"customerAccountId":"customerAcc-123",
"price":19,
"assetId":"asset10001",
"onSale":false,
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"recurringCharge":10
}
]
},
"siteId":"siteUS",
"quoteInfo":{
"providerNote":null,
"notes":[
{
"profileType":null,
"profileId":"120213",
"requestDate":1.477479521002E12,
"requesterNote":"This is a sample quote"
}
],
"rejectionDate":null,
"requestDate":"2016-10-26T10:58:41.002Z",
"errorInfo":null,
"externalID":null,
"rejectionNote":null,
"quoteDate":null,
"expirationDate":null
},
"giftWithPurchaseOrderMarkers":[
{
"quantity":1,
"selectedQuantity":0,
"removedQuantity":0,
"data":"-1275480226",
"automaticQuantity":0,
"giftType":"product",
"autoRemove":true,
"giftDetail":"camera_1",
"repositoryId":"200001",
"failedQuantity":0,
"value":"promo10002",
"targetedQuantity":0,
"key":"atg.gwp"
}
]
}
Default Response
The 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:
arrayerrorsAn 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:
{
"orderId": "o10001",
"shippingMethod": {"value": "ground"},
"payments": [{
"amount": "100.0",
"giftCardNumber": "6035710988880101071",
"giftCardPin": "",
"type": "physicalGiftCard"
}],
"shoppingCart": {
"coupons": [{
"code": "FREETATTOO",
"level": "item",
"description": "Explicit Item Discount - FREETATTOO",
"id": "explicitItemFreeDiscount",
"totalAdjustment": "-21.99",
"status": "claimed"
}],
"items": [{
"serviceAccountId": "serviceAcc-123",
"deactivationDate": "2018-06-27T12:59:59Z",
"quantity": 1,
"dynamicPropertyMode": "pickup",
"productId": "xprod2165",
"externalRecurringCharge": 10,
"externalData": [],
"billingAccountId": "billingAcc-123",
"externalRecurringChargeFrequency": "Monthly",
"catRefId": "xsku2165",
"externalRecurringChargeDuration": "12",
"discountInfo": [],
"customerAccountId": "customerAcc-123",
"assetId": "asset10001",
"stockStatus": true,
"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
}]
},
"reprice": true,
"shippingAddress": {
"lastName": "Test",
"country": "United States",
"address3": "",
"address2": "Line 2",
"city": "Montgomery",
"prefix": "",
"address1": "Line 1",
"postalCode": "36123",
"jobTitle": "",
"companyName": "",
"county": "",
"suffix": "",
"selectedCountry": "US",
"firstName": "Steve",
"phoneNumber": "45454545",
"faxNumber": "",
"alias": "",
"middleName": "",
"state": "Alabama",
"email": "steve.test@example.com",
"selectedState": "AL",
"state_ISOCode": "US-AL"
}
}
Sample Response Payload returned by endpoint:
{
"shippingGroups": [{
"taxPriceInfo": {
"cityTax": 0.88,
"amount": 2.51,
"valueAddedTax": 0,
"countyTax": 0.63,
"isTaxIncluded": false,
"miscTax": 0,
"districtTax": 0,
"stateTax": 1,
"countryTax": 0
},
"priceInfo": {
"amount": 19,
"total": 27.46,
"shipping": 5.95,
"shippingSurchargeValue": 0,
"tax": 2.51,
"subTotal": 19,
"currencyCode": "USD",
"totalWithoutTax": 24.95
},
"recurringChargePriceInfo": {
"amount": 30,
"total": 32.4,
"shipping": 0,
"subTotalByFrequency": [{
"amount": 30,
"frequency": "Monthly"
}],
"taxByFrequency": [{
"amount": 2.4,
"frequency": "Monthly"
}],
"tax": 2.4,
"subTotal": 30,
"currencyCode": "USD",
"totalWithoutTax": 30
},
"discountInfo": {
"orderDiscount": 0,
"shippingDiscount": 0,
"discountDescList": []
},
"shippingMethod": {
"shippingTax": 0.6,
"cost": 5.95,
"value": "ground",
"shippingMethodDescription": "Ground"
},
"shippingGroupId": "sg10015",
"shippingAddress": {
"lastName": "Test",
"country": "US",
"address3": "",
"address2": "Line 2",
"city": "Montgomery",
"address1": "Line 1",
"prefix": "",
"companyName": "",
"postalCode": "36123",
"jobTitle": "",
"county": "",
"suffix": "",
"firstName": "Steve",
"phoneNumber": "45454545",
"alias": "Address",
"faxNumber": "",
"middleName": "",
"state": "AL",
"email": null
},
"items": [{
"deactivationDate": "2018-06-27T12:59:59Z",
"rawTotalPrice": 19,
"returnedQuantity": 0,
"dynamicProperties": [{
"id": "dynamicPropertyMode",
"label": "Mode",
"value": "pickup"
}],
"shippingSurchargeValue": 0,
"discountAmount": 0,
"externalData": [],
"billingAccountId": "billingAcc-123",
"commerceItemId": "ci3000411",
"assetId": "asset10001",
"price": 19,
"onSale": false,
"actionCode": "Add",
"serviceId": "service-123",
"stateDetailsAsUser": "The item has been initialized within the shipping group",
"unitPrice": 19,
"serviceAccountId": "serviceAcc-123",
"quantity": 1,
"productId": "xprod2065",
"salePrice": 0,
"detailedItemPriceInfo": [{
"discounted": false,
"amount": 19,
"quantity": 1,
"tax": 1.91,
"orderDiscountShare": 0,
"detailedUnitPrice": 19,
"currencyCode": "USD"
}],
"externalRecurringCharge": 10,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12",
"catRefId": "xsku2065",
"customerAccountId": "customerAcc-123",
"discountInfo": [],
"detailedRecurringChargeInfo": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"activationDate": "2017-06-27T15:30:00Z",
"listPrice": 19,
"recurringCharge": 10,
"status": "INITIAL"
}]
}],
"orderId": "o10001",
"shippingMethod": {
"cost": 6.5,
"value": "ground"
},
"payments": [{
"paymentGroupId": "pg70448",
"amount": 27.46,
"balance": "100.0",
"gatewayName": "chaseGiftCard",
"giftCardNumber": "6035710988880101071",
"uiIntervention": null,
"paymentMethod": "physicalGiftCard",
"isAmountRemaining": true,
"paymentState": "INITIAL",
"maskedCardNumber": "xxxxxxxxxxxxxxx1071"
}],
"priceInfo": {
"amount": 19,
"total": 27.46,
"shipping": 5.95,
"shippingSurchargeValue": 0,
"tax": 2.51,
"subTotal": 19,
"currencyCode": "USD"
},
"recurringChargePriceInfo": {
"amount": 30,
"total": 32.4,
"shipping": 0,
"subTotalByFrequency": [{
"amount": 30,
"frequency": "Monthly"
}],
"taxByFrequency": [{
"amount": 2.4,
"frequency": "Monthly"
}],
"tax": 2.4,
"subTotal": 30,
"currencyCode": "USD",
"totalWithoutTax": 30
},
"discountInfo": {
"unclaimedCouponMultiPromotions": {"coupon2": [{
"promotionLevel": "order",
"promotionDesc": "promo4",
"promotionId": "promo20004"
}]},
"orderCouponsMap": {
"coupon1": {
"promotionLevel": "order",
"totalAdjustment": -1,
"promotionDesc": "promo1",
"promotionId": "promo20001"
},
"coupon2": {
"promotionLevel": "order",
"totalAdjustment": -1,
"promotionDesc": "promo2",
"promotionId": "promo20002"
}
},
"orderDiscount": 0,
"shippingDiscount": 0,
"orderImplicitDiscountList": [{
"promotionLevel": "item",
"totalAdjustment": "-0.66",
"promotionDesc": "Implicit Item Discount - 3PercentOff",
"promotionId": "implicitItemPercentDiscount"
}],
"claimedCouponMultiPromotions": {
"coupon1": [
{
"promotionLevel": "order",
"totalAdjustment": -1,
"promotionDesc": "promo1",
"promotionId": "promo20001"
},
{
"promotionLevel": "order",
"totalAdjustment": -1,
"promotionDesc": "promo3",
"promotionId": "promo20003"
}
],
"coupon2": [{
"promotionLevel": "order",
"totalAdjustment": -1,
"promotionDesc": "promo2",
"promotionId": "promo20002"
}]
},
"unclaimedCouponsMap": {"coupon2": {
"promotionLevel": "order",
"promotionDesc": "promo4",
"promotionId": "promo20004"
}}
},
"pricingMessages": {"giftWithPurchaseMessages": [{
"summary": "The cart has qualified for a free gift promotion.",
"identifier": "GWPQualified",
"params": "[]",
"type": "information",
"priority": "-10"
}]},
"numberOfItems": 1,
"shoppingCart": {"items": [{
"unitPrice": 19,
"serviceAccountId": "serviceAcc-123",
"deactivationDate": "2018-06-27T12:59:59Z",
"quantity": 1,
"productId": "xprod2065",
"externalRecurringCharge": 10,
"dynamicProperties": [{
"id": "dynamicPropertyMode",
"label": "Mode",
"value": "pickup"
}],
"giftWithPurchaseCommerceItemMarkers": [],
"externalData": [],
"billingAccountId": "billingAcc-123",
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12",
"catRefId": "xsku2065",
"commerceItemId": "ci3000411",
"discountInfo": [],
"customerAccountId": "customerAcc-123",
"price": 19,
"assetId": "asset10001",
"onSale": false,
"detailedRecurringChargeInfo": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"actionCode": "Add",
"activationDate": "2017-06-27T15:30:00Z",
"serviceId": "service-123",
"recurringCharge": 10
}]},
"siteId": "siteUS",
"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"
}]
}