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

Update current profile's order

post

/ccstore/v1/orders/current

Updates the persisted order(an order that will remain saved until it is deleted) for the logged in user with the data sent in the request and re-prices the order with the latest prices. Returns the updated order details along with the pricing response which is cached. At this point the order is in the "INCOMPLETE" state.

The only minimum required property in the request is the shopping cart data.

Dynamic Properties of order and items can be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). Please refer to the "Create an Order" endpoint which talks in a bit more detail of the dynamic properties.

Note: This endpoint is not part of the cart (current incomplete order) actions grouping.

Request

Supported Media Types
Query Parameters
Header Parameters
Body ()
Root Schema : updateCurrentProfileOrder_request
Type: object
Show Source
Example:
{
    "op":"update",
    "payments":[
        {
            "amount":"100.0",
            "giftCardNumber":"6035710988880101071",
            "giftCardPin":"",
            "type":"physicalGiftCard"
        }
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"coupon1",
                "level":"order",
                "description":"promo1",
                "id":"promo20001",
                "totalAdjustment":-1,
                "status":"claimed"
            },
            {
                "code":"coupon2",
                "level":"",
                "description":"",
                "id":"",
                "status":""
            }
        ],
        "numberOfItems":1,
        "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",
                "price":40,
                "onSale":true,
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":40,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"xprod1047",
                "externalRecurringCharge":10,
                "parentAssetKey":null,
                "rootAssetKey":null,
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"xsku1242",
                "externalRecurringChargeDuration":"12",
                "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
            }
        ]
    },
    "cartName":"My New Cart",
    "id":"o10001",
    "dynamicPropertyShippingInstructions":"Test Instructions"
}
Nested Schema : payments
Type: array
The array of payments containing only gift card payments to be sent to reprice the order.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
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 : 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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
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. A child item can itself contain a child item array if it is a configurable product in itself.
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 : giftWithPurchaseSelections
Type: array
The array of gift with purchase selections to be made.
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
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : updateCurrentProfileOrder_response
Type: object
Show Source
Nested Schema : discountInfo
Type: object
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 : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : payments
Type: array
Payment details for the pricing call, including additional properties specific to the payment type.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
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 : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
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
Implicit Promotions for the order
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The coupons that were not claimed
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: object
Coupon Code
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: object
Coupon Code
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 from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
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: array
Items in the 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. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price 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 : 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 : 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
Example Response (application/json)
{
    "shippingGroups":[
        {
            "priceInfo":{
                "amount":37,
                "total":37,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":37,
                "currencyCode":"USD",
                "totalWithoutTax":37
            },
            "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":[
                ]
            },
            "shippingMethod":{
                "shippingTax":0,
                "cost":0,
                "value":"hardgoodShippingGroup"
            },
            "shippingGroupId":"sg10012",
            "shippingAddress":{
                "lastName":null,
                "country":null,
                "address3":null,
                "address2":null,
                "city":null,
                "address1":null,
                "prefix":null,
                "companyName":null,
                "postalCode":null,
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":null,
                "phoneNumber":null,
                "alias":null,
                "faxNumber":null,
                "middleName":null,
                "state":null,
                "email":null
            },
            "items":[
                {
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":40,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":"12345",
                    "commerceItemId":"ci3000411",
                    "price":40,
                    "onSale":false,
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":40,
                    "serviceAccountId":"serviceAcc-123",
                    "quantity":1,
                    "productId":"xprod1049",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":40,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":40,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "parentAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "rootAssetKey":null,
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"xsku1242",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "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":40,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ]
        }
    ],
    "orderId":"o10001",
    "creationSiteId":"siteUS",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":[
        {
            "paymentGroupId":"pg70448",
            "amount":37,
            "balance":"100.0",
            "gatewayName":"chaseGiftCard",
            "giftCardNumber":"6035710988880101071",
            "uiIntervention":null,
            "paymentMethod":"physicalGiftCard",
            "isAmountRemaining":true,
            "paymentState":"INITIAL",
            "maskedCardNumber":"xxxxxxxxxxxxxxx1071"
        }
    ],
    "cartName":"My New Cart",
    "priceInfo":{
        "amount":37,
        "total":37,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":40,
        "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":{
        "unclaimedCouponMultiPromotions":{
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "promotionDesc":"promo4",
                    "promotionId":"promo20004"
                }
            ]
        },
        "orderCouponsMap":{
            "coupon1":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo1",
                "promotionId":"promo20001"
            },
            "coupon2":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo2",
                "promotionId":"promo20002"
            }
        },
        "orderDiscount":3,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
            {
                "promotionLevel":"item",
                "totalAdjustment":"-0.66",
                "promotionDesc":"Implicit Item Discount - 3PercentOff",
                "promotionId":"implicitItemPercentDiscount"
            }
        ],
        "claimedCouponMultiPromotions":{
            "coupon1":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo1",
                    "promotionId":"promo20001"
                },
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo3",
                    "promotionId":"promo20003"
                }
            ],
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo2",
                    "promotionId":"promo20002"
                }
            ]
        },
        "unclaimedCouponsMap":{
            "coupon2":{
                "promotionLevel":"order",
                "promotionDesc":"promo4",
                "promotionId":"promo20004"
            }
        }
    },
    "pricingMessages":{
        "giftWithPurchaseMessages":[
            {
                "summary":"The cart has qualified for a free gift promotion.",
                "identifier":"GWPQualified",
                "params":"[]",
                "type":"information",
                "priority":"-10"
            }
        ]
    },
    "shoppingCart":{
        "numberOfItems":1,
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v534243951836338001/products/1242_LARGE.jpg&height=100&width=100",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "assetKey":"12345",
                "commerceItemId":"ci3000411",
                "price":40,
                "onSale":true,
                "primaryImageAltText":"Product Alternative Text",
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":40,
                "serviceAccountId":"serviceAcc-123",
                "primaryImageTitle":"Product title",
                "childSKUs":[
                    {
                        "primaryThumbImageURL":null
                    }
                ],
                "quantity":1,
                "productId":"xprod1047",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "externalRecurringChargeFrequency":"Monthly",
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "externalRecurringChargeDuration":"12",
                "catRefId":"xsku1242",
                "customerAccountId":"customerAcc-123",
                "route":"/product-name/product/xprod2148",
                "siteId":"siteUS",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "shopperInput":{
                    "color":"neon",
                    "initials":"M.C.K",
                    "font":"courier"
                },
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "recurringCharge":10
            }
        ]
    },
    "siteId":"siteUS",
    "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:

Note: A lot of common errors in this call are also found when creating the order. Please refer to "Create an Order" for any error codes and resolutions that may not appear here before seeking further guidance.

Error CodeDescriptionPossible Fix
28315The order update failed.Ensure the request body is correct and there are no typos in the keys.
28326The coupon code provided in the request was not found in the registry.Ensure the coupon code exists. If this does not resolve the issue, ensure spelling of code is correct.
28081There are no items in the shopping cart data provided.Ensure the use of valid data in the shopping cart in the request 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