GET
/
price-lists

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string

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.

x-client-id
string

The platform where the request is made.

x-fabric-request-id
string

A unique request ID.

Query Parameters

size
integer
default: 10

The maximum number of records per page.

offset
integer
default: 0

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.

sort
enum<string>
default: -updatedAt

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.

Available options:
-updatedAt,
+updatedAt,
-isDefault,
+isDefault,
-id,
+id
status
enum<string>

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.

Available options:
ACTIVE
name
string

Filter the records matching the price list name.

isDefault
boolean

true: Returns details of the default price list.<br>false: Returns all price lists.

Response

200 - application/json
query
object

Provides pagination data.

data
object[]

The details of price lists

Was this page helpful?

Delete a specific price listOverview