Get all price lists

Retrieves a paginated list of all price lists.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

limit

number

default: 10

The maximum number of records per page.

Required range: x > 0

offset

number

default: 0

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Required range: x > 0

sortBy

enum<string>

default: updatedAt

Field by which you want to sort the records

Available options:

updatedAt,

name,

priceListId

sortOrder

enum<string>

default: desc

Sorting order of the records

Available options:

asc,

desc

filter

enum<string>

Value by which price lists are filtered

Available options:

not_expired

isDefault

boolean

If set to true, this endpoint returns the default price list

Response

200 - application/json

query

object

Paging details used for selecting list

Show child attributes

data

object[]

Price list data

Show child attributes