Submit the current order (cart)
post
/ccstore/v1/orders/current/submit
This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.
Submits the current Order. This endpoint will also capture and authorise payment before submitting the order. If Store Credit or Gift Card payments have been previously applied only the payment group ID and type need to be provided.
This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization: string
Current organization context of the logged in user
-
X-CCVisitorId: string
ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.
Root Schema : submit_request
Type:
Show Source
object-
payments:
array payments
Payment details for the order.
Example:
{
"payments":[
{
"cardCVV":"111",
"nameOnCard":"test test",
"cardType":"visa",
"expiryMonth":"01",
"expiryYear":"2021",
"billingAddress":{
"lastName":"Bloggs",
"country":"US",
"address3":"",
"address2":"",
"city":"Florida City",
"prefix":"",
"address1":"111 Florida Dr",
"postalCode":"33034",
"jobTitle":"",
"companyName":"",
"county":"",
"suffix":"",
"type":"",
"firstName":"Joe",
"phoneNumber":"",
"alias":"",
"faxNumber":"",
"middleName":"",
"state":"FL",
"email":null,
"state_ISOCode":"US-FL"
},
"type":"card",
"cardNumber":"4111111111111111"
}
]
}Nested Schema : items
Type:
Show Source
object-
amount:
number
Amount to be authorized from the payment.
-
billingAddress:
object billingAddress
The billing address details.
-
cardCVV:
string
Credit/Debit card secret pin. Payment type:card.
-
cardNumber:
string
Credit/Debit card number used for payment. Payment type:card.
-
cardType:
string
Credit/Debit card type. e.g. visa. Payment type:card.
-
cardTypeName:
string
Credit/Debit card type name. e.g. Visa. Payment type:card.
-
customProperties:
object customProperties
Custom object with dynamic properties. This will be passed to the webhook request
-
endMonth:
string
Credit/Debit card expiry month. Payment type:card.
-
endYear:
string
Credit/Debit card expiry year. Payment type:card.
-
expiryMonth:
string
Credit/Debit card expiry month. Payment type:card.
-
expiryYear:
string
Credit/Debit card expiry year. Payment type:card.
-
giftCardNumber:
string
Gift card number used for payment. Payment type:physicalGiftCard.
-
giftCardPin:
string
Gift card pin. Payment type:physicalGiftCard.
-
nameOnCard:
string
Name on the credit/debit card. Payment type:card.
-
nickname:
string
card nickname
-
PayerID:
string
Payer ID relevant to paypal checkout type. Payment type:paypalCheckout.
-
paymentGroupId:
string
Payment Group ID of the gift card payment group. Payment type:physicalGiftCard.
-
paymentId:
string
Payment ID relevant to the payment type. Payment type:paypalCheckout | payUWebLatamCheckout.
-
PONumber:
string
Purchase order number for invoice payment. Payment type:invoice
-
saveCard:
boolean
Property that determines whether to save this card or not.
-
savedCardId:
string
ID of the saved card
-
setAsDefault:
boolean
Property to set this card as default card.
-
token:
string
Token generated on the client-side for eg. in case of hosted or transparent payment processing.
-
type:
string
Payment type: payULatamWebcheckout | paypalCheckout | card | invoice | physicalGiftCard | cash | storeCredit
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.
-
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 code.
-
suffix:
string
Name suffix.
Nested Schema : customProperties
Type:
objectCustom object with dynamic properties. This will be passed to the webhook request
Response
Supported Media Types
- application/json
200 Response
The model being returned when the POST operation succeeds. It contains an Order representation.
Root Schema : submit_response
Type:
Show Source
object-
approvalSystemMessages:
array approvalSystemMessages
An array of approval messages when order going in pending approval state
-
billingAddress:
object billingAddress
The billing address details.
-
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 long seconds.
-
discountInfo:
object discountInfo
The 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.
-
markers:
array markers
Order markers
-
orderAction:
string
The action performed on 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 price list group object.
-
pricingMessages:
object pricingMessages
The Pricing messages information.
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingGroups:
array shippingGroups
The shipping groups for the order.
-
shippingMethod:
object shippingMethod
The shipping method details for the order.
-
shoppingCart:
object shoppingCart
The shopping cart contents of the current order.
-
siteId:
string
The id of the site in which the order was created
-
sourceSystem:
string
The system where the order originated.
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
uuid:
string
The unique ID for the order.
Nested Schema : approvalSystemMessages
Type:
arrayAn array of approval messages when order going in pending approval state
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 code.
-
suffix:
string
Name suffix.
Nested Schema : discountInfo
Type:
objectThe discount information.
Show Source
-
orderDiscount:
number
The order discount.
-
orderDiscountDescList:
array orderDiscountDescList
The list of all the order discounts.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
shippingDiscount:
number
The shipping discount.
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 price list group object.
Show Source
-
repositoryId:
string
Repository ID of the price list group.
Nested Schema : pricingMessages
Type:
objectThe Pricing messages information.
Show Source
-
giftWithPurchaseMessages:
array giftWithPurchaseMessages
The gift with purchase messages information.
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.
-
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 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.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
value:
string
The shipping method applied to the order.
Nested Schema : shoppingCart
Type:
objectThe shopping cart contents of the current order.
Show Source
-
items:
array items
The array of products in the shopping cart.
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.
-
secondaryCurrencyTotalAdjustment:
number
The total adjustment in monetary currency.
-
totalAdjustment:
number
Total Adjustment 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. 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-
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 the case of a marketing campaign, it represents the actual unique campaign 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. chaseGiftCard.
-
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
-
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 : giftWithPurchaseMessages
Type:
arrayThe gift with purchase messages information.
Show Source
Nested Schema : items
Type:
Show Source
object-
identifier:
string
The pricing message identifier.
-
params:
array params
The list of all message parameters.
-
priority:
integer
The pricing message priority.
-
summary:
string
The pricing message summary.
-
type:
string
The pricing message type.
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 from which 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.
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
The tracking number.
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : discountInfo
Type:
objectThe shipping group price information.
Show Source
-
discountDescList:
array discountDescList
The list of all the order discounts.
-
orderDiscount:
number
The orderDiscount.
-
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 shipping method amount.
-
currencyCode:
string
The shipping method amount.
-
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
The current total 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 cost of shipping.
-
totalWithoutTax:
number
The shipping items total.
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.
-
county:
string
County.
-
email(required):
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 code.
-
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 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 : taxPriceInfo
Type:
objectThe shipping tax price info details.
Show Source
-
amount:
number
The shipping method amount.
-
cityTax:
number
The shipping group subtotal.
-
countryTax:
number
The country tax total.
-
countyTax:
number
The county tax amount.
-
districtTax:
string
The shipping method applied to the order.
-
isTaxIncluded:
boolean
Flag that states whether is tax included.
-
miscTax:
string
The miscellaneous tax amount.
-
secondaryCurrencyTaxAmount:
number
The monetary total amount of tax.
-
stateTax:
number
The shipping method 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.
-
availabilityDate:
string
The Availability date of commerce Item.
-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
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
The product variant 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.
-
listPrice:
string
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).
-
preOrderQuantity:
number
Pre Order Quantity of the Items.
-
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:
string
Raw Total Price.
-
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.
-
route:
string
route.
-
salePrice:
string
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.
-
skuProperties:
array skuProperties
Sku properties Information
-
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-
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 : 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-
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 assigned only 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
The product variant ID.
-
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.
-
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.
-
discountInfo:
array discountInfo
The discount 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.
-
id:
string
Repository ID of the commerce item.
-
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
Point beyond which cancelling the commerce item would be restricted
-
preOrderQuantity:
number
Pre Order Quantity of the Items.
-
price:
number
The actual price of the product.
-
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
The quantity 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.
-
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 at the commerce Item level
-
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 : 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 : orderDiscountInfos
Type:
arrayArray of order promotions received by this item.
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-
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-
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-
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-
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":"1573645921000",
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
],
"payments":[
{
"paymentGroupId":"pg230428",
"amount":"14.99",
"customPaymentProperties":{
"sample-addnl-property-key2":"sample-payment-property-value2"
},
"gatewayName":"demoGenericGiftCardGateway",
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"AUTHORIZED",
"currencyCode":"USD",
"maskedCardNumber":"xxxxxxxxxxxxxxx4103"
}
],
"submittedDate":"2019-11-13T11:54:01.117Z",
"uuid":"c52bb39e-c957-4f74-91db-22f7dcf83794",
"priceInfo":{
"amount":"14.99",
"total":"14.99",
"shipping":"0",
"shippingSurchargeValue":"0",
"orderTotalBySite":{
"siteUS":"14.99"
},
"tax":"0",
"subTotal":"14.99",
"currencyCode":"USD",
"totalWithoutTax":"14.99"
},
"shoppingCart":{
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
"rawTotalPrice":"14.99",
"displayName":"Dr. Dolittle",
"dynamicProperties":[
],
"shippingSurchargeValue":"0",
"discountAmount":"0",
"externalData":[
],
"commerceItemId":"ci21000417",
"price":"14.99",
"variant":[
],
"primaryImageAltText":"Dr. Dolittle",
"id":"ci21000417",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":"14.99",
"primaryImageTitle":"Dr. Dolittle",
"childSKUs":[
{
"primaryThumbImageURL":null
}
],
"amount":"14.99",
"quantity":"1",
"productId":"Product_18Cxi",
"pointOfNoRevision":false,
"salePrice":"0",
"orderDiscountInfos":[
],
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":"0",
"amount":"14.99",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"14.99",
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"originalCommerceItemId":null,
"catRefId":"Sku_18Dxi",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
},
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_18Dxi"
},
{
"propertyType":"sku-base",
"name":"Discountable",
"id":"discountable",
"value":true
}
],
"route":"/dr-dolittle/product/Product_18Cxi",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"markers":[
{
"repositoryId":"mark100001",
"value":"78900",
"key":"campaign_eloqua"
}
],
"listPrice":"14.99"
}
]
},
"links":[
{
"method":"PATCH",
"rel":"/rels/patchCurrentOrder",
"href":"http://localhost:8080/ccstoreui/v1/orders/current"
},
{
"method":"GET",
"rel":"/rels/getIncompleteOrder",
"href":"http://localhost:8080/ccstoreui/v1/orders/current"
},
{
"method":"POST",
"rel":"/rels/priceCurrentOrder",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/price"
},
{
"method":"POST",
"rel":"/rels/submitCurrentOrder",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/submit"
}
],
"id":"o200415",
"state":"SUBMITTED",
"taxPriceInfo":{
"cityTax":"0",
"secondaryCurrencyTaxAmount":"0",
"amount":"0",
"valueAddedTax":"0",
"countyTax":"0",
"isTaxIncluded":false,
"miscTax":"0",
"districtTax":"0",
"stateTax":"0",
"countryTax":"0"
},
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":"0",
"secondaryCurrencyTaxAmount":"0",
"amount":"0",
"valueAddedTax":"0",
"countyTax":"0",
"isTaxIncluded":false,
"miscTax":"0",
"districtTax":"0",
"stateTax":"0",
"countryTax":"0"
},
"priceInfo":{
"amount":"14.99",
"total":"14.99",
"lkpValExcludingFreeShip":null,
"shipping":"0",
"shippingSurchargeValue":"0",
"tax":"0",
"subTotal":"14.99",
"currencyCode":"USD",
"totalWithoutTax":"14.99"
},
"discountInfo":{
"orderDiscount":"0",
"shippingDiscount":"0",
"discountDescList":[
]
},
"trackingInfo":[
],
"shippingMethod":{
"secondaryCurrencyTaxAmount":"0",
"shippingTax":"0",
"cost":"0",
"taxIncluded":true,
"externalId":null,
"taxCode":"",
"value":"freeShippingMethod",
"shippingMethodDescription":"Free Shipping"
},
"shippingGroupId":"sg210415",
"shippingAddress":{
"lastName":"Blogs",
"country":"US",
"address3":"3 The Street",
"address2":"2 The Street",
"city":"The City",
"prefix":"The Prefix",
"address1":"1 The Street",
"postalCode":"01887",
"companyName":"CompanyName",
"jobTitle":"The Job Title",
"county":null,
"suffix":"The Suffix",
"firstName":"Joe",
"phoneNumber":"331234567",
"faxNumber":"331234567",
"alias":null,
"middleName":"Syd",
"state":"MA",
"email":"p.p@GGGG.com"
},
"type":"hardgoodShippingGroup",
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
"rawTotalPrice":"14.99",
"returnedQuantity":"0",
"dynamicProperties":[
],
"displayName":"Dr. Dolittle",
"shippingSurchargeValue":"0",
"externalData":[
],
"discountAmount":"0",
"preOrderQuantity":"0",
"commerceItemId":"ci21000417",
"price":"14.99",
"variant":[
],
"onSale":false,
"primaryImageAltText":"Dr. Dolittle",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci21000417",
"unitPrice":"14.99",
"primaryImageTitle":"Dr. Dolittle",
"amount":"14.99",
"quantity":"1",
"pointOfNoRevision":false,
"productId":"Product_18Cxi",
"salePrice":"0",
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":"0",
"amount":"14.99",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"14.99",
"currencyCode":"USD"
}
],
"active":true,
"catRefId":"Sku_18Dxi",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
},
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName"
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_18Dxi"
},
{
"propertyType":"sku-base",
"name":"Discountable",
"id":"discountable",
"value":true
}
],
"discountInfo":[
],
"route":"/dr-dolittle/product/Product_18Cxi",
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":"0",
"listPrice":"14.99",
"status":"INITIAL"
}
],
"status":"INITIAL"
}
],
"lastModifiedDate":"2019-11-13T11:54:01.118Z",
"creationSiteId":"siteUS",
"approvalSystemMessages":[
],
"shippingMethod":{
"shippingTax":"0",
"cost":"0",
"value":"freeShippingMethod"
},
"priceListGroup":{
"isTaxIncluded":false,
"endDate":null,
"displayName":"Default Price Group",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"isPointsBased":false,
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
},
"deleted":false,
"taxCalculationType":null,
"repositoryId":"defaultPriceGroup",
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"currencyType":null,
"symbol":"$",
"deleted":false,
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":"2",
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"includeAllProducts":true,
"startDate":null
},
"creationDate":"2019-11-13T11:52:01.000Z",
"orderProfileId":"310062",
"orderAction":"order",
"discountInfo":{
"orderDiscount":"0",
"orderDiscountDescList":[
],
"shippingDiscount":"0"
},
"trackingInfo":[
],
"orderLocale":"en",
"shippingAddress":{
"lastName":"Blogs",
"country":"US",
"address3":"3 The Street",
"address2":"2 The Street",
"city":"The City",
"prefix":"The Prefix",
"address1":"1 The Street",
"postalCode":"01887",
"companyName":"CompanyName",
"jobTitle":"The Job Title",
"county":null,
"suffix":"The Suffix",
"firstName":"Joe",
"phoneNumber":"331234567",
"faxNumber":"331234567",
"alias":null,
"middleName":"Syd",
"state":"MA",
"email":"p.p@GGGG.com"
},
"siteId":"siteUS",
"billingAddress":{
"lastName":"Blogs",
"country":"US",
"address3":"3 The Street",
"address2":"2 The Street",
"city":"The City",
"prefix":"The Prefix",
"address1":"1 The Street",
"postalCode":"01887",
"companyName":"CompanyName",
"jobTitle":"The Job Title",
"county":null,
"suffix":"The Suffix",
"firstName":"Joe",
"phoneNumber":"331234567",
"faxNumber":"331234567",
"alias":null,
"middleName":"Syd",
"state":"MA",
"email":"p.p@GGGG.com"
},
"giftWithPurchaseOrderMarkers":[
]
}400 Response
The error response (which alternates to the default response depending on error reason).
Root Schema : errorModelSingleError
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
Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.
Root Schema : errorModelMultiErrors
Type:
Show Source
object-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
status:
string
The HTTP status code
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