PUT
/
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.

Body

application/json

The inputs to create or update price lists.

name
string
required

The name of the price list.

isDefault
boolean
required

true: Default price list<br>false: It's not the default price list

currency
string
required

The currency code defined for the price list.

startAt
string

The start time when the price list becomes active. If no value is specified, the current date is used as the start time.

endAt
string

The end time of the price list. If startAt is specified, then `endAt becomes mandatory.

Response

200 - application/json

The details of the price list.

id
integer
required

The price list ID.

name
string
required

The name of the price list.

isDefault
boolean
required

true: Price list is marked default<br>false: Price list isn't the default

currency
string
required

The currency code of the price list.

createdAt
string
required

Record's creation time

updatedAt
string
required

Record's last updated time

isDeleted
boolean
required

true: Record is deleted<br>false: Record 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?

Get a specific price listDelete a specific price list