getOrder
get
/ccstore/v1/orders/{id}
Get Order. Get 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.This endpoint returns the order details irrespective of organization ID passed in request header. If user doesn't belong to order's organization, then the user has no access to order.
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
string
Required:true
the id of the order to retrieve.
Header Parameters
- X-CCOrganization
-
Type:
string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getOrder_response
- approvalSystemMessages
-
Type:
array
approvalSystemMessagesThe array of messages which are stored during order processing - billingMethod
-
Type:
object
billingMethodbilling Method information of the order. - creationDate
-
Type:
string
Date on which the Order was created. - creationTime
-
Type:
number
Order creation time. - discountInfo
-
Type:
object
discountInfoDiscount information. - dynamicProperties
-
Type:
array
dynamicPropertiesRead-only list of dynamic properties for the order along with meta-data. - id
-
Type:
string
Commerce id for this order. - isItemPriceOverrideAllowed
-
Type:
boolean
Indicates whether an item price can be overridden. - orderCancelReason
-
Type:
string
Reason through which the order has been cancelled. - orderComments
-
Type:
array
orderCommentsThe list of all logged comments for the order. - paymentGroup
-
Type:
object
paymentGroupPayment Group for the order. - paymentGroups
-
Type:
array
paymentGroupsList of payment Groups for the order. - priceInfo
-
Type:
object
priceInfoPrice information of the order. - priceListGroup
-
Type:
object
priceListGroupPriceList group of the order. - profile
-
Type:
object
profileProfile Information for the order. - profileId
-
Type:
string
The Repository Id of the profile to which this Order belongs to. - returnRequests
-
Type:
array
returnRequestsThe list of the requests raised for the order. - scheduledOrderId
-
Type:
string
The id of the scheduled order from which the order is placed, if the origin of order is schedule order. This is an optional key and will not be available if the origin of order is not scheduled order. - scheduledOrderName
-
Type:
string
The name of the scheduled order from which the order is placed, if the origin of order is schedule order. This is an optional key and will not be available if the origin of order is not scheduled order. - shippingAddress
-
Type:
object
shippingAddressshipping address for the order. - shippingGroups
-
Type:
array
shippingGroupsShipping Group Information - shippingMethod
-
Type:
object
shippingMethodShipping method information. - shoppingCart
-
Type:
object
shoppingCartShopping cart information. - siteId
-
Type:
string
Site Id on which the order was placed. - sourceSystem
-
Type:
string
The system where the order originated. - state
-
Type:
integer
The order state. - stateDetailsAsUser
-
Type:
string
Order State description for this order. - stateString
-
Type:
string
Order state as key string. - submittedDate
-
Type:
string
Date on which the order was submitted. - taxPriceInfo
-
Type:
object
taxPriceInfoThe tax pricing details for the order. - totalAmountAuthorized
-
Type:
number
total amount authorized for the order.
Nested Schema : approvalSystemMessages
Nested Schema : billingMethod
Type:
object
billing Method information of the order.
- cost
-
Type:
number
billing Cost for this order. - displayName
-
Type:
string
billing method display name for this billing method. - value
-
Type:
string
billing method name for this order.
Nested Schema : discountInfo
Type:
object
Discount information.
- claimedCouponMultiPromotions
-
Type:
object
claimedCouponMultiPromotionsThe coupons that were claimed - orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponMultiPromotions
-
Type:
object
unclaimedCouponMultiPromotionsThe coupons that were not claimed - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : orderComments
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - balance
-
Type:
string
The gift card balance available. - billingAddress
-
Type:
object
billingAddressBilling address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
The credit card type. - firstName
-
Type:
string
First name associated with this Payment Group. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - paymentStatString
-
Type:
string
The payment state as a key string. - PONumber
-
Type:
string
Purchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : paymentGroups
Nested Schema : priceInfo
Type:
object
Price information of the order.
- amount
-
Type:
number
The raw number that represents the price. - billing
-
Type:
number
The billing cost of the order. - currencyCode
-
Type:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars. - subTotal
-
Type:
number
The subtotal of the order before applying order-level promotions. - tax
-
Type:
number
The tax on the order. - total
-
Type:
number
The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
- active
-
Type:
boolean
Active status of pricelist group. - currency
-
Type:
object
currencyCurrency of the PriceList group. - deleted
-
Type:
boolean
Pricelist group deleted status. - displayName
-
Type:
string
Display Name. - id
-
Type:
string
Id. - locale
-
Type:
string
Locale. - repositoryId
-
Type:
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
-
Type:
string
Email Address corresponding to the profile. - firstName
-
Type:
string
First name of profile. - isAnonymous
-
Type:
boolean
Indicates whether this profile is an anonymous profile. By default, it is false. - lastName
-
Type:
string
Last name of profile. - middleName
-
Type:
string
Middle name of profile. - organization
-
Type:
object
organizationThe Organization associated with the B2B customer profile.
Nested Schema : returnRequests
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this shipping address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment
Nested Schema : shoppingCart
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed
- couponCode
-
Type:
array
couponCodeCoupon Code, corresponding to which promotions were applied
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
- couponCode
-
Type:
array
couponCodeCoupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level - totalAdjustment
-
Type:
number
Adjustment done by the promotion
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : couponCode
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Promotion Description - promotionId
-
Type:
string
Promotion Id - promotionLevel
-
Type:
string
Promotion Level
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- id
-
Type:
string
The ID of the dynamic property. - value
-
Type:
string
The value of the dynamic property.
Nested Schema : items
Type:
object
- comment
-
Type:
string
The comment string. - creationDate
-
Type:
string
Date on which the comment was created. - repositoryId
-
Type:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this billing address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : items
Type:
object
- amount
-
Type:
number
The amount associated with this Payment Group. - amountAuthorized
-
Type:
number
The amount authorized with this Payment Group. - balance
-
Type:
string
The gift card balance available. - billingAddress
-
Type:
object
billingAddressBilling address for the order. - cardNumber
-
Type:
string
The masked credit card number. - cardType
-
Type:
string
Payment method. e.g. physicalGiftCard/ creditCard - firstName
-
Type:
string
First name associated with this Payment Group. - IIN
-
Type:
string
The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow credit card type based promotions to be applied prior to final checkout. - lastName
-
Type:
string
Last name associated with this Payment Group. - paidAmount
-
Type:
number
The amount that has been debited to-date for this Payment Group. - paymentGroupId
-
Type:
integer
Id of this payment Group. - paymentState
-
Type:
string
The Payment Group state. - paymentStateDetailsAsUser
-
Type:
string
The payment state description as string. - paymentStateString
-
Type:
string
The payment state as a key String. - PONumber
-
Type:
string
Purchase order number for invoice payment. Payment type: invoice - refundAmount
-
Type:
number
The amount that has been credited to-date for this Payment Group. - token
-
Type:
string
Token associated with this Payment Group. - totalDue
-
Type:
number
The current working total order price including all discounts, tax, and billing costs. - uiIntervention
-
Type:
string
This decides whether the client has to do some intervention for payment. e.g. SOP - zero_value_auto_authorized
-
Type:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : billingAddress
Type:
object
Billing address for the order.
- address1
-
Type:
string
Address line 1 for this billing address. - address2
-
Type:
string
Address line 2 for this billing address. - address3
-
Type:
string
Address line 3 for this billing address. - city
-
Type:
string
City for this billing address. - companyName
-
Type:
string
Company name for this billing address. - country
-
Type:
string
Country for this billing address. - county
-
Type:
string
County for this billing address. -
Type:
string
Email for this billing address. - faxNumber
-
Type:
string
Fax number for this billing address. - firstName
-
Type:
string
First name for this billing address. - jobTitle
-
Type:
string
Job title for this billing address. - lastName
-
Type:
string
Last name for this billing address. - middleName
-
Type:
string
Middle name for this billing address. - phoneNumber
-
Type:
string
Phone number for this billing address. - postalCode
-
Type:
string
Postal code for this billing address. - prefix
-
Type:
string
Prefix for this billing address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this billing address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this billing address.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
- currencyCode
-
Type:
string
Currency Code. - displayName
-
Type:
string
Display Name. - fractionalDigits
-
Type:
integer
Fractional Digits. - numericCode
-
Type:
string
Numeric Code. - repositoryId
-
Type:
string
Repository Id. - symbol
-
Type:
string
currency Symbol.
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
- id
-
Type:
string
The id of the organization. - name
-
Type:
string
The name of of the organization.
Nested Schema : items
Type:
object
- createdDate
-
Type:
string
The creation date of the return request. - returnRequestId
-
Type:
string
The return request id. - state
-
Type:
string
The status of the return request. - totalRefund
-
Type:
number
The total amount to be refunded on return. - totalReturnQuantity
-
Type:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
object
- items
-
Type:
array
itemsRequired:true
Items in the cart. - shippingAddress
-
Type:
object
shippingAddressshipping address for the order. - shippingMethod
-
Type:
object
shippingMethodShipping method information. - trackingInfo
-
Type:
array
trackingInfoTracking Information for the Order. - trackingNumber
-
Type:
string
Shipping tracking number.
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
- address1
-
Type:
string
Address Line 1 for this shipping address. - address2
-
Type:
string
Address Line 2 for this shipping address. - address3
-
Type:
string
Address Line 3 for this shipping address. - city
-
Type:
string
City for this shipping address. - companyName
-
Type:
string
Company name for this shipping address. - country
-
Type:
string
Country for this shipping address. - county
-
Type:
string
County for this shipping address. -
Type:
string
Email for this shipping address. - faxNumber
-
Type:
string
Fax number for this shipping address. - firstName
-
Type:
string
First name for this shipping address. - jobTitle
-
Type:
string
Job title for this shipping address. - lastName
-
Type:
string
Last name for this shipping address. - middleName
-
Type:
string
Middle name for this shipping address. - phoneNumber
-
Type:
string
Phone number for this shipping address. - postalCode
-
Type:
string
Postal code for this shipping address. - prefix
-
Type:
string
Prefix for this shipping address. - selectedCountry
-
Type:
string
The selected country of the shipping address. - selectedState
-
Type:
string
The selected state of the shipping address. - state
-
Type:
string
State for this shipping address. - state_ISOCode
-
Type:
string
The state ISON code of the shipping address. - suffix
-
Type:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
- cost
-
Type:
number
shipping cost. - displayName
-
Type:
string
Display Name of shipment. - value
-
Type:
string
method type of shipment.
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. - assetId
-
Type:
string
The asset ID corresponding to the current item. - availabilityDate
-
Type:
string
The Availability date of commerce Item. - backOrderQuantity
-
Type:
number
Back Order Quantity of the Items. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
catRefId of the product. - 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. - dynamicProperties
-
Type:
array
dynamicPropertiesArray of custom properties at order line item level. - externalData
-
Type:
array
externalDataExternal data to be associated with a commerce item, provided by a configurator system. - preOrderQuantity
-
Type:
number
Pre Order Quantity of the Items. - productId
-
Type:
string
Id of the product. - quantity
-
Type:
integer
quantity of the product. - 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
skuPropertiesSku properties Information - variant
-
Type:
array
variantProduct Variant Information.
Nested Schema : dynamicProperties
Nested Schema : externalData
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
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
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
- 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
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
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
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. - availabilityDate
-
Type:
string
The Availability date of commerce Item. - backOrderQuantity
-
Type:
number
Back Order Quantity of the Items. - billingAccountId
-
Type:
string
The billing account ID associated to the current item. - catRefId
-
Type:
string
Catalog Reference Id of commerce item. - childItems
-
Type:
array
childItemsChild items of the commerce item - childSKUs
-
Type:
array
childSKUsChild SKU level detail - commerceItemId
-
Type:
string
The unique id of the line item. - configuratorId
-
Type:
string
Configuration id of the configurable product - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - discountAmount
-
Type:
number
Total discount applied to commerce item. - discountInfo
-
Type:
object
discountInfoDiscount information. - displayName
-
Type:
string
Display name of commerce item. - dynamicProperties
-
Type:
array
dynamicPropertiesArray of custom properties at order line item level. - externalData
-
Type:
array
externalDataExternal data to be associated with a commerce item, provided by a configurator system. - externalPrice
-
Type:
number
The Price of the product as per the external pricing system. - externalPriceQuantity
-
Type:
integer
Quantity of the product, the customer is allowed to buy at the external price. - giftWithPurchaseCommerceItemMarkers
-
Type:
array
giftWithPurchaseCommerceItemMarkersThe array of giftWithPurchaseCommerceItemMarkers. - imageInfo
-
Type:
object
imageInfoShipping method information. - isPriceOverridden
-
Type:
boolean
Indicates if commerce item price is overridden or not. - onSale
-
Type:
boolean
indicates if product is on sale or not - overriddenPrice
-
Type:
number
overridden price of commerce item. - preOrderQuantity
-
Type:
number
Pre Order Quantity of the Items. - price
-
Type:
number
The raw number that represents the price. - priceOverridenBy
-
Type:
string
Name of the agent who has overridden item price. - priceOverrideReason
-
Type:
object
priceOverrideReasonPrice override reason map. - productId
-
Type:
string
Product Id of commerce item. - quantity
-
Type:
number
Quantity of the items. - rawTotalPrice
-
Type:
number
The raw total price. - returnedQuantity
-
Type:
number
Quantity for which return request has been raised. - 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
skuPropertiesSku properties Information - stateDescription
-
Type:
string
Item state as a key string. - stateDetailsAsUser
-
Type:
string
State description of the commerce item. - status
-
Type:
integer
State of the commerce item. - subTotal
-
Type:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice. - tax
-
Type:
number
The amount of tax paid for this item. - unitPrice
-
Type:
number
Sale price or list price of commerceItem. - variant
-
Type:
array
variantProduct Variant Information.
Nested Schema : discountInfo
Type:
object
Discount information.
- orderCouponsMap
-
Type:
array
orderCouponsMapMap of coupons. - orderDiscount
-
Type:
number
Discount given on an order. - orderImplicitDiscountList
-
Type:
array
orderImplicitDiscountListList of discounts. - shippingDiscount
-
Type:
integer
The shipping discount. - unclaimedCouponsMap
-
Type:
array
unclaimedCouponsMapMap of unclaimed coupons.
Nested Schema : dynamicProperties
Nested Schema : externalData
Nested Schema : giftWithPurchaseCommerceItemMarkers
Nested Schema : imageInfo
Type:
object
Shipping method information.
- primaryThumbImageURL
-
Type:
string
ThumbNail Image URL
Nested Schema : priceOverrideReason
Type:
object
Price override reason map.
- displayValue
-
Type:
string
price override reason value. - key
-
Type:
string
price override reason key.
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
Sku Id of the child item - childItems
-
Type:
array
childItemsChild items of the commerce item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataExternal data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Product path - selectedOptions
-
Type:
array
selectedOptionsChild Product Variant Information. - 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 : externalData
Nested Schema : selectedOptions
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
Sku Id of the child item - customerAccountId
-
Type:
string
The customer account ID associated to the current item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - displayName
-
Type:
string
Display name of the child product - externalData
-
Type:
array
externalDataExternal data to be associated with a commerce item, provided by a configurator system. - productId
-
Type:
string
Product Id of the child item - quantity
-
Type:
number
Quantity of the child item - route
-
Type:
string
Product path - selectedOptions
-
Type:
array
selectedOptionsChild Product Variant Information. - 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 : externalData
Nested Schema : selectedOptions
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
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
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
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
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
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
object
- primaryThumbImageURL
-
Type:
string
Thumb image URL based on the selected SKU
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
object
- couponInfo
-
Type:
array
couponInfoThe coupon Info. - promotionValue
-
Type:
string
The value for promotion.
Nested Schema : items
Type:
object
- promotionDesc
-
Type:
string
Description of the promotion. - promotionId
-
Type:
string
Id of the promotion. - promotionLevel
-
Type:
string
Level of the promotion. - totalAdjustment
-
Type:
string
Total adjustment caused by 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
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
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
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 GWP promotion. - key
-
Type:
string
atg.gwp - remainingQuantity
-
Type:
number
The quantity of the commerce item that is not affected by GWP. - 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
- optionName
-
Type:
string
Name of the Dynamic SKU Property. - optionValue
-
Type:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
object
- optionName
-
Type:
string
Name of the Dynamic attribute. - optionValue
-
Type:
string
Value of the Dynamic attribute.
Example application/json
{
"creationTime":1.428563503E12,
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"payments":[
{
"paymentGroupId":"pg70441",
"amount":100,
"customPaymentProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"balance":null,
"gatewayName":"chaseGiftCard",
"giftCardNumber":null,
"uiIntervention":null,
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"AUTHORIZED",
"maskedCardNumber":"xxxxxxxxxxxxxxx1071"
},
{
"paymentGroupId":"pg70442",
"amount":158.5,
"customPaymentProperties":{
"EMIS":"12",
"MontlyCharge":"$100"
},
"gatewayName":"chaseCreditCard",
"uiIntervention":null,
"paymentMethod":"creditCard",
"isAmountRemaining":true,
"paymentState":"AUTHORIZED"
}
],
"orderStatus":"Submitted to fulfillment",
"approvers":[
{
"firstName":"Peter",
"lastName":"Grun",
"approverId":"bb-110020"
}
],
"submittedDate":"2015-04-09T07:21:43.000Z",
"uuid":"a15543c2-a44f-4640-8ac4-674c594efc85",
"priceInfo":{
"amount":52,
"total":62.6,
"shipping":6.5,
"shippingSurchargeValue":20,
"tax":4.1,
"subTotal":52,
"currencyCode":"USD"
},
"links":[
{
"rel":"self",
"href":"http://www.example.com/ccstoreui/v1/orders/o10004"
}
],
"id":"o10004",
"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
},
"order":{
"numberOfItems":1,
"items":[
{
"primaryThumbImageURL":"/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":52,
"displayName":"Cowboy Shirt",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalData":[
],
"billingAccountId":"billingAcc-123",
"commerceItemId":"ci3000411",
"assetId":"asset10001",
"price":52,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"actionCode":"Add",
"serviceId":"service-123",
"unitPrice":52,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"prod10002",
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"active":true,
"externalRecurringChargeFrequency":"Monthly",
"catRefId":"sku40087",
"externalRecurringChargeDuration":"12",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"recurringCharge":10
}
]
},
"shippingGroup":{
"shippingMethodDescription":"Ground"
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0,
"amount":4.1,
"valueAddedTax":0,
"countyTax":1.76,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":2.34,
"countryTax":0
},
"shippingMethod":{
"shippingTax":0.46,
"cost":6.5,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10032",
"submittedDate":null,
"priceInfo":{
"amount":52,
"total":62.6,
"shipping":6.5,
"shippingSurchargeValue":0,
"tax":4.1,
"subTotal":52,
"currencyCode":"USD",
"totalWithoutTax":58.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":"a",
"country":"US",
"address3":"",
"address2":"a",
"city":"a",
"address1":"a",
"prefix":"",
"companyName":"",
"postalCode":"30005",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"a",
"phoneNumber":"5675675678",
"alias":"Address##0",
"faxNumber":"",
"middleName":"",
"state":"GA",
"email":"a@a.com"
},
"trackingNumber":null,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":52,
"returnedQuantity":0,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"displayName":"Cowboy Shirt",
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"preOrderQuantity":0,
"commerceItemId":"ci3000411",
"assetId":"asset10001",
"price":52,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"onSale":false,
"primaryImageAltText":"Cowboy Shirt",
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"serviceAccountId":"serviceAcc-123",
"unitPrice":52,
"primaryImageTitle":"Cowboy Shirt",
"quantity":1,
"productId":"prod10002",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":52,
"quantity":1,
"tax":3.64,
"orderDiscountShare":0,
"detailedUnitPrice":52,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"active":true,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40087",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":10,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"backOrderQuantity":0,
"listPrice":52,
"recurringCharge":10,
"status":"INITIAL"
}
],
"status":"INITIAL"
}
],
"lastModifiedDate":"2015-04-09T07:21:43.000Z",
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"cost":6.5,
"value":"ground"
},
"priceListGroup":{
"repositoryId":"UsDollar"
},
"approverMessages":[
"I am approving this order"
],
"creationDate":"2015-04-09T07:11:43.000Z",
"orderProfileId":"120029",
"paymentGroupId":"pg10004",
"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"
}
}
},
"trackingInfo":[
{
"carrierName":"OnTrac",
"carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
"carrierId":"OnTrac",
"trackingNumber":"1224"
}
],
"orderLocale":"en",
"shippingAddress":{
"lastName":"a",
"country":"US",
"address3":null,
"address2":"a",
"city":"a",
"address1":"a",
"prefix":null,
"companyName":null,
"postalCode":"30005",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"a",
"phoneNumber":"5675675678",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"GA",
"email":"a@a.com"
},
"billingAddress":{
"lastName":"a",
"country":"US",
"address3":null,
"address2":"a",
"city":"a",
"address1":"a",
"prefix":null,
"companyName":null,
"postalCode":"30005",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"a",
"phoneNumber":"5675675678",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"GA",
"email":"a@a.com"
},
"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
errorsAn 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 Response Payload returned by endpoint:
{ "creationTime": 1428563503000, "sourceSystem": "Cloud Commerce", "dynamicProperties": [{ "id": "dynamicPropertyShippingInstructions", "label": "Shipping Instructions", "value": "Test Instructions" }], "payments": [ { "paymentGroupId": "pg70441", "amount": 100, "customPaymentProperties": { "EMIS": "12", "MontlyCharge": "$100" }, "balance": null, "gatewayName": "chaseGiftCard", "giftCardNumber": null, "uiIntervention": null, "paymentMethod": "physicalGiftCard", "isAmountRemaining": false, "paymentState": "AUTHORIZED", "maskedCardNumber": "xxxxxxxxxxxxxxx1071" }, { "paymentGroupId": "pg70442", "amount": 158.5, "customPaymentProperties": { "EMIS": "12", "MontlyCharge": "$100" }, "gatewayName": "chaseCreditCard", "uiIntervention": null, "paymentMethod": "creditCard", "isAmountRemaining": true, "paymentState": "AUTHORIZED" } ], "orderStatus": "Submitted to fulfillment", "approvers": [{ "firstName": "Peter", "lastName": "Grun", "approverId": "bb-110020" }], "submittedDate": "2015-04-09T07:21:43.000Z", "uuid": "a15543c2-a44f-4640-8ac4-674c594efc85", "priceInfo": { "amount": 52, "total": 62.6, "shipping": 6.5, "shippingSurchargeValue": 20, "tax": 4.1, "subTotal": 52, "currencyCode": "USD" }, "links": [{ "rel": "self", "href": "http://www.example.com/ccstoreui/v1/orders/o10004" }], "id": "o10004", "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 }, "order": { "numberOfItems": 1, "items": [{ "primaryThumbImageURL": "/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100", "deactivationDate": "2018-06-27T12:59:59Z", "rawTotalPrice": 52, "displayName": "Cowboy Shirt", "dynamicProperties": [{ "id": "dynamicPropertyMode", "label": "Mode", "value": "pickup" }], "externalData": [], "billingAccountId": "billingAcc-123", "commerceItemId": "ci3000411", "assetId": "asset10001", "price": 52, "variant": [ { "optionValue": "Blue", "optionName": "Color" }, { "optionValue": "Medium", "optionName": "Size" } ], "actionCode": "Add", "serviceId": "service-123", "unitPrice": 52, "serviceAccountId": "serviceAcc-123", "quantity": 1, "productId": "prod10002", "externalRecurringCharge": 10, "giftWithPurchaseCommerceItemMarkers": [], "active": true, "externalRecurringChargeFrequency": "Monthly", "catRefId": "sku40087", "externalRecurringChargeDuration": "12", "skuProperties": [{ "propertyType": "sku-base", "name": "UPC Code", "id": "upcCode", "value": "123456" }], "customerAccountId": "customerAcc-123", "discountInfo": [], "route": "/cowboy-shirt/product/prod10002", "detailedRecurringChargeInfo": [{ "discounted": false, "amount": 10, "quantity": 1, "tax": 0, "orderDiscountShare": 0, "detailedUnitPrice": 10, "currencyCode": "USD" }], "activationDate": "2017-06-27T15:30:00Z", "recurringCharge": 10 }] }, "shippingGroup": {"shippingMethodDescription": "Ground"}, "shippingGroups": [{ "taxPriceInfo": { "cityTax": 0, "amount": 4.1, "valueAddedTax": 0, "countyTax": 1.76, "isTaxIncluded": false, "miscTax": 0, "districtTax": 0, "stateTax": 2.34, "countryTax": 0 }, "shippingMethod": { "shippingTax": 0.46, "cost": 6.5, "value": "ground", "shippingMethodDescription": "Ground" }, "shippingGroupId": "sg10032", "submittedDate": null, "priceInfo": { "amount": 52, "total": 62.6, "shipping": 6.5, "shippingSurchargeValue": 0, "tax": 4.1, "subTotal": 52, "currencyCode": "USD", "totalWithoutTax": 58.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": "a", "country": "US", "address3": "", "address2": "a", "city": "a", "address1": "a", "prefix": "", "companyName": "", "postalCode": "30005", "jobTitle": "", "county": "", "suffix": "", "firstName": "a", "phoneNumber": "5675675678", "alias": "Address##0", "faxNumber": "", "middleName": "", "state": "GA", "email": "a@a.com" }, "trackingNumber": null, "items": [{ "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100", "deactivationDate": "2018-06-27T12:59:59Z", "rawTotalPrice": 52, "returnedQuantity": 0, "dynamicProperties": [{ "id": "dynamicPropertyMode", "label": "Mode", "value": "pickup" }], "displayName": "Cowboy Shirt", "shippingSurchargeValue": 0, "discountAmount": 0, "externalData": [], "billingAccountId": "billingAcc-123", "preOrderQuantity": 0, "commerceItemId": "ci3000411", "assetId": "asset10001", "price": 52, "variant": [ { "optionValue": "Blue", "optionName": "Color" }, { "optionValue": "Medium", "optionName": "Size" } ], "onSale": false, "primaryImageAltText": "Cowboy Shirt", "actionCode": "Add", "serviceId": "service-123", "stateDetailsAsUser": "The item has been initialized within the shipping group", "serviceAccountId": "serviceAcc-123", "unitPrice": 52, "primaryImageTitle": "Cowboy Shirt", "quantity": 1, "productId": "prod10002", "salePrice": 0, "detailedItemPriceInfo": [{ "discounted": false, "amount": 52, "quantity": 1, "tax": 3.64, "orderDiscountShare": 0, "detailedUnitPrice": 52, "currencyCode": "USD" }], "externalRecurringCharge": 10, "active": true, "externalRecurringChargeFrequency": "Monthly", "externalRecurringChargeDuration": "12", "catRefId": "sku40087", "skuProperties": [{ "propertyType": "sku-base", "name": "UPC Code", "id": "upcCode", "value": "123456" }], "customerAccountId": "customerAcc-123", "discountInfo": [], "route": "/cowboy-shirt/product/prod10002", "detailedRecurringChargeInfo": [{ "discounted": false, "amount": 10, "quantity": 1, "tax": 0, "orderDiscountShare": 0, "detailedUnitPrice": 10, "currencyCode": "USD" }], "activationDate": "2017-06-27T15:30:00Z", "backOrderQuantity": 0, "listPrice": 52, "recurringCharge": 10, "status": "INITIAL" }], "status": "INITIAL" }], "lastModifiedDate": "2015-04-09T07:21:43.000Z", "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."], "shippingMethod": { "cost": 6.5, "value": "ground" }, "priceListGroup": {"repositoryId": "UsDollar"}, "approverMessages": ["I am approving this order"], "creationDate": "2015-04-09T07:11:43.000Z", "orderProfileId": "120029", "paymentGroupId": "pg10004", "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" }} }, "trackingInfo": [{ "carrierName": "OnTrac", "carrierUrl": "http://www.ontrac.com/trackingdetail.asp?tracking=1224", "carrierId": "OnTrac", "trackingNumber": "1224" }], "orderLocale": "en", "shippingAddress": { "lastName": "a", "country": "US", "address3": null, "address2": "a", "city": "a", "address1": "a", "prefix": null, "companyName": null, "postalCode": "30005", "jobTitle": null, "county": null, "suffix": null, "firstName": "a", "phoneNumber": "5675675678", "faxNumber": null, "alias": null, "middleName": null, "state": "GA", "email": "a@a.com" }, "billingAddress": { "lastName": "a", "country": "US", "address3": null, "address2": "a", "city": "a", "address1": "a", "prefix": null, "companyName": null, "postalCode": "30005", "jobTitle": null, "county": null, "suffix": null, "firstName": "a", "phoneNumber": "5675675678", "faxNumber": null, "alias": null, "middleName": null, "state": "GA", "email": "a@a.com" }, "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" }] }