listPurchaseLists

get

/ccagent/v1/purchaseLists

List PurchaseLists. This operation is used to get the collection of purchase lists from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of purchase list.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listPurchaseLists_response
Type: object
Show Source
Nested Schema : items
Type: array
list of purchase lists
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
list of purchase list items
Show Source
Nested Schema : owner
Type: object
The user who created this purchase list.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/purchaseLists?purchaseListItemCount=true"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "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,
            "id":"gl30074",
            "creationDate":"2017-09-27T09:48:22.000Z",
            "items":[
                {
                    "productId":"Product_5Cx",
                    "quantityDesired":30,
                    "repositoryId":"gi10001",
                    "id":"gi10001",
                    "catRefId":"Sku_5Cxy"
                }
            ],
            "purchaseListItems":1
        }
    ]
}

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| |------------------|------------------| |64103|Error while retrieving the 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