Get Price Lists

Retrieve a list of all price lists.

GET /commerce/catalog/admin/pricelists

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "name": "<string>",
      "priceListCode": "<string>",
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "defaultForSites": [
        123
      ],
      "description": "<string>",
      "enabled": true,
      "filteredInStorefront": true,
      "indexedSites": [
        123
      ],
      "mappedCustomerSegments": [
        "<string>"
      ],
      "parentPriceListCode": "<string>",
      "parentPriceListName": "<string>",
      "priceListSequence": 123,
      "rank": 123,
      "resolvable": true,
      "validForAllSites": true,
      "validSites": [
        123
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 0

sortBy · string

filter · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Collection of categories returned as a whole. A collection is not paged.

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>