updateItems

post

/ccagent/v1/purchaseLists/{id}/updateItems

Update Purchase List Items. This operation is used to update the purchase list items. Basic operations include add, delete, update. add operation is considered as default if nothing is specified in the input payload. Dynamic Properties of purchase list line item 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.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updatePurchaseListItems_request
Type: object
Show Source
Example:
{
    "items":[
        {
            "dynamicProperty":"dynamicProperty value",
            "op":"update",
            "productId":"Product_18Cxi",
            "quantityDesired":25,
            "catRefId":"Sku_18Dxi"
        },
        {
            "op":"delete",
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "catRefId":"Sku_5Cxy"
        },
        {
            "dynamicProperty":"dynamicProperty value",
            "op":"add",
            "productId":"Product_5Cx",
            "quantityDesired":10,
            "catRefId":"Sku_5Cxy"
        }
    ]
}
Nested Schema : items
Type: array
list of purchase list items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updatePurchaseListItems_response
Type: object
Show Source
Example Response (application/json)
{
    "success":true,
    "messsage":"Purchase List Item(s) updated successfully."
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |64107|Error while adding an item to purchase list| |64100|Invalid profile or user logged out| |64106|Error while removing an item from purchase list| |64109|Error while updating an item of purchase list
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