1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Orders

Create an order

post

/ccstore/v1/orders

This endpoint is used to create an order for the current user i.e. when they navigate to an item and click "add to cart". The order, at this point, can be thought of as a shopping cart i.e. this is the container for all products the user may add, and is not a completed order - it is not in a submitted state at this point, rather, it is defined as "INCOMPLETE".
Dynamic Properties of order and order line items can be added in the the request using the key value pair structure ("dynamicPropertyKey" : "dynamicPropertyValue").

These property values can take the types of:

  • boolean
  • date
  • float
  • string
  • timestamp
  • enumerated
  • big string

Note: The minimum required properties in the payload for this endpoint call (createOrder) to be successful are shippingGroup, shippingMethod and shoppingCart.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : createOrder_request
Type: object
Show Source
Example:
{
    "op":"createOrder",
    "profileId":"se-570032",
    "shippingMethod":{
        "value":"standardShippingMethod"
    },
    "shoppingCart":{
        "coupons":[
            {
                "code":"SAVE5PERCENTON100",
                "level":"order",
                "description":"Order Discount - SAVE5%ON100 - Coupon",
                "id":"explicitOrderDiscount5on100",
                "status":"unclaimed"
            }
        ],
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "childItems":[
                    {
                        "deactivationDate":"2018-06-27T12:59:59Z",
                        "addOnItem":false,
                        "displayName":"Laptop Parts 1",
                        "externalData":[
                        ],
                        "billingProfileId":"billingProfile-123",
                        "billingAccountId":"billingAcc-123",
                        "childItems":[
                            {
                                "serviceAccountId":"serviceAcc-123",
                                "deactivationDate":"2018-06-27T12:59:59Z",
                                "quantity":"1",
                                "productId":"prod40001",
                                "displayName":"Laptop Parts 1",
                                "externalData":[
                                ],
                                "parentAssetKey":"12345",
                                "billingProfileId":"billingProfile-123",
                                "currentPrice":"0",
                                "billingAccountId":"billingAcc-123",
                                "rootAssetKey":"12345",
                                "transactionDate":"2018-06-27T12:59:59Z",
                                "catRefId":"sku40009",
                                "assetKey":"23456",
                                "priceListGroupId":"defaultPriceGroup",
                                "customerAccountId":"customerAcc-123",
                                "invalid":false,
                                "stockStatus":true,
                                "actionCode":"Add",
                                "activationDate":"2017-06-27T15:30:00Z",
                                "serviceId":"service-123",
                                "asset":false
                            }
                        ],
                        "assetKey":"12345",
                        "commerceItemId":"ci19000424",
                        "stockStatus":true,
                        "actionCode":"Add",
                        "serviceId":"service-123",
                        "serviceAccountId":"serviceAcc-123",
                        "quantity":"1",
                        "productId":"prod40001",
                        "parentAssetKey":null,
                        "currentPrice":"0",
                        "rootAssetKey":null,
                        "transactionDate":"2018-06-27T12:59:59Z",
                        "catRefId":"sku40001",
                        "priceListGroupId":"defaultPriceGroup",
                        "customerAccountId":"customerAcc-123",
                        "invalid":false,
                        "activationDate":"2017-06-27T15:30:00Z",
                        "asset":false
                    },
                    {
                        "commerceItemId":"ci19000424",
                        "configurationOptionId":"confO_12",
                        "addOnItem":true,
                        "quantity":"1",
                        "productId":"prod12344",
                        "displayName":"Gift Wrap",
                        "shopperInput":{
                            "color":"neon",
                            "message":"Happy Birthday My Friend",
                            "font":"courier"
                        },
                        "configurablePropertyId":"conf022",
                        "catRefId":"sku12344"
                    }
                ],
                "configuratorId":"12343455",
                "assetKey":"12345",
                "externalPrice":"722.0",
                "stockStatus":true,
                "onSale":true,
                "actionCode":"Add",
                "serviceId":"service-123",
                "serviceAccountId":"serviceAcc-123",
                "quantity":"1",
                "productId":"Product_18Cyii",
                "externalRecurringCharge":"20",
                "currentPrice":"0",
                "parentAssetKey":null,
                "rootAssetKey":null,
                "externalPriceQuantity":"-1",
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"Sku_18Dxy",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false
            }
        ]
    },
    "shippingAddress":{
        "lastName":"Spencers",
        "country":"US",
        "address3":"",
        "address2":"",
        "city":"Montgomery",
        "prefix":"",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "DEFAULT_POSTAL_CODE_PATTERN":"^[0-9a-zA-Z]{1,}([ -][0-9a-zA-Z]{1,})?$",
        "selectedCountry":"US",
        "firstName":"Mark",
        "phoneNumber":"973-974-1234",
        "faxNumber":"",
        "middleName":"",
        "state":"AL",
        "email":"",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    },
    "requestChannel":"agent",
    "dynamicPropertyShippingInstructions":"Test Instructions"
}
Nested Schema : billingAddress
Type: object
Billing address for the order
Show Source
Nested Schema : orders
Type: array
Orders to be resubmitted. Related Endpoint operations - resendOrdersForFulfillment
Show Source
Nested Schema : payments
Type: object
List of payments
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Detailed information of the recurring charges at the shipping groups level
Show Source
Nested Schema : schedule
Type: object
The details of the schedule order. Related Endpoint operations - createOrder, createNewCart
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address. Related Endpoint operations - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder
Show Source
Nested Schema : shippingGroups
Type: array
Shipping Groups. Related Endpoint operations - createOrder, createNewCart, priceOrder, submitOrder
Show Source
Nested Schema : shippingMethod
Type: object
shipping method. Related Endpoint operations - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information. Related Endpoint operations - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder
Show Source
Nested Schema : customProperties
Type: object
Additional Properties Allowed
Show Source
Custom object with dynamic properties. This will be passed to the webhook request
Show Source
  • memberShipId of customer. This property need to be sent if loyalty payment method is selected for payment
  • Unique id for loyalty program.This property need to be sent if loyalty payment method is selected for payment
Nested Schema : subTotalByFrequency
Type: array
subtotal of the item by frequency
Show Source
Nested Schema : taxByFrequency
Type: array
tax by frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : schedule
Type: object
The schedule of the scheduled order
Show Source
Nested Schema : daysInMonth
Type: array
Days in a month this scheduled order has to be placed
Show Source
Nested Schema : daysOfWeek
Type: array
Days in a week this scheduled order has to be placed
Show Source
Nested Schema : monthsInYear
Type: array
Months in a year this scheduled order has to be placed
Show Source
Nested Schema : weeksInMonth
Type: array
Weeks in a month this scheduled order has to be placed
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Detailed information of the recurring charges at the shipping groups level
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address.
Show Source
Nested Schema : shippingMethod
Type: object
shipping method
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: array
recurring charge information
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : subTotalByFrequency
Type: array
subtotal of the item by frequency
Show Source
Nested Schema : taxByFrequency
Type: array
tax by frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : coupons
Type: array
The array of coupons applied to the order.
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: array
recurring charge information
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : createOrder_response
Type: object
Show Source
Nested Schema : billingMethod
Type: object
Billing method information of the order. Related Endpoint operation - submitOrder.
Show Source
Nested Schema : discountInfo
Type: object
Discount information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
Gift Selection Information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Gift With Purchase order markers information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : markers
Type: array
Order markers
Show Source
Nested Schema : notSubmittedOrders
Type: array
Orders not submitted for fulfillment. Related Endpoint operations - resendOrdersForFulfillment
Show Source
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type: object
Payment Group for the order. Related Endpoint operation - submitOrder.
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order. Related Endpoint operations - submitOrder
Show Source
Nested Schema : priceInfo
Type: object
Price information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder.
Show Source
  • The raw number that represents the price.
  • Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
  • orderTotalBySite
    The map containing order totals by site for all sites in a given order.
  • 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.
  • 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.
  • 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.
  • 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 amount
  • The subtotal of the order before applying order-level promotions.
  • The tax on the order.
  • The current working total, including all promotions, tax, and billing costs.
Nested Schema : pricingMessages
Type: object
The Pricing messages information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : profile
Type: object
Profile Information for the order. Related Endpoint operations - submitOrder
Show Source
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order. Related Endpoint operations - submitOrder
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address. Related Endpoint operations - submitOrder
Show Source
Nested Schema : shippingGroups
Type: array
Shipping Groups. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information. Related Endpoint operation - priceOrder, submitOrder, preAuthorizeOrder.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder, preAuthorizeOrder.
Show Source
Nested Schema : submittedOrders
Type: array
Orders submitted for fulfillment. Related Endpoint operations - resendOrdersForFulfillment
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order. Related Endpoint operation - createOrder, createNewCart, priceOrder, submitOrder.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The quantity of free sku for this gift selection that has already been auto added to the order.
  • Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
  • Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
  • The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site..
  • String identifying the free gift, usually the repository id of the gift type.
  • The type of gift like sku, product, category, skuContentGroup or productContentGroup.
  • atg.gwp.
  • The total quantity of sku for this gift selection.
  • The amount of free quantity that has since been manually removed by a Shopper.
  • The repository id of the gwp order marker.
  • The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
  • The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
  • The GWP promotion id.
Nested Schema : items
Type: object
Show Source
  • 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
  • Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign ID.
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : orderTotalBySite
Type: object
The map containing order totals by site for all sites in a given order.
Nested Schema : GiftWithPurchaseMessages
Type: array
The GWP messages information.
Show Source
Nested Schema : promotionUpsellMessages
Type: array
The promotion upsell messages.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : params
Type: array
The list of all message parameters.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : tags
Type: array
The tags the promotion upsell message is associated with.
Show Source
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : imageInfo
Type: object
Shipping method information.
Show Source
Nested Schema : locationInventoryInfoMap
Type: object
Additional Properties Allowed
Show Source
This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
Nested Schema : variant
Type: array
Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : locationInventoryInfoMap
Type: object
Additional Properties Allowed
Show Source
This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
Nested Schema : priceOverrideReason
Type: object
Price override reason map
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : gwpSelections
Type: array
The gift information.
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Example Response (application/json)
{
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":"6.5",
                "amount":"18.56",
                "valueAddedTax":"0",
                "countyTax":"4.640000000000001",
                "isTaxIncluded":false,
                "miscTax":"0",
                "districtTax":"0",
                "stateTax":"7.42",
                "countryTax":"0"
            },
            "shippingMethod":{
                "shippingTax":"0.65",
                "cost":"6.5",
                "externalId":"ext001",
                "value":"ground",
                "shippingMethodDescription":"Ground"
            },
            "shippingGroupId":"sg10021",
            "submittedDate":null,
            "priceInfo":{
                "amount":"179",
                "total":"204.06",
                "shipping":"6.5",
                "shippingSurchargeValue":"0",
                "tax":"18.56",
                "subTotal":"179",
                "currencyCode":"USD",
                "totalWithoutTax":"185.5"
            },
            "recurringChargePriceInfo":{
                "discounted":false,
                "amount":"30",
                "total":"32.4",
                "shipping":"0",
                "subTotalByFrequency":[
                    {
                        "amount":"30",
                        "frequency":"Monthly"
                    }
                ],
                "taxByFrequency":[
                    {
                        "amount":"2.4",
                        "frequency":"Monthly"
                    }
                ],
                "manualAdjustmentTotal":"0",
                "amountIsFinal":false,
                "discountAmount":"0",
                "tax":"2.4",
                "rawSubtotal":"30",
                "currencyCode":"USD"
            },
            "discountInfo":{
                "orderDiscount":"0",
                "shippingDiscount":"0",
                "discountDescList":[
                ]
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "shippingAddress":{
                "lastName":"Test",
                "country":"US",
                "address3":"",
                "address2":"Line 2",
                "city":"Montgomery",
                "address1":"Line 1",
                "prefix":"",
                "companyName":"",
                "postalCode":"36123",
                "jobTitle":"",
                "county":"",
                "suffix":"",
                "firstName":"Steve",
                "phoneNumber":"45454545",
                "alias":"Address",
                "faxNumber":"",
                "middleName":"",
                "state":"AL",
                "email":"steve.test@example.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "discountAmount":"0",
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "preOrderQuantity":"0",
                    "assetKey":"12345",
                    "price":"179",
                    "variant":[
                        {
                            "optionValue":"Red",
                            "optionName":"color"
                        },
                        {
                            "optionValue":"Large",
                            "optionName":"size"
                        }
                    ],
                    "primaryImageAltText":"Antique Wood Chair",
                    "actionCode":"Add",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":"179",
                    "pointOfNoRevision":false,
                    "productId":"xprod2105",
                    "parentAssetKey":null,
                    "active":true,
                    "catRefId":"xsku2105",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/antique-wood-chair/product/xprod2105",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "backOrderQuantity":"0",
                    "recurringCharge":"10",
                    "status":"INITIAL",
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/ST_AntiqueWoodChair_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":"179",
                    "returnedQuantity":"0",
                    "displayName":"Antique Wood Chair",
                    "shippingSurchargeValue":"0",
                    "externalData":[
                    ],
                    "commerceItemId":"ci3000411",
                    "onSale":false,
                    "serviceId":"service-123",
                    "serviceAccountId":"serviceAcc-123",
                    "primaryImageTitle":"Antique Wood Chair",
                    "quantity":"1",
                    "relationshipType":"SHIPPINGQUANTITY",
                    "salePrice":"0",
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":"179",
                            "quantity":"1",
                            "tax":"17.91",
                            "orderDiscountShare":"0",
                            "detailedUnitPrice":"179",
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":"10",
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"UPC Code",
                            "id":"upcCode",
                            "value":"123456"
                        }
                    ],
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":"10",
                            "quantity":"1",
                            "tax":"0",
                            "orderDiscountShare":"0",
                            "detailedUnitPrice":"10",
                            "currencyCode":"USD"
                        }
                    ],
                    "asset":false,
                    "listPrice":"179"
                }
            ],
            "email":"a@example.com",
            "status":"INITIAL"
        }
    ],
    "creationTime":"1411984170268",
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "cost":"6.5",
        "value":"ground"
    },
    "payments":[
        {
            "paymentGroupId":"pg70441",
            "amount":"100",
            "customPaymentProperties":{
                "EMIS":"12",
                "MontlyCharge":"$100"
            },
            "balance":null,
            "gatewayName":"chaseGiftCard",
            "giftCardNumber":null,
            "uiIntervention":null,
            "paymentMethod":"physicalGiftCard",
            "isAmountRemaining":false,
            "paymentState":"AUTHORIZED",
            "maskedCardNumber":"xxxxxxxxxxxxxxx1071"
        },
        {
            "paymentGroupId":"pg70442",
            "amount":"158.5",
            "customPaymentProperties":{
                "EMIS":"12",
                "MontlyCharge":"$100"
            },
            "gatewayName":"chaseCreditCard",
            "uiIntervention":null,
            "paymentMethod":"creditCard",
            "isAmountRemaining":true,
            "paymentState":"AUTHORIZED"
        }
    ],
    "priceListGroup":{
        "repositoryId":"UsDollar"
    },
    "cartName":"Test Name",
    "creationDate":"2014-01-01T00:30:00.000Z",
    "uuid":"05a89e3c-346b-4d50-a55d-91316a50b152",
    "orderAction":"order",
    "priceInfo":{
        "amount":"179",
        "total":"204.06",
        "shipping":"6.5",
        "shippingSurchargeValue":"0",
        "tax":"18.56",
        "subTotal":"179",
        "currencyCode":"USD"
    },
    "recurringChargePriceInfo":{
        "amount":"30",
        "total":"32.4",
        "shipping":"0",
        "subTotalByFrequency":[
            {
                "amount":"30",
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":"2.4",
                "frequency":"Monthly"
            }
        ],
        "tax":"2.4",
        "subTotal":"30",
        "currencyCode":"USD",
        "totalWithoutTax":"30"
    },
    "discountInfo":{
        "orderDiscount":"0",
        "orderDiscountDescList":[
            {
                "promotionLevel":"item",
                "coupon":"FREETATTOO",
                "totalAdjustment":"-21.99",
                "promotionDesc":"Explicit Item Discount - FREETATTOO",
                "promotionId":"explicitItemFreeDiscount"
            }
        ],
        "shippingDiscount":"0"
    },
    "pricingMessages":{
        "giftWithPurchaseMessages":[
            {
                "summary":"The cart has qualified for a free gift promotion.",
                "identifier":"GWPQualified",
                "params":[
                ],
                "type":"information",
                "priority":"-10"
            }
        ]
    },
    "trackingInfo":[
    ],
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "assetKey":"12345",
                "itemDiscountInfos":[
                    {
                        "couponCodes":[
                            "TestCouponCode"
                        ],
                        "amount":"10",
                        "promotionId":"promo10001"
                    }
                ],
                "externalPrice":"175",
                "commerceItemId":"ci3000411",
                "price":"179",
                "variant":[
                    {
                        "optionValue":"Red",
                        "optionName":"color"
                    },
                    {
                        "optionValue":"Large",
                        "optionName":"size"
                    }
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":"179",
                "serviceAccountId":"serviceAcc-123",
                "quantity":"1",
                "productId":"xprod2105",
                "externalRecurringCharge":"10",
                "orderDiscountInfos":[
                    {
                        "couponCodes":[
                        ],
                        "amount":"29.9",
                        "promotionId":"orderDiscount"
                    },
                    {
                        "couponCodes":[
                            "coupon101"
                        ],
                        "amount":"5",
                        "promotionId":"promo10001"
                    }
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "rootAssetKey":null,
                "externalPriceQuantity":"1",
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"xsku2105",
                "externalRecurringChargeDuration":"12",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"UPC Code",
                        "id":"upcCode",
                        "value":"123456"
                    }
                ],
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":"10",
                        "quantity":"1",
                        "tax":"0",
                        "orderDiscountShare":"0",
                        "detailedUnitPrice":"10",
                        "currencyCode":"USD"
                    }
                ],
                "shopperInput":{
                    "color":"neon",
                    "initials":"M.C.K",
                    "font":"courier"
                },
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "recurringCharge":"10"
            }
        ]
    },
    "shippingAddress":{
        "lastName":"Test",
        "country":"US",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "address1":"Line 1",
        "prefix":"",
        "companyName":"",
        "postalCode":"36130",
        "jobTitle":"",
        "county":"",
        "suffix":"",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"AL",
        "email":"steve.test@example.com"
    },
    "id":"o10018",
    "billingAddress":{
        "lastName":"Test",
        "country":"US",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "address1":"Line 1",
        "prefix":"",
        "companyName":"",
        "postalCode":"36130",
        "jobTitle":"",
        "county":"",
        "suffix":"",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"AL",
        "email":"steve.test@example.com"
    },
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"120213",
                "requestDate":"1477479521002",
                "requesterNote":"This is a sample quote"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-26T10:58:41.002Z",
        "errorInfo":null,
        "externalID":null,
        "quoteSubmitted":false,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    },
    "markers":[
        {
            "repositoryId":"mark100001",
            "value":"78900",
            "key":"campaign_eloqua"
        }
    ]
}

Default 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. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
51006The location used does not support in-store pickupEnter a location that this store supports in-store pickup
28102Product/Sku not foundThe product ID you are using may be a typo or that product may not exist in the store
28129The sku ID was not found for the product ID providedEnter a valid sku ID that relates to the product ID queried
25137An error occurred during inventory check for a configurable itemThe quantity ordered is greater than the stock available. Reduce quantity to order.
71006JSON Syntax errorEnsure the JSON syntax is correct. Look for correct closing braces or missing commas etc.
28411Shopper input does not belong to sku specifiedEnsure the shopper input is correct for the specified sku ID e.g. ensure color is applicable to the specified sku ID.
51000An error has occured during the invocation of the web hook and the external pricing system.A possible fix would be to check the webhook is configured correctly in Admin28089The request payload does not contain any shipping information. It must contain shipping informationAdd shipping information to the payload28087No shipping method specifiedAdd a shipping method to the payload

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top