Sync Order
post
/ccstore/v1/orders/{id}/actions/synchronize
This syncs the provided Order to CPQ transaction
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the Order.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : syncOrder_response
Type:
Show Source
object-
additionalEmails:
array additionalEmails
Additional emails to send order confirmation. Default limit is 10.
-
cartName:
string
Cart name for this order.
-
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.
-
discountInfo:
object discountInfo
Discount Information
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
giftWithPurchaseOrderMarker information.
-
lastModifierId:
string
Profile id of the last contact to modify this cart.
-
markers:
array markers
Order markers.
-
onetimeChargesSummary:
array onetimeChargesSummary
The order price information.
-
orderAction:
string
The action performed on the order.
-
orderId:
string
Order ID of the order to remove.
-
priceInfo:
object priceInfo
The order price information.
-
priceListGroup:
object priceListGroup
The price list group object.
-
recurringChargesSummary:
array recurringChargesSummary
The order price information.
- sharedWithOrganization: boolean
-
shippingGroups:
array shippingGroups
The shipping groups for the order.
-
shippingMethod:
object shippingMethod
Shipping Method information of the order.
-
shoppingCart:
object shoppingCart
Shopping cart information.
-
siteId:
string
The id of the site in which the order was created
-
transactionId:
string
CPQ Transaction id
Nested Schema : additionalEmails
Type:
arrayAdditional emails to send order confirmation. Default limit is 10.
Show Source
Nested Schema : discountInfo
Type:
objectDiscount Information
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Order Discount
-
orderImplicitDiscountList:
array orderImplicitDiscountList
Implicit Promotions for the order
-
shippingDiscount:
number
Shipping Discount
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
object unclaimedCouponsMap
The coupons that were not claimed
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygiftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type:
objectThe order price information.
Show Source
-
amount:
number
The total order amount.
-
currencyCode:
string
The currency code.
-
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.
-
totalOneTimeListAmount:
number
Total one time list amount
-
totalOneTimeNetAmount:
number
Total one time net amount
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
repositoryId:
string
Repository ID of the price list group.
Nested Schema : shippingMethod
Type:
objectShipping Method information of the order.
Show Source
-
cost:
number
Cost of shipping method.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
value:
string
Shipping method value.
Nested Schema : shoppingCart
Type:
objectShopping cart information.
Show Source
-
items:
array items
Items in the cart.
-
numberOfItems:
integer
Number of items in the cart.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object-
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 : couponCode
Type:
objectCoupon 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-
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.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object-
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.
Nested Schema : couponCode
Type:
objectCoupon 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.
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-
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
Identifier 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-
key:
string
Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value:
string
Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID
Nested Schema : items
Type:
Show Source
object-
amount:
number
price for whole quantity
-
frequency:
string
Frequency of this summary i.e, per month, per year etc
Nested Schema : items
Type:
Show Source
object-
items:
array items
The array of products in the shipping group.
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingMethod:
object shippingMethod
The shipping method details for the order.
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
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 : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost:
number
The total cost of shipping.
-
shippingMethodDescription:
string
The description of the shipping method.
-
shippingTax:
number
The shipping tax.
-
value:
string
The shipping method applied to the order.
Nested Schema : items
Type:
Show Source
object-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId:
string
The product variant ID.
-
dynamicProperties:
array dynamicProperties
Array of custom properties at order line item level.
-
inventoryLocationId:
string
Defines the inventory location that services the referenced commerce item.
-
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).
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in this shipping group.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
state:
string
state of the commerce Item
-
txnLineNumber:
string
Transaction line number
-
variant:
array variant
List of variants for the product.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
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-
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
The variant option name.
-
optionValue:
string
The variant option value.
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.
-
agreementId:
string
Applied agreement number
-
agreementName:
string
Applied agreement name
-
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
Sku reference ID.
-
charges:
array charges
Charges applied on this commerce item if any.
-
childItems:
array childItems
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
-
childSkus:
array childSkus
An array with single primary image url for this item's sku, or its default image.
-
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.
-
contractEndDate:
string
End date of the contract
-
contractStartDate:
string
Start date of the contract
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
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
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity:
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
externalRecurringCharge:
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
giftWithPurchaseCommerceItemMarker information.
-
id:
string
Repository ID of the commerce item.
-
itemDiscountInfos:
array itemDiscountInfos
Array of promotions received by this item.
-
lastPriced:
string
Date when commerce item is last priced
-
onetimeChargesSummary:
array onetimeChargesSummary
Summary of all one-time charges
-
orderDiscountInfos:
array orderDiscountInfos
Array of order promotions received by this item.
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
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
Price of the items.
-
primaryImageAltText:
string
The product's primary image alternative text.
-
primaryImageTitle:
string
The product's primary image title.Example:
Samsung - F90BN HD Flash Memory Camcorder -
primaryThumbImageURL:
string
The URL of the product's primary image.Example:
/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100 -
productId:
string
ID of the product in the cart.
-
quantity:
integer
Quantity of the items.
-
ratePlanId:
string
Applied ratePlan number for this item
-
ratePlanName:
string
Applied ratePlan name for this item
-
recurringCharge:
number
The recurring charge for the item.
-
recurringChargesSummary:
array recurringChargesSummary
Summary of all recurring charges by frequency
-
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
The UI route to display the product.
-
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.
-
skuProperties:
array skuProperties
Sku properties Information
-
state:
string
state of the commerce Item
-
syncInfo:
object syncInfo
Sync info with CPQ
-
totalOneTimeListAmount:
number
Total one time list amount
-
totalOneTimeNetAmount:
number
Total one time net amount
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
variant:
array variant
List of variants for the product.
Nested Schema : childItems
Type:
arrayThe array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : childSkus
Type:
arrayAn array with single primary image url for this item's sku, or its default image.
Show Source
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:
arraygiftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : itemDiscountInfos
Type:
arrayArray of promotions received by this item.
Show Source
Nested Schema : orderDiscountInfos
Type:
arrayArray of order promotions received by this item.
Show Source
Nested Schema : recurringChargesSummary
Type:
arraySummary of all recurring charges by frequency
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : syncInfo
Type:
objectSync info with CPQ
Show Source
-
errorMessage:
string
Error message during sync with CPQ
-
status:
string
A status flag to indicate whether synced with CPQ
Nested Schema : items
Type:
Show Source
object-
additionalInfo:
object additionalInfo
Additional properties(if any) needed for any down stream system
-
amount:
number
Total Amount w.r.t to quantity.
-
chargeCode:
string
Charge code
-
chargeType:
string
Type of the charge
-
dynamicPricingType:
string
dynamic pricing type i.e., tiered or volume or static.
-
frequency:
string
recurring frequency for this charge. Applicable only for recurring chrages.
-
integrationId:
string
Integration id for this charge
-
isProductPrice:
boolean
This property tells which charge among others is Product price
-
name:
string
Name of the charge
-
priceType:
string
Price type for this charge. i.e., one-time, recurring or usage
-
unitOfMeasure:
string
Unit of Measure. Applicable for only Usage based charges.
-
unitPrice:
number
unit price of the item
Nested Schema : additionalInfo
Type:
objectAdditional properties(if any) needed for any down stream 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 child item is an add-on (externally configured) or not (externally configured).
-
amount:
number
The total amount of this item including its child items amounts.
-
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
skuid of the item.
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName:
string
The name of the product.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity:
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
externalRecurringCharge:
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.
-
id:
string
Repository ID of the 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.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product.
-
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.
-
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.
-
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.
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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
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-
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-
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-
amount:
number
The amount of discount this item received from the promotion.
-
couponCodes:
array couponCodes
One or more coupon codes used to grant the item promotion providing the discount.
-
promotionId:
string
The promotion ID that resulted in the discount.
Nested Schema : couponCodes
Type:
arrayOne or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object-
amount:
number
price for whole quantity
-
price:
number
price for one quantity
Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount of discount this item received from the promotion.
-
couponCodes:
array couponCodes
The array of coupon codes used to grant promotion providing the discount.
-
promotionId:
string
The promotion ID that resulted in the discount.
Nested Schema : couponCodes
Type:
arrayThe array of coupon codes used to grant promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object-
amount:
number
price for whole quantity
-
frequency:
string
Frequency of this summary i.e, per month, per year etc
-
price:
number
price for one quantity
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
The variant option name.
-
optionValue:
string
The variant option value.
Example Response (application/json)
{
"orderId":"o250411",
"dynamicProperties":[
],
"payments":[
],
"description":"o250411",
"organizationId":"or-100001",
"priceInfo":{
"amount":16128,
"total":16128,
"shipping":0,
"totalOneTimeNetAmount":16128,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":16128,
"totalOneTimeListAmount":16128,
"currencyCode":"USD",
"totalWithoutTax":16128
},
"shoppingCart":{
"numberOfItems":6,
"items":[
{
"primaryThumbImageURL":"/img/no-image.jpg",
"rawTotalPrice":1770,
"dynamicProperties":[
],
"displayName":"part100",
"shippingSurchargeValue":0,
"discountAmount":0,
"isItemValid":true,
"externalData":[
],
"description":"part100",
"itemDiscountInfos":[
],
"externalPrice":590,
"commerceItemId":"ci29000411",
"price":1770,
"variant":[
],
"primaryImageAltText":null,
"onSale":false,
"id":"ci29000411",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":10,
"primaryImageTitle":null,
"childSKUs":[
{
"primaryThumbImageURL":null
}
],
"amount":1770,
"quantity":3,
"productId":"part100",
"pointOfNoRevision":false,
"totalOneTimeNetAmount":0,
"salePrice":0,
"orderDiscountInfos":[
],
"contractStartDate":"2025-09-05T00:00:00Z",
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":1770,
"quantity":3,
"configurationDiscountShare":0,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":590,
"currencyCode":"USD"
}
],
"contractEndDate":"2028-09-04T00:00:00Z",
"giftWithPurchaseCommerceItemMarkers":[
],
"originalCommerceItemId":null,
"externalPriceQuantity":-1,
"taxCode":null,
"catRefId":"part100",
"syncInfo":{
"errorMessage":null,
"status":"completed"
},
"lastPriced":"2025-07-09T12:27:03.210Z",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"listingSKUId",
"id":"listingSKUId",
"value":null
},
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
},
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":"part100"
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"partNumber",
"id":"partNumber",
"value":null
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"part100"
},
{
"propertyType":"sku-base",
"name":"Discountable",
"id":"discountable",
"value":true
}
],
"charges":[
{
"unitPrice":490,
"additionalInfo":{
"dynamicPricingType":"static"
},
"priceType":"One Time"
},
{
"unitPrice":100,
"amount":300,
"isProductPrice":true,
"priceType":"One Time",
"name":"One Time",
"chargeType":"ORA_SALE"
}
],
"route":"/part100/product/part100",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"listPrice":10
},
{
"primaryThumbImageURL":"/img/no-image.jpg",
"rawTotalPrice":14358,
"dynamicProperties":[
],
"displayName":"test_product_1",
"shippingSurchargeValue":0,
"discountAmount":0,
"isItemValid":true,
"externalData":[
],
"description":"test_product_1",
"itemDiscountInfos":[
],
"externalPrice":4786,
"commerceItemId":"ci29000412",
"price":14358,
"variant":[
],
"primaryImageAltText":null,
"onSale":false,
"id":"ci29000412",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":10,
"primaryImageTitle":null,
"childSKUs":[
{
"primaryThumbImageURL":null
}
],
"amount":14358,
"quantity":3,
"productId":"test_product_1",
"pointOfNoRevision":false,
"totalOneTimeNetAmount":0,
"salePrice":0,
"orderDiscountInfos":[
],
"contractStartDate":"2025-09-06T00:00:00Z",
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":14358,
"quantity":3,
"configurationDiscountShare":0,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":4786,
"currencyCode":"USD"
}
],
"contractEndDate":"2028-09-05T00:00:00Z",
"giftWithPurchaseCommerceItemMarkers":[
],
"originalCommerceItemId":null,
"externalPriceQuantity":-1,
"taxCode":null,
"catRefId":"test_product_1",
"syncInfo":{
"errorMessage":null,
"status":"completed"
},
"lastPriced":"2025-07-09T12:25:26.762Z",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"listingSKUId",
"id":"listingSKUId",
"value":null
},
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
},
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":"test_product_1"
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"partNumber",
"id":"partNumber",
"value":null
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"test_product_1"
},
{
"propertyType":"sku-base",
"name":"Discountable",
"id":"discountable",
"value":true
}
],
"charges":[
{
"unitPrice":4786,
"amount":14358,
"isProductPrice":true,
"priceType":"One Time",
"name":"One Time",
"chargeType":"ORA_SALE"
}
],
"route":"/test_product_1/product/test_product_1",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"listPrice":10
}
]
},
"additionalEmails":[
],
"lastModifierId":"bb-110034",
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstore/v1/orders/o250411/actions/synchronize"
}
],
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"countryTax":0
},
"priceInfo":{
"amount":16128,
"total":16128,
"lkpValExcludingFreeShip":null,
"shipping":0,
"totalOneTimeNetAmount":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":16128,
"totalOneTimeListAmount":0,
"currencyCode":"USD",
"totalWithoutTax":16128
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"locationId":null,
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":0,
"cost":0,
"taxIncluded":true,
"externalId":null,
"taxCode":"",
"value":"hardgoodShippingGroup",
"shippingMethodDescription":"hardgoodShippingGroup"
},
"shippingGroupId":"sg260412",
"shippingAddress":{
"lastName":null,
"country":null,
"address3":null,
"address2":null,
"city":null,
"prefix":null,
"address1":null,
"postalCode":null,
"companyName":null,
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":null,
"phoneNumber":null,
"faxNumber":null,
"alias":null,
"middleName":null,
"state":null,
"email":null
},
"type":"hardgoodShippingGroup",
"items":[
{
"rawTotalPrice":30,
"returnedQuantity":0,
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"availabilityDate":null,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"externalPrice":590,
"commerceItemId":"ci29000411",
"price":1770,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci29000411",
"unitPrice":10,
"amount":1770,
"quantity":3,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"productId":"part100",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":1770,
"quantity":3,
"configurationDiscountShare":0,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":590,
"currencyCode":"USD"
}
],
"contractStartDate":"2025-09-05T00:00:00Z",
"contractEndDate":"2028-09-04T00:00:00Z",
"externalPriceQuantity":-1,
"catRefId":"part100",
"lastPriced":"2025-07-09T12:27:03.210Z",
"charges":[
{
"unitPrice":490,
"amount":1470,
"additionalInfo":{
"dynamicPricingType":"static"
},
"priceType":"One Time"
},
{
"unitPrice":100,
"amount":300,
"isProductPrice":true,
"priceType":"One Time",
"name":"One Time",
"chargeType":"ORA_SALE"
}
],
"discountInfo":[
],
"siteId":"siteUS",
"txnLineNumber":"2",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":10,
"status":"INITIAL"
},
{
"rawTotalPrice":30,
"returnedQuantity":0,
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"availabilityDate":null,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"externalPrice":4786,
"commerceItemId":"ci29000412",
"price":14358,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci29000412",
"unitPrice":10,
"amount":14358,
"quantity":3,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"productId":"test_product_1",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":14358,
"quantity":3,
"configurationDiscountShare":0,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":4786,
"currencyCode":"USD"
}
],
"contractStartDate":"2025-09-06T00:00:00Z",
"contractEndDate":"2028-09-05T00:00:00Z",
"externalPriceQuantity":-1,
"catRefId":"test_product_1",
"lastPriced":"2025-07-09T12:25:26.762Z",
"charges":[
{
"unitPrice":4786,
"amount":14358,
"isProductPrice":true,
"priceType":"One Time",
"name":"One Time",
"chargeType":"ORA_SALE"
}
],
"discountInfo":[
],
"siteId":"siteUS",
"txnLineNumber":"3",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":10,
"status":"INITIAL"
}
]
}
],
"creationSiteId":"siteUS",
"lastModifiedDate":"2025-07-09T12:27:12.009Z",
"allowAlternateCurrency":false,
"shippingMethod":{
"shippingTax":0,
"cost":0,
"value":"freeShippingMethod"
},
"priceListGroup":{
"repositoryId":"defaultPriceGroup"
},
"cartName":"o250411",
"creationDate":"2025-07-09T12:24:23.435Z",
"transactionId":"3024640692",
"orderAction":"order",
"sharedWithOrganization":false,
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"giftWithPurchaseInfo":[
],
"siteId":"siteUS",
"markers":[
],
"giftWithPurchaseOrderMarkers":[
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|44001|You must provide valid order details to proceed with this order.|
|44002|Your request couldn't be processed at this moment because the order state '{0}' isn't valid. Please contact us for help.|
|44003|Your request couldn't be processed at this moment. Please try again later and if the issue persists, contact us for help.|
|44004|You can't perform this action because the order doesn't belong to you or your associated organization.|
|44005|You can't perform this action because the order doesn't belong to you.|
|
|44006|Your request couldn't be processed at this moment because the required functionality isn't enabled. Please contact us for help.|
|44007|The current synchronization is in progress. Try again later.|
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