1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. PurchaseLists

listPurchaseLists

get

/ccstore/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
  • This is the field to determine number of records to be fetched per REST call.
  • This field determines type of purchase lists to be fetched.
    Default Value: owner
    Allowed Values: [ "owner", "shared" ]
  • This field determines the offset/starting index from which data to be fetched.
  • Whether to include purchase list item count in the response.
  • Query string built as per the SCIM standards that helps to search entered string across purchase list properties like 'name'.
  • This field determines sharing type of the shared purchase lists to be fetched.
    Default Value: all
    Allowed Values: [ "all", "account", "email" ]
  • This field determines the account for which the shared purchase lists need to fetched. If not passed the current account (OR) parent account is taken, in that sequence. If 'all' is passed then, purchase list shared in all the accounts are returned.
    Default Value: {Current Account ID (OR) Parent Account ID}
    Allowed Values: [ "all", "{Account ID}" ]
  • This field determines the sort order of the list to be fetched.
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 : dynamicProperty
Type: object
The value of the dynamic Property
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
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/purchaseLists?purchaseListItemCount=true"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "owner":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "repositoryId":"se-570031",
                "id":"se-570031",
                "email":"kim@example.com"
            },
            "lastModifiedDate":"2017-09-27T09:48:22.000Z",
            "lastModifiedBy":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "repositoryId":"se-570031",
                "id":"se-570031",
                "email":"kim@example.com"
            },
            "sharedWithOther":false,
            "description":"Purchase List update",
            "creationDate":"2017-09-27T09:48:22.000Z",
            "dynamicProperty":"dynamicProperty value",
            "accountId":null,
            "repositoryId":"gl30074",
            "name":"Purchase List 2",
            "siteId":null,
            "id":"gl30074",
            "items":[
                {
                    "dynamicProperty":"dynamicProperty value",
                    "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.| |64124|Invalid listType requested.| |64135|Invalid shareType requested.| |64123|(Shared) Account does not exists or you do not have access to it.
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