List price lists

Returns a paginated list of price lists scoped to the caller account.

get/api/v1/price-lists

Query parameters

activeboolean

codestring

qstring

pagenumber

limitnumber

sortBystring

sortOrderstring

Response

Paginated list of price lists.

Example response

{
  "data": [
    {
      "meta": {
        "total": 42,
        "pages": 3,
        "current_page": 1,
        "next_page": 2,
        "limit": 20
      }
    }
  ],
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.10717

Jul 7, 2026a3b4750a505f17See the full diff
- ○
  added the new optional query request parameter active
  new-optional-request-parameter
- ○
  added the new optional query request parameter code
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter q
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
- ○
  added the required property data/items/data/items/cost_price to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/end_date to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/list_price to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/price_list_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/sale_price to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/sku to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/start_date to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/data/items/updated_at to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab85107See the full diff
- ▲
  removed the required property data/items/data/items/cost_price from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/end_date from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/list_price from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/price_list_code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/sale_price from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/sku from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/start_date from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/data/items/updated_at from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter active
  request-parameter-removed
- ●
  deleted the query request parameter code
  request-parameter-removed
- ●
  deleted the query request parameter limit
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter q
  request-parameter-removed
- ●
  deleted the query request parameter sortBy
  request-parameter-removed
- ●
  deleted the query request parameter sortOrder
  request-parameter-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history