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

Update an order

put

/ccstore/v1/orders/{id}

Updates the order, for the given order id, with the provided data and prices the order again; returning the updated order.

Dynamic Properties of order and order line items can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").

Note: The minimum required properties, in the payload, for this endpoint call (updateOrder) to be successful - granted it is an empty order, are shippingGroup, shippingMethod and shoppingCart. If the order has already been created there is no minimum request payload, just correctly enter the property you wish to update.

Prerequisite: The user must be logged in. See REST API Authentication.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateOrder_request
Type: object
Show Source
Example:
{
    "isAnonymousCheckout":false,
    "shippingMethod":{
        "value":"twoDay"
    },
    "payments":[
        {
            "cardCVV":"123",
            "nameOnCard":"test",
            "cardTypeName":"Visa",
            "cardType":"visa",
            "endMonth":"02",
            "type":"card",
            "endYear":2018,
            "cardNumber":"4055011111111111"
        }
    ],
    "cartName":"Test Name",
    "visitId":"27c79ed0-384f-4658-824d-c5b8518bfde0",
    "appliedPromotions":[
        "explicitItemFreeDiscount"
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"FREETATTOO",
                "level":"item",
                "description":"Explicit Item Discount - FREETATTOO",
                "id":"explicitItemFreeDiscount",
                "totalAdjustment":"-21.99",
                "status":"claimed"
            }
        ],
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "childItems":[
                    {
                        "configurationOptionId":"configOptIDC1P11536825979556",
                        "addOnItem":true,
                        "quantity":5,
                        "priceListGroupId":"price_list_group_1536825979556",
                        "productId":"child1P1Prod1536825979556",
                        "childItems":[
                        ],
                        "configurablePropertyId":"configPropIDC1P11536825979556",
                        "shopperInput":{
                            "fontSIID1536825979556":"Times New Roman",
                            "shrtTxtSIID1536825979556":"This is the P1parent1Prod1536825979556"
                        },
                        "catRefId":"child1P1Sku1536825979556"
                    }
                ],
                "assetKey":"12345",
                "actionCode":"Add",
                "state":"INITIAL",
                "serviceId":"service-123",
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"prod20006",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "parentAssetKey":null,
                "rootAssetKey":null,
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"sku40105",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "pointOfNoRevision ":"false",
                "shopperInput":{
                    "color":"neon",
                    "initials":"M.C.K",
                    "font":"courier"
                },
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "recurringCharge":10
            }
        ],
        "orderTotal":109.46
    },
    "shippingAddress":{
        "lastName":"h",
        "country":"United States",
        "address3":"",
        "address2":"A2",
        "city":"C1",
        "prefix":"",
        "address1":"A1",
        "defaultCountryCode":null,
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"h",
        "phoneNumber":"34534533",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "selectedState":"AL",
        "email":"h@example.com",
        "state_ISOCode":"US-AL"
    },
    "id":"o10003",
    "billingAddress":{
        "lastName":"Test",
        "country":"United States",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "prefix":"",
        "address1":"Line 1",
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    },
    "dynamicPropertyShippingInstructions":"Test Instructions",
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ],
    "visitorId":"-6820098066093706883"
}
Nested Schema : appliedPromotions
Type: array
The array of applied promotions.
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information. Required if giftWithPurchaseOrderMarker information is present.
Show Source
Nested Schema : payments
Type: array
Payment details to update the order.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
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.
  • An identifier used 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 the gift. (sku, product)
  • 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 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 gift with purchase promotion ID
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupons
Type: array
The array of coupons applied to the order.
Show Source
Nested Schema : items
Type: array
The array of products in the shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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
giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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 : 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
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : updateOrder_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
An array of approval messages when order going in pending approval state
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information
Show Source
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type: object
The order price information.
Show Source
  • The total order amount.
  • The currency code.
  • 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.
  • The shipping surcharges added at item level in monetary currency.
  • 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.
  • The total shipping cost.
  • Extra handling costs for shipping the products.
  • The sub-total amount.
  • The total tax amount.
  • Total excluding shipping and tax in monetary currency
  • The order total.
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : orderDiscountDescList
Type: array
The list of all the order discounts.
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
Nested Schema : items
Type: object
Show Source
Nested Schema : giftWithPurchaseMessages
Type: array
The gift with purchase messages information.
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 : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
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: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
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 : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
The 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 : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
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 : items
Type: object
Show Source
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
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: array
The array of products in the shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
The 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 : itemDiscountInfos
Type: array
Array of promotions received by this item.
Show Source
Nested Schema : orderDiscountInfos
Type: array
Array of order promotions received by this item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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 : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
The gift information.
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 : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":3.49,
                "amount":9.96,
                "valueAddedTax":0,
                "countyTax":2.49,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":3.98,
                "countryTax":0
            },
            "shippingMethod":{
                "shippingTax":1.05,
                "cost":10.5,
                "value":"twoDay",
                "shippingMethodDescription":"Two Days"
            },
            "shippingGroupId":"sg10047",
            "submittedDate":null,
            "priceInfo":{
                "amount":89,
                "total":109.46,
                "shipping":10.5,
                "shippingSurchargeValue":0,
                "tax":9.96,
                "subTotal":89,
                "currencyCode":"USD",
                "totalWithoutTax":99.5
            },
            "recurringChargePriceInfo":{
                "amount":30,
                "total":32.4,
                "shipping":0,
                "subTotalByFrequency":[
                    {
                        "amount":30,
                        "frequency":"Monthly"
                    }
                ],
                "taxByFrequency":[
                    {
                        "amount":2.4,
                        "frequency":"Monthly"
                    }
                ],
                "tax":2.4,
                "subTotal":30,
                "currencyCode":"USD",
                "totalWithoutTax":30
            },
            "discountInfo":{
                "orderDiscount":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "shippingAddress":{
                "lastName":"h",
                "country":"US",
                "address3":"",
                "address2":"A2",
                "city":"C1",
                "address1":"A1",
                "prefix":"",
                "companyName":"",
                "postalCode":"36123",
                "jobTitle":"",
                "county":"",
                "suffix":"",
                "firstName":"h",
                "phoneNumber":"34534533",
                "alias":"Address##1",
                "faxNumber":"",
                "middleName":"",
                "state":"AL",
                "email":"h@example.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_AviatorSunglasses_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":89,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "displayName":"Aviator Sunglasses",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":"12345",
                    "commerceItemId":"ci3000411",
                    "price":89,
                    "variant":[
                        {
                            "optionValue":"Blue",
                            "optionName":"Color"
                        },
                        {
                            "optionValue":"Medium",
                            "optionName":"Size"
                        }
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Aviator Sunglasses",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":89,
                    "primaryImageTitle":"Aviator Sunglasses",
                    "quantity":1,
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "productId":"prod20006",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":89,
                            "quantity":1,
                            "tax":8.91,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":89,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "parentAssetKey":null,
                    "active":true,
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"sku40105",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"UPC Code",
                            "id":"upcCode",
                            "value":"123456"
                        }
                    ],
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/aviator-sunglasses/product/prod20006",
                    "siteId":"siteUS",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "asset":false,
                    "listPrice":89,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "email":"a@example.com",
            "status":"INITIAL"
        }
    ],
    "creationTime":1.419259052037E12,
    "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":10.5,
        "value":"twoDay"
    },
    "payments":[
        {
            "paymentGroupId":"pg70442",
            "amount":109.46,
            "gatewayName":"chaseCreditCard",
            "uiIntervention":null,
            "paymentMethod":"creditCard",
            "isAmountRemaining":true,
            "paymentState":"AUTHORIZED"
        }
    ],
    "cartName":"Test Name",
    "creationDate":"2014-12-22T14:37:32.037Z",
    "orderProfileId":"110484",
    "uuid":"09e8eb24-734d-4cda-b3b5-b57edd178c75",
    "orderAction":"order",
    "priceInfo":{
        "amount":89,
        "total":109.46,
        "shipping":10.5,
        "shippingSurchargeValue":20,
        "tax":9.96,
        "subTotal":89,
        "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"
                    }
                ],
                "commerceItemId":"ci3000411",
                "price":89,
                "variant":[
                    {
                        "optionValue":"Blue",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Medium",
                        "optionName":"Size"
                    }
                ],
                "serviceId":"service-123",
                "unitPrice":89,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"prod20006",
                "externalRecurringCharge":10,
                "orderDiscountInfos":[
                    {
                        "couponCodes":[
                        ],
                        "amount":29.9,
                        "promotionId":"orderDiscount"
                    },
                    {
                        "couponCodes":[
                            "coupon101"
                        ],
                        "amount":5,
                        "promotionId":"promo10001"
                    }
                ],
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "rootAssetKey":null,
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "externalRecurringChargeDuration":"12",
                "catRefId":"sku40105",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"UPC Code",
                        "id":"upcCode",
                        "value":"123456"
                    }
                ],
                "discountInfo":[
                ],
                "customerAccountId":"customerAcc-123",
                "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":"h",
        "country":"US",
        "address3":null,
        "address2":"A2",
        "city":"C1",
        "address1":"A1",
        "prefix":null,
        "companyName":null,
        "postalCode":"36123",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"h",
        "phoneNumber":"34534533",
        "faxNumber":null,
        "alias":null,
        "middleName":null,
        "state":"AL",
        "email":"h@example.com"
    },
    "id":"o10003",
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"120213",
                "requestDate":1.477479521002E12,
                "requesterNote":"This is a sample quote"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-26T10:58:41.002Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    },
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ]
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
28080Empty shopping cart data.The current order does not contain any shopping cart data you must add it in first before updating anything else.
28102No product found matching the provided product ID.Ensure the product ID entered is valid and that it exists.
28129Sku was not found for the entered product ID.Ensure the provided sku is linked to the product ID provided.
28089Empty shipping address data.Please provide valid shipping address data.
28087No shipping method was specified.Please provide valid shipping method.

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