Retrieve an order confirmation by UUID
get
/ccstore/v1/orders/confirmation/{uuid}
Returns the Order Confirmation data specified by the UUID of the Order. The Order Confirmation data expires within 60 seconds of the order being submitted.
This allows anonymous access to retrieve order information for a limited time after the order has been submitted.
Request
Supported Media Types
- application/json
Path Parameters
-
uuid(required): string
the uuid of the order.
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 : getOrderConfirmation_response
Type:
Show Source
object-
additionalEmails:
array additionalEmails
Additional emails to send order confirmation. Default limit is 10.
-
billingAddress:
object billingAddress
The billing address details.
-
cartName:
string
Cart name for this order.
-
creationDate:
string
The creation date in ISO format.
-
creationSiteId:
string
The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
number
The creation time in seconds.
-
discountInfo:
object discountInfo
The order discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo:
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
gift with purchase order marker information
-
id:
string
The order ID.
-
lastModifiedDate:
string
The date the order was last modified in ISO format.
-
lastModifierId:
string
Profile id of the last contact to modify this cart.
-
orderLocale:
string
The locale when the order was submitted.
-
orderProfileId:
string
The profile-id of the order.
-
organizationId:
string
The organization ID, if applicable, for the profile of the order.
-
payments:
array payments
Payment details for the order, including additional properties specific to the payment type.
-
priceInfo:
object priceInfo
The order price information.
-
priceListGroup:
object priceListGroup
The order price list group details.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
- sharedWithOrganization: boolean
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingGroup:
object shippingGroup
The 1st shipping group for the order.
-
shippingGroups:
array shippingGroups
The shipping groups for the order.
-
shippingMethod:
object shippingMethod
The 1st shipping group method details for the order.
-
shoppingCart:
object shoppingCart
The items of the order.
-
siteId:
string
The ID of the site on which the order was placed.
-
sourceSystem:
string
The system where the order originated.
-
state:
string
The state of the order.
-
submittedBy:
string
Profile id of the user who submitted this order if its in submitted state.
-
submittedDate:
string
The order submitted date in ISO format.
-
taxPriceInfo:
object taxPriceInfo
The order tax price information details.
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
The tracking number.
-
uuid:
string
The universally unique ID for the order.
Nested Schema : additionalEmails
Type:
arrayAdditional emails to send order confirmation. Default limit is 10.
Show Source
Nested Schema : billingAddress
Type:
objectThe billing address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country code.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name.
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
state:
string
State.
-
suffix:
string
Name suffix.
Nested Schema : discountInfo
Type:
objectThe order discount information.
Show Source
-
discountDescList:
array discountDescList
The list of all the order discounts.
-
orderDiscount:
number
The total order discount amount.
-
shippingDiscount:
number
The shipping discount amount.
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygift with purchase order marker information
Show Source
Nested Schema : payments
Type:
arrayPayment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type:
objectThe order price information.
Show Source
-
amount:
number
The total order amount.
-
currencyCode:
string
The currency code.
-
orderTotalBySite:
object orderTotalBySite
The map containing order totals by site for all sites in a given order.
-
primaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. -
secondaryCurrencyShippingAmount:
number
This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. -
secondaryCurrencyShippingSurchargeValue:
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount:
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency. -
secondaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in custom currency.
2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency. -
shipping:
number
The total shipping cost.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
subTotal:
number
The sub-total amount.
-
tax:
number
The total tax amount.
-
taxExclusiveAmount:
number
Total excluding shipping and tax in monetary currency
-
total:
number
The order total.
Nested Schema : priceListGroup
Type:
objectThe order price list group details.
Show Source
-
active:
boolean
Active status of the price list group.
-
currency:
object currency
The currency object.
-
deleted:
boolean
Property to determine existence of the price list group.
-
displayName:
string
Display name of the price list group.
-
id:
string
ID of the price list group.
-
listPriceList:
object listPriceList
List price list details.
-
locale:
string
Locale of the price list group.
-
repositoryId:
string
Repository ID of the price list group.
-
salePriceList:
object salePriceList
Sale price list details.
-
shippingSurchargePriceList:
object shippingSurchargePriceList
Shipping Surcharge PriceList object.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals:
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals:
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping:
number
Cost of shipping the product.
-
subTotal:
number
The sub-total price of the recurring charge.
-
tax:
number
Monetary tax amount.
-
total:
number
The total price of the recurring charge.
-
totalWithoutTax:
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name.
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingGroup
Type:
objectThe 1st shipping group for the order.
Show Source
-
shippingMethodDescription:
string
The shipping method description for the order.
Nested Schema : shippingMethod
Type:
objectThe 1st shipping group method details for the order.
Show Source
-
cost:
number
The total cost of shipping.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
shippingTax:
number
The shipping tax for the order.
-
value:
string
The shipping method ID for the order.
Nested Schema : shoppingCart
Type:
objectThe items of the order.
Show Source
-
items:
array items
The array of items in the order.
Nested Schema : taxPriceInfo
Type:
objectThe order tax price information details.
Show Source
-
amount:
number
The total tax amount.
-
cityTax:
number
The city tax amount.
-
countryTax:
number
The country tax amount.
-
countyTax:
number
The county tax amount.
-
districtTax:
string
The district tax amount.
-
isTaxIncluded:
boolean
Flag that states whether tax is included.
-
miscTax:
string
The miscellaneous tax amount.
-
secondaryCurrencyTaxAmount:
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency.
Prerequisites for the value in this Attribute:
1. PriceList configured for the site is in Monetary Currency.2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled
3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.
-
stateTax:
number
The state tax amount.
-
valueAddedTax:
number
The value added tax.
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon code.
-
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 promotion ID.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of 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. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseDetail:
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftWithPurchaseIdentifier:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
giftWithPurchaseQuantityAvailableForSelection:
number
gift quantity available for selection
-
giftWithPurchaseType:
string
The type of the gift. (sku, product)
-
promotionId:
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail:
string
String identifying the free gift, usually the repository ID of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
atg.gwp
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value:
string
The gift with purchase promotion ID
Nested Schema : items
Type:
Show Source
object-
amount:
number
Amount authorized from the payment group.
-
balance:
number
Total available balance on the gift card.
-
gatewayName:
string
Payment gateway name. e.g. chaseCreditCard.
-
giftCardNumber:
string
Gift card number.
-
isAmountRemaining:
boolean
A boolean to decide if more payment can be made from this payment group.
-
maskedCardNumber:
string
Masked gift card number.
-
paymentGroupId:
string
Payment group ID.
-
paymentMethod:
string
Payment method. e.g. physicalGiftCard/ creditCard.
-
paymentState:
string
The state of the payment group. e.g. AUTHORIZED.
-
PONumber:
string
Purchase order number for invoice payment. Payment type: invoice
-
savedCardId:
string
ID of the saved card associated with the payment group.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP.
Nested Schema : orderTotalBySite
Type:
objectThe map containing order totals by site for all sites in a given order.
Nested Schema : currency
Type:
objectThe currency object.
Show Source
-
currencyCode:
string
The currency code.
-
displayName:
string
Display name of the currency.
-
fractionalDigits:
integer
Number of fractional digits for the currency.
-
numericCode:
string
Numeric code of the currency.
-
repositoryId:
string
Repository ID of the currency.
-
symbol:
string
The currency symbol.
Nested Schema : listPriceList
Type:
objectList price list details.
Show Source
-
repositoryId:
string
Repository ID of the list price list.
Nested Schema : salePriceList
Type:
objectSale price list details.
Show Source
-
repositoryId:
string
Repository ID of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
objectShipping Surcharge PriceList object.
Show Source
-
repositoryId:
string
Repository ID of the shipping surcharge price list.
Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's total e.g. Monthly.
-
total:
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's tax e.g. Monthly.
-
tax:
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
actualShipDate:
string
The actual ship date in ISO format.
-
discountInfo:
object discountInfo
The shipping group price information.
-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items:
array items
The array of products in the shipping group.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
priceInfo:
object priceInfo
The shipping group price information.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
shipOnDate:
string
The ship on date in ISO format.
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingGroupId:
string
The shipping group ID.
-
shippingMethod:
object shippingMethod
The shipping method details.
-
status:
string
The shipping group status.
-
store:
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
submittedDate:
string
The submitted date in ISO format.
-
taxPriceInfo:
object taxPriceInfo
The shipping tax price info details.
-
trackingNumber:
string
The tracking number.
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
Nested Schema : discountInfo
Type:
objectThe shipping group price information.
Show Source
-
discountDescList:
array discountDescList
The list of all the order discounts.
-
orderDiscount:
number
The order discount.
-
secondaryCurrencyShippingDiscount:
number
The shipping discount in secondary currency in case of mix currency scenario.
-
shippingDiscount:
number
The shipping discount.
Nested Schema : priceInfo
Type:
objectThe shipping group price information.
Show Source
-
amount:
number
The item amount.
-
currencyCode:
string
The currency code.
-
primaryCurrencyTotal:
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount:
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue:
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
secondaryCurrencyTotal:
number
The current total (sum of shipping and tax)amount in monetry currency
-
shipping:
number
The shipping amount.
-
shippingSurchargeValue:
number
The shipping surcharge value amount.
-
subTotal:
number
The shipping group subtotal.
-
tax:
number
The shipping method tax amount.
-
total:
number
The total amount.
-
totalWithoutTax:
number
The total without tax.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals:
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals:
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping:
number
Cost of shipping the product.
-
subTotal:
number
The sub-total price of the recurring charge.
-
tax:
number
Monetary tax amount.
-
total:
number
The total price of the recurring charge.
-
totalWithoutTax:
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country code.
-
countryName:
string
Country name in the current locale.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name.
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
state:
string
State.
-
suffix:
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details.
Show Source
-
cost:
number
The total cost of shipping.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
shippingMethodDescription:
string
The description of the shipping method.
-
shippingTax:
number
The shipping tax.
-
value:
string
The shipping method applied to the order.
Nested Schema : store
Type:
objectInformation about the Store that the 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 : taxPriceInfo
Type:
objectThe shipping tax price info details.
Show Source
-
amount:
number
The tax amount.
-
cityTax:
number
The city tax amount.
-
countryTax:
number
The country tax total.
-
countyTax:
number
The county tax amount.
-
districtTax:
number
The district tax amount.
-
isTaxIncluded:
boolean
Flag that states whether is tax included.
-
miscTax:
number
The miscellaneous tax amount.
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
stateTax:
number
The state tax amount.
-
valueAddedTax:
number
The value added tax .
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon code.
-
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 promotion ID.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
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.
-
active:
boolean
UIs this product active.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetKey:
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
The catalog reference ID/SKU ID.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedItemPriceInfo:
array detailedItemPriceInfo
Detailed Item Price Information.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount:
number
The discount amount.
-
displayName:
string
Display Name.
-
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.
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
-
inventoryLocationId:
string
Defines the inventory location that services the referenced commerce item.
-
listPrice:
number
List Price.
-
onSale:
boolean
Indicates whether the price is for an item that is on sale.
-
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.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
primaryImageAltText:
string
Primary Image Alternative Text.
-
primaryImageTitle:
string
Primary Image Title.
-
primaryThumbImageURL:
string
Primary Thumb Image URL.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in this shipping group.
-
rawTotalPrice:
number
Raw Total Price.
-
recurringCharge:
number
The recurring charge for the item.
-
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.
-
route:
string
route.
-
salePrice:
number
Sale Price.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shippingSurchargeValue:
number
shipping surcharge value.
-
siteId:
string
The ID of the site on which the item was added.
-
state:
string
state of the commerce Item
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
number
The unit price.
-
variant:
array variant
List of variants for the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount:
number
The monetary amount for the recurring charge.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
- orderDiscountShare: number
-
quantity:
integer
The number of items covered by this recurring charge price info
-
tax:
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount.
-
currencyCode:
string
The currency code.
-
detailedUnitPrice:
number
Detailed Unit Price.
-
discounted:
boolean
Is this item discounted.
- orderDiscountShare: number
-
quantity:
integer
The quantity.
-
tax:
number
The tax amount.
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. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
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:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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
The variant option name.
-
optionValue:
string
The variant option value.
Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's total e.g. Monthly.
-
total:
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's tax e.g. Monthly.
-
tax:
string
The tax amount for the frequency.
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 assigned only 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
The catalog reference ID/SKU ID of the item.
-
childItems:
array childItems
-
commerceItemId:
string
The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedItemPriceInfo:
array detailedItemPriceInfo
Detailed Item Price Information.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
discountAmount:
number
The rdiscount amount for the item.
-
discountInfo:
array discountInfo
The discount information.
-
displayName:
string
The display name of the product.
-
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.
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
id:
string
The item ID in the order.
-
listPrice:
number
The list price of the product.
-
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.
-
price:
number
The actual price of the product.
-
productId:
string
ID of the product.
-
quantity:
integer
The quantity of the item.
-
rawTotalPrice:
number
The raw price of the product.
-
recurringCharge:
number
The recurring charge for the item.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
salePrice:
number
The sale price of the product.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
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.
-
state:
string
state of the commerce Item
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
number
The unit price of the product.
-
variant:
array variant
List of variants for the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount:
number
The monetary amount for the recurring charge.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
- orderDiscountShare: number
-
quantity:
integer
The number of items covered by this recurring charge price info
-
tax:
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arrayThe array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
addOnItem:
boolean
Whether this child item is an add-on (internally configured) or not (externally configured).
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this 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.
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount.
-
currencyCode:
string
The currency code.
-
detailedUnitPrice:
number
Detailed Unit Price.
-
discounted:
boolean
Is this item discounted.
- orderDiscountShare: number
-
quantity:
integer
The quantity.
-
tax:
number
The tax amount.
Nested Schema : items
Type:
Show Source
object-
coupon:
string
The coupon ID.
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
giftWithPurchaseDiscountInfo:
array giftWithPurchaseDiscountInfo
The gift information.
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The promotion ID.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment by the promotion.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseChoicesAvailable:
boolean
If this gift with purchase has multiple gift choices.
-
giftWithPurchaseIdentifier:
integer
The gift hash code for this gift with purchase promotion.
-
giftWithPurchaseQuantity:
number
The quantity that is gift quantity
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. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.
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:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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 gift with purchase promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by gift with purchase.
-
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 : items
Type:
Show Source
object-
optionName:
string
The variant option name.
-
optionValue:
string
The variant option value.
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.
Example Response (application/json)
{
"creationTime":"1479743766427",
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"payments":[
{
"paymentGroupId":"pg70442",
"amount":58.03,
"customPaymentProperties":{
"custProp2":"100",
"custProp1":"12"
},
"gatewayName":"chaseCreditCard",
"uiIntervention":null,
"paymentMethod":"creditCard",
"isAmountRemaining":true,
"paymentState":"AUTHORIZED"
}
],
"submittedDate":"2016-11-21T15:56:35.174Z",
"uuid":"6be4196a-ce3c-4fae-bc04-724c40729a05",
"organizationId":null,
"priceInfo":{
"amount":46.8,
"total":58.03,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":5.28,
"subTotal":52,
"currencyCode":"USD",
"totalWithoutTax":52.75
},
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":52,
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"displayName":"Cowboy Shirt",
"shippingSurchargeValue":0,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"discountAmount":0,
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"price":52,
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"actionCode":"Add",
"id":"ci4000032",
"serviceId":"service-123",
"unitPrice":52,
"serviceAccountId":"serviceAcc-123",
"quantity":1,
"productId":"prod10002",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":52,
"quantity":1,
"tax":4.68,
"orderDiscountShare":5.2,
"detailedUnitPrice":52,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"giftWithPurchaseCommerceItemMarkers":[
],
"parentAssetKey":null,
"originalCommerceItemId":null,
"externalRecurringChargeFrequency":"Monthly",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40087",
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"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,
"listPrice":52,
"recurringCharge":10
}
]
},
"additionalEmails":[
"w.rubble@bedrock.com",
"w.flintstone@bedrock.com"
],
"lastModifierId":"bb-10001",
"links":[
{
"rel":"self",
"href":"http://www.example.com/ccstoreui/v1/orders/6be4196a-ce3c-4fae-bc04-724c40729a05"
}
],
"state":"SUBMITTED",
"id":"o90008",
"trackingNumber":"1224",
"submittedBy":"bb-10003",
"taxPriceInfo":{
"cityTax":1.85,
"amount":5.28,
"valueAddedTax":0,
"countyTax":1.32,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":2.11,
"countryTax":0
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":1.85,
"amount":5.28,
"valueAddedTax":0,
"countyTax":1.32,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":2.11,
"countryTax":0
},
"shippingMethod":{
"shippingTax":0.6,
"cost":5.95,
"externalId":null,
"value":"ground",
"shippingMethodDescription":"Ground"
},
"shippingGroupId":"sg10032",
"submittedDate":null,
"priceInfo":{
"amount":46.8,
"total":58.03,
"shipping":5.95,
"shippingSurchargeValue":0,
"tax":5.28,
"subTotal":52,
"currencyCode":"USD",
"totalWithoutTax":52.75
},
"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":5.2,
"orderDiscountDescList":[
{
"promotionLevel":"order",
"promotionDesc":"10% off Orders over $40",
"promotionId":"promo20011"
}
],
"shippingDiscount":0
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"Shopper",
"country":"US",
"address3":"",
"address2":"",
"city":"Springfield",
"address1":"1 Main Street",
"prefix":"",
"companyName":"",
"postalCode":"36130",
"jobTitle":"",
"regionName":"Alabama",
"county":"",
"suffix":"",
"firstName":"Test",
"phoneNumber":"5675675678",
"alias":"Address##0",
"faxNumber":"",
"middleName":"",
"state":"AL",
"countryName":"United States",
"email":"a@example.com"
},
"trackingNumber":"1224",
"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",
"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,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"productId":"prod10002",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":52,
"quantity":1,
"tax":4.68,
"orderDiscountShare":5.2,
"detailedUnitPrice":52,
"currencyCode":"USD"
}
],
"externalRecurringCharge":10,
"parentAssetKey":null,
"active":true,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40087",
"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,
"listPrice":52,
"recurringCharge":10,
"status":"INITIAL"
}
],
"status":"INITIAL"
}
],
"lastModifiedDate":"2016-11-21T15:56:35.405Z",
"creationSiteId":"siteUS",
"shippingMethod":{
"shippingTax":0.6,
"cost":5.95,
"value":"ground"
},
"priceListGroup":{
"endDate":null,
"displayName":"Default Price Group",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
},
"deleted":false,
"repositoryId":"defaultPriceGroup",
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"includeAllProducts":true,
"startDate":null
},
"cartName":"mck Order",
"creationDate":"2016-11-21T15:56:06.427Z",
"orderProfileId":"120693",
"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":{
"orderDiscount":5.2,
"orderDiscountDescList":[
{
"promotionLevel":"order",
"promotionDesc":"10% off Orders over $40",
"promotionId":"promo20011"
}
],
"shippingDiscount":0
},
"trackingInfo":[
{
"carrierName":"OnTrac",
"carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
"carrierId":"OnTrac",
"trackingNumber":"1224"
}
],
"orderLocale":"en",
"shippingAddress":{
"lastName":"Shopper",
"country":"US",
"address3":"",
"address2":"",
"city":"Springfield",
"address1":"1 Main Street",
"prefix":"",
"companyName":"",
"postalCode":"36130",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Test",
"phoneNumber":"5675675678",
"faxNumber":"",
"alias":"Address",
"middleName":"",
"state":"AL",
"email":"a@example.com"
},
"siteId":"siteUS",
"billingAddress":{
"lastName":"Shopper",
"country":"US",
"address3":"",
"address2":"",
"city":"Springfield",
"address1":"1 Main Street",
"prefix":"",
"companyName":"",
"postalCode":"36130",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"Test",
"phoneNumber":"5675675678",
"faxNumber":"",
"alias":null,
"middleName":"",
"state":"AL",
"email":"a@example.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 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 |
|---|---|---|
| 28355 | Order confirmation not found. | Confirmation data has probably expired, you will need to use an authenticated endpoint to get order information. |
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:
arrayAn 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