Get all price lists
Get a paginated list of all price lists.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
24
x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field.
A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.
A unique request ID.
Query Parameters
The maximum number of records per page.
1 < x < 100
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x > 0
The criteria to sort the results. Use the format {sort order}{field name}, where -
refers to a descending order and +
refers to an ascending order.
-updatedAt
, +updatedAt
, -isDefault
, +isDefault
, -id
, +id
Status by which records are filtered.<br>ACTIVE: If today's date is between a price list's 'startAt' date and 'endAt' date, that price list is considered active.
ACTIVE
Filter the records matching the price list name.
true
: This price list is designated as the default price list.false
: This price list isn't designated as the default price list.
Was this page helpful?