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 and 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 : updatePurchaseList_request
Type: object
Show Source
Example:
{
    "dynamicProperty":"dynamicProperty value",
    "accountId":"or-100001",
    "name":"Purchase List 1",
    "description":"Purchase List",
    "siteId":"siteUS",
    "items":[
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_18Cxi",
            "quantityDesired":25,
            "catRefId":"Sku_18Dxi"
        },
        {
            "dynamicProperty":"dynamicProperty value",
            "productId":"Product_5Cx",
            "quantityDesired":30,
            "catRefId":"Sku_5Cxy"
        }
    ]
}
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
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 : updatePurchaseList_response
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : items
Type: array
list of purchase list items
Show Source
Nested Schema : lastModifiedBy
Type: object
The user who last modified this purchase list.
Show Source
Nested Schema : owner
Type: object
The user who created this purchase list.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "owner":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "repositoryId":"se-570031",
        "id":"se-570031"
    },
    "dynamicProperty":"dynamicProperty value",
    "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":[
        {
            "dynamicProperty":"dynamicProperty value",
            "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
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