Get a specific price list

Enables you to retrieve details of a price list by price list ID or name.

Authorizations

Authorization

string

header

required

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.

Path Parameters

priceListId

required

ID or name of the price list to get details for

Query Parameters

filterBy

enum<string>

default:

priceListId

Field by which you want to filter the record; by priceListId or by name of the price list

Available options:

priceListId,

name

Response

200 - application/json

Price list data

_id

string

fabric internal unique id

createdAt

string

Creation date of the record

currency

string

3 letter currency code as defined by ISO-4217

deleted

boolean

true: Price list is deleted<br /> false: Price list is not deleted

endDate

string | null

The end date of priceList. This value can be null. However, if end date is mentioned, start date must also be mentioned.

isDefault

boolean

true: This is the default price list<br /> false: This is not the default price list

name

string

Price list name

priceListId

number

Price list ID. This is the system generated unique ID of the pricelist

startDate

string | null

Start date of the price list. This value can be null. However, if start date is mentioned, end date must also be mentioned.

updatedAt

string

Last updated date of the record