REST API for Oracle Commerce Cloud December 2017

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.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the Purchase list.

Body Parameter

Root Schema : updateItems_request

Example


{
    "items":[
        {
            "op":"update",
            "productId":"Product_18Cxi",
            "quantityDesired":25,
            "catRefId":"Sku_18Dxi"
        },
        {
            "op":"delete",
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "catRefId":"Sku_5Cxy"
        },
        {
            "op":"add",
            "productId":"Product_5Cx",
            "quantityDesired":10,
            "catRefId":"Sku_5Cxy"
        }
    ]
}

Properties

items: Type: array items

Additional Properties Allowed:

list of purchase list items

Nested Schema : items

Type: array

list of purchase list items

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

catRefId: Type: string

Required: true

catalog ref id
op: Type: string

Required: true

opertaion to be performed on purchase list item.This can be one of add/update/delete
productId: Type: string

Required: true

The product id
quantityDesired: Type: integer

Required: true

Quantity desired for the item

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateItems_response

Properties

messsage: Type: string

Success message
success: Type: boolean

Boolean success value either true or false

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "accountId": "or-100001",
  "name": "Purchase List 1",
  "description": "Purchase List",
  "siteId": "siteUS",
  "items": [
    {
      "op": "update",
      "productId": "Product_18Cxi",
      "quantityDesired": 25,
      "catRefId": "Sku_18Dxi"
    },
    {
      "op": "delete",
      "productId": "Product_5Cx",
      "quantityDesired": 30,
      "catRefId": "Sku_5Cxy"
    },
    {
      "op": "add",
      "productId": "Product_5Cx",
      "quantityDesired": 10,
      "catRefId": "Sku_5Cxy"
    }
  ]
}

Sample Response Payload returned by endpoint:

{
  "success": true,
  "messsage": "Purchase List Item(s) updated successfully."
}