Get an order
get
/ccstore/v1/orders/{id}
Retrieves an order based on the ID provided in the URI; returning the order payload.
It can have optional X-CCOrganization header to specify current Organization context of logged in user. However, this endpoint will only return the order details from an organization if the shopper is a part of the organization; i.e. 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(required): string
the ID of the order to retrieve.
Header Parameters
-
X-CCAsset-Language: string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization: string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getOrder_response
Type:
Show Source
object
-
agentId:
string
profile id of the agent associated with the order.
-
allowAlternateCurrency:
boolean
A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
-
approvalSystemMessages:
array approvalSystemMessages
The array of messages which are stored during order processing
-
billingMethod:
object billingMethod
billing Method information of the order.
-
cartName:
string
Cart Name for this order. If the value is passed for the cartName it will set else orderId will be set by default
-
creationDate:
string
Date on which the Order was created.
-
creationSiteId:
string
The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
number
Order creation time.
-
discountInfo:
object discountInfo
Discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
exchangeRate:
number
The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.
-
id:
string
Commerce id for this order.
-
isItemPriceOverrideAllowed:
boolean
Indicates whether an item price can be overridden.
-
lastModifierId:
string
Profile id of the last contact to modify this cart.
-
markers:
array markers
Order markers
-
orderAction:
string
The action performed on the order.
-
orderCancelReason:
string
Reason through which the order has been cancelled.
-
orderComments:
array orderComments
The list of all logged comments for the order.
-
originOfOrder:
string
The source from which order got created.
-
paymentGroup:
object paymentGroup
Payment Group for the order.
-
paymentGroups:
array paymentGroups
List of payment Groups for the order.
-
payShippingInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay Shipping in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
payTaxInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
priceInfo:
object priceInfo
Price information of the order.
-
priceListGroup:
object priceListGroup
PriceList group of the order.
-
profile:
object profile
Profile Information for the order.
-
profileId:
string
The Repository Id of the profile to which this Order belongs to.
-
returnRequests:
array returnRequests
The list of the requests raised for the order.
-
scheduledOrderId:
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:
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.
-
secondaryCurrencyCode:
string
The currency code of secondary currency associated with the site.
- sharedWithOrganization: boolean
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingGroups:
array shippingGroups
Shipping Group Information
-
shippingMethod:
object shippingMethod
Shipping method information.
-
shoppingCart:
object shoppingCart
Shopping cart information.
-
siteId:
string
Site Id on which the order was placed.
-
sourceSystem:
string
The system where the order originated.
-
state:
integer
The order state.
-
stateDetailsAsUser:
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
stateString:
string
Order state as key string.
-
submissionErrorCodes:
array submissionErrorCodes
Set of error codes recorded during each unsuccessful retry of queued orders.
-
submissionErrorMessages:
array submissionErrorMessages
List of failure reasons recorded during each unsuccessful retry of queued orders.
-
submissionProgress:
array submissionProgress
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
-
submittedBy:
string
Profile id of the user who submitted this order if its in submitted state.
-
submittedDate:
string
Date on which the order was submitted.
-
taxPriceInfo:
object taxPriceInfo
The tax pricing details for the order.
-
totalAmountAuthorized:
number
total amount authorized for the order.
Nested Schema : approvalSystemMessages
Type:
array
The array of messages which are stored during order processing
Show Source
Nested Schema : billingMethod
Type:
object
billing Method information of the order.
Show Source
-
cost:
number
billing Cost for this order.
-
displayName:
string
billing method display name for this billing method.
-
value:
string
billing method name for this order.
Nested Schema : discountInfo
Type:
object
Discount information.
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : orderComments
Type:
array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
Show Source
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
balance:
string
The gift card balance available.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
The credit card type.
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
paymentStatString:
string
The payment state as a key string.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount:
number
The raw number that represents the price.
-
billing:
number
The billing cost of the order.
-
currencyCode:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
orderTotalBySite:
object orderTotalBySite
The map containing order totals by site for all sites in a given order.
-
shippingSurchargeValue:
number
The total shiiping surcharge value in the order
-
subTotal:
number
The subtotal of the order before applying order-level promotions.
-
tax:
number
The tax on the order.
-
taxExclusiveAmount:
number
Total excluding shipping and tax in monetary currency
-
total:
number
The current working total, including all promotions, tax, and billing costs.
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active:
boolean
Active status of pricelist group.
-
currency:
object currency
Currency of the PriceList group.
-
deleted:
boolean
Pricelist group deleted status.
-
displayName:
string
Display Name.
-
id:
string
Id.
-
locale:
string
Locale.
-
repositoryId:
string
Repository Id.
Nested Schema : profile
Type:
object
Profile Information for the order.
Show Source
-
email:
string
Email Address corresponding to the profile.
-
firstName:
string
First name of profile.
-
isAnonymous:
boolean
Indicates whether this profile is an anonymous profile. By default, it is false.
-
lastName:
string
Last name of profile.
-
middleName:
string
Middle name of profile.
-
organization:
object organization
The Organization associated with the B2B customer profile.
-
partyId:
number
Party Id of the contact
-
partyNumber:
string
Party Number of the contact
Nested Schema : returnRequests
Type:
array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this shipping address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
tax amount in secondary currency.
-
value:
string
method type of shipment
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items:
array items
Items in the cart.
Nested Schema : submissionErrorCodes
Type:
array
Set of error codes recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionErrorMessages
Type:
array
List of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionProgress
Type:
array
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
cityTax:
number
The monetary amount of city tax.
-
countryTax:
number
The monetary amount of country tax.
-
countyTax:
number
The monetary amount of county tax.
-
currencyCode:
string
The three character currency code.
-
discounted:
boolean
Whether the price was discounted.
-
districtTax:
number
Tax amount for the district.
-
secondaryCurrencyTaxAmount:
number
The monetary total amount of tax.
-
stateTax:
number
Tax amount for the state.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
Nested Schema : items
Type:
Show Source
object
-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
id:
string
The ID of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
key:
string
Order marker key. In a marketing campaign marker, key signifies that it is a campaign marker and it also identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value:
string
Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign ID.
Nested Schema : items
Type:
Show Source
object
-
comment:
string
The comment string.
-
creationDate:
string
Date on which the comment was created.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : billingAddress
Type:
object
Billing address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : items
Type:
Show Source
object
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
balance:
string
The gift card balance available.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName:
string
First name associated with this Payment Group.
-
IIN:
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:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
paymentStateString:
string
The payment state as a key String.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
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.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : orderTotalBySite
Type:
object
The map containing order totals by site for all sites in a given order.
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode:
string
Currency Code.
-
displayName:
string
Display Name.
-
fractionalDigits:
integer
Fractional Digits.
-
numericCode:
string
Numeric Code.
-
repositoryId:
string
Repository Id.
-
symbol:
string
currency Symbol.
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
Nested Schema : items
Type:
Show Source
object
-
authorizationNumber:
string
RMA is the merchant authorization number required for validation
-
createdDate:
string
The creation date of the return request.
-
returnRequestId:
string
The return request id.
-
state:
string
The status of the return request.
-
stateKey:
string
State key for return request which is not localized
-
totalRefund:
number
The total amount to be refunded on return.
-
totalReturnQuantity:
integer
The total quantity for which return request has been raised.
Nested Schema : items
Type:
Show Source
object
-
commerceItemRelationships:
array commerceItemRelationships
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(required):
array items
Items in the cart.
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingMethod:
object shippingMethod
Shipping method information.
-
store:
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
Shipping tracking number.
Nested Schema : commerceItemRelationships
Type:
array
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Show Source
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this shipping address.
-
state_ISOCode:
string
The state ISON code of the shipping address.
-
suffix:
string
Suffix for this shipping address.
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
value:
string
method type of shipment.
Nested Schema : store
Type:
object
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object
-
amount:
number
The monetary value.
-
commerceItemExternalId:
string
The referenced commerce item's external ID.
-
commerceItemId:
string
The referenced commerce item's internal ID.
-
id:
string
The native ID of this item.
-
inventoryLocationId:
string
Defines the inventory location that services the referenced commerce item.
-
quantity:
integer
The quantity of items referenced by this relationship.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
returnedQuantity:
integer
Number of referenced items that were returned.
-
state:
string
The shipping state.
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate:
string
The Availability date of commerce Item.
-
backOrderQuantity:
number
Back Order Quantity of the Items.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
catRefId of the product.
-
commerceItemId:
string
The unique line item ID distinguisher.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
dynamicProperties:
array dynamicProperties
Array of custom properties at order line item level.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
locationInventoryInfoMap:
object locationInventoryInfoMap
Additional Properties Allowed: additionalPropertiesThis is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preOrderQuantity:
number
Pre Order Quantity of the Items.
-
productId:
string
Id of the product.
-
quantity:
integer
quantity of the product.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
skuProperties:
array skuProperties
Sku properties Information
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
variant:
array variant
Product Variant Information.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : locationInventoryInfoMap
Type:
object
Additional Properties Allowed
Show Source
This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
Nested Schema : items
Type:
Show Source
object
-
id:
string
The ID of the dynamic property.
-
label:
string
The label of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : additionalProperties
Type:
Show Source
object
-
availabilityDate:
string
The availabilityDate for preordered/backordered quantity, for this inventory location
-
backOrderQuantity:
integer
The backordered quantity included, for this inventory location
-
inStockQuantity:
integer
The available quantity included that is 'in stock', for this inventory location
-
preOrderQuantity:
integer
The preordered quantity included, for this inventory location
Nested Schema : items
Type:
Show Source
object
-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
carrierId:
string
Carrier Id for Tracking.
-
carrierName:
string
Carrier Name for Tracking.
-
carrierUrl:
string
Carrier URL for Tracking.
-
trackingNumber:
string
Tracking Number
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate:
string
The Availability date of commerce Item.
-
backOrderQuantity:
number
Back Order Quantity of the Items.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Catalog Reference Id of commerce item.
-
childItems:
array childItems
Child items of the commerce item
-
childSKUs:
array childSKUs
Child SKU level detail
-
commerceItemId:
string
The unique id of the line item.
-
configuratorId:
string
Configuration id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
discountAmount:
number
Total discount applied to commerce item.
-
discountInfo:
object discountInfo
Discount information.
-
displayName:
string
Display name of commerce item.
-
dynamicProperties:
array dynamicProperties
Array of custom properties at order line item level.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
number
The Price of the product as per the external pricing system.
-
externalPriceQuantity:
integer
Quantity of the product, the customer is allowed to buy at the external price.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
imageInfo:
object imageInfo
Shipping method information.
-
isPriceOverridden:
boolean
Indicates if commerce item price is overridden or not.
-
locationInventoryInfoMap:
object locationInventoryInfoMap
Additional Properties Allowed: additionalPropertiesThis is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
-
onSale:
boolean
indicates if product is on sale or not
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
overriddenPrice:
number
overridden price of commerce item.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision:
boolean
Point beyond which cancelling the commerce item would be restricted
-
preOrderQuantity:
number
Pre Order Quantity of the Items.
-
price:
number
The raw number that represents the price.
-
priceOverridenBy:
string
Name of the agent who has overridden item price.
-
priceOverrideReason:
object priceOverrideReason
Price override reason map.
-
productId:
string
Product Id of commerce item.
-
quantity:
number
Quantity of the items.
-
rawTotalPrice:
number
The raw total price.
-
returnedQuantity:
number
Quantity for which return request has been raised.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
state:
string
state at the commerce Item level
-
stateDescription:
string
Item state as a key string.
-
stateDetailsAsUser:
string
State description of the commerce item.
-
status:
integer
State of the commerce item.
-
subTotal:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
-
tax:
number
The amount of tax paid for this item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
number
Sale price or list price of commerceItem.
-
variant:
array variant
Product Variant Information.
Nested Schema : discountInfo
Type:
object
Discount information.
Show Source
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : imageInfo
Type:
object
Shipping method information.
Show Source
-
primaryThumbImageURL:
string
ThumbNail Image URL
Nested Schema : locationInventoryInfoMap
Type:
object
Additional Properties Allowed
Show Source
This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
Nested Schema : priceOverrideReason
Type:
object
Price override reason map.
Show Source
-
displayValue:
string
price override reason value.
-
key:
string
price override reason key.
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Product path
-
selectedOptions:
array selectedOptions
Child Product Variant Information.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku Id of the child item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Product path
-
selectedOptions:
array selectedOptions
Child Product Variant Information.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
primaryThumbImageURL:
string
Thumb image URL based on the selected SKU
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
Nested Schema : items
Type:
Show Source
object
-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
id:
string
The ID of the dynamic property.
-
label:
string
The label of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this GWP promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by GWP.
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The gift with purchase promotion id.
Nested Schema : additionalProperties
Type:
Show Source
object
-
availabilityDate:
string
The availabilityDate for preordered/backordered quantity, for this inventory location
-
backOrderQuantity:
integer
The backordered quantity included, for this inventory location
-
inStockQuantity:
integer
The available quantity included that is 'in stock', for this inventory location
-
preOrderQuantity:
integer
The preordered quantity included, for this inventory location
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic SKU Property.
-
optionValue:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
Example Response (application/json)
{
"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",
"orderTotalBySite":{
"siteUS":"62.6"
},
"tax":"4.1",
"subTotal":"52",
"currencyCode":"USD"
},
"lastModifierId":"bb-10001",
"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":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"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":[
],
"parentAssetKey":null,
"active":true,
"originalCommerceItemId":null,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku40087",
"externalRecurringChargeDuration":"12",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"siteId":"siteUS",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":"10",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"10",
"currencyCode":"USD"
}
],
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"recurringCharge":"10"
}
]
},
"submittedBy":"bb-10003",
"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",
"externalId":null,
"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@example.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":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"preOrderQuantity":"0",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"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",
"parentAssetKey":null,
"active":true,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40087",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/cowboy-shirt/product/prod10002",
"siteId":"siteUS",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":"10",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"10",
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"backOrderQuantity":"0",
"listPrice":"52",
"recurringCharge":"10",
"status":"INITIAL"
}
],
"email":"a@example.com",
"status":"INITIAL"
}
],
"creationSiteId":"siteUS",
"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"
],
"cartName":"Test Name",
"creationDate":"2015-04-09T07:11:43.000Z",
"orderProfileId":"120029",
"orderAction":"order",
"paymentGroupId":"pg10004",
"sharedWithOrganization":false,
"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.example.com/trackingdetail.asp?tracking=1224",
"carrierId":"OnTrac",
"trackingNumber":"1224"
}
],
"siteId":"siteUS",
"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@example.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@example.com"
},
"markers":[
{
"repositoryId":"mark100002",
"value":"78900",
"key":"campaign_eloqua"
}
],
"giftWithPurchaseOrderMarkers":[
{
"quantity":"1",
"selectedQuantity":"0",
"removedQuantity":"0",
"data":"-1275480226",
"automaticQuantity":"0",
"giftType":"product",
"autoRemove":true,
"giftDetail":"camera_1",
"repositoryId":"200001",
"failedQuantity":"0",
"value":"promo10002",
"targetedQuantity":"0",
"key":"atg.gwp"
}
]
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
28107 | Specified order does not exist. | Enter a valid order ID. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code