1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. PurchaseLists

updatePurchaseList

put

/ccagent/v1/purchaseLists/{id}

Update Purchase List. This operation is used to update properties of a purchase list. Dynamic Properties of purchase list 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
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the Purchase List to be updated.
Body Parameter
Root Schema : updatePurchaseList_request
Nested Schema : items
Type: array
list of purchase list items
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updatePurchaseList_response
Nested Schema : items
Type: array
list of purchase list items
Nested Schema : owner
Type: object
The user who created this purchase list.
Nested Schema : items
Type: object
Example application/json

{
    "owner":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "repositoryId":"se-570031",
        "id":"se-570031"
    },
    "accountId":null,
    "lastModifiedDate":"2017-09-27T09:48:22.000Z",
    "repositoryId":"gl30074",
    "name":"Purchase List 2",
    "description":"Purchase List update",
    "siteId":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/purchaseLists/gl30074"
        }
    ],
    "id":"gl30074",
    "creationDate":"2017-09-27T09:48:22.000Z",
    "items":[
        {
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "repositoryId":"gi10001",
            "id":"gi10001",
            "catRefId":"Sku_5Cxy"
        }
    ]
}
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| |------------------|------------------| |64104|Error while updating the purchase list.| |64100|Invlaid profile id|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

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

Sample Response Payload returned by endpoint:

{
  "owner": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "repositoryId": "se-570031",
    "id": "se-570031"
  },
  "accountId": null,
  "lastModifiedDate": "2017-09-27T09:48:22.000Z",
  "repositoryId": "gl30074",
  "name": "Purchase List 2",
  "description": "Purchase List update",
  "siteId": null,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/purchaseLists/gl30074"
  }],
  "id": "gl30074",
  "creationDate": "2017-09-27T09:48:22.000Z",
  "items": [{
    "productId": "Product_5Cx",
    "quantityDesired": 30,
    "repositoryId": "gi10001",
    "id": "gi10001",
    "catRefId": "Sku_5Cxy"
  }]
}