GET
/
price-lists
/
{id}

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

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.

Required string length: 24
​
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

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

​
x-fabric-request-id
string

A unique request ID.

Path Parameters

​
id
integer
required

The price list ID associated with the item generated using the create price list endpoint.

Response

200 - application/json

The details of the price list.

​
id
integer
required

The price list ID associated with the item generated using the create price list endpoint.

​
name
string
required

The name of the price list.

​
isDefault
boolean
required
  • true: This price list is designated as the default price list.
  • false: This price list isn't designated as the default price list.
​
currency
string
required

The currency code of the price list.

​
createdAt
string
required

The timestamp of when the price list was created.

​
updatedAt
string
required

The timestamp of when the price list was last updated.

​
isDeleted
boolean
required
  • true: The price list is deleted.
  • false: The price list isn't deleted.
​
channelId
string

The sales channel.

​
startAt
string

Start time for the price list to be active. If no value is sent, the current date will be set as the start date.

​
endAt
string

The end time of price list. The end time must be specified if the price list's start time is provided.

Was this page helpful?

Create price listUpdate a specific price list