Create price list

Enables you to create a price list. Depending upon the currency code you set for a price list, you will be able to create or update price (using POST/api-offers/price) under the pricelist for the defined currency code only.

Authorizations

Authorization

string

headerrequired

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.

Body

application/json

name

string

required

Pricelist name

isDefault

boolean

required

true: If you want to keep the given pricelist as the default price list.<br /> false: If you do not want to keep the given pricelist as the default price list.

currency

string

required

Currency code, as defined by ISO-4217, of the price specified in the price list.

startDate

string

Start date of the price list, it indicates the date when the price list becomes available to use.

endDate

string

End date of the price list.

Response

200 - application/json

Price list data

_id

string

fabric internal unique id

priceListId

number

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

name

string

Price list name

isDefault

boolean

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

currency

string

3 letter currency code as defined by ISO-4217

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.

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.

deleted

boolean

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

createdAt

string

Creation date of the record

updatedAt

string

Last updated date of the record