Update a specific price list

Updates a specific price list by price list ID.

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

number

required

Price list ID

Body

application/json

isDefault

boolean

required

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

name

string

required

Pricelist name

Maximum length: 300

currency

string

3 letter currency code as defined by ISO-4217

endDate

string

End date of the price list. This value can be null, however if you mention an end date, you must provide a start date as well.

startDate

string

Start date of the price list. It indicates the date when the price list will be available to use. This value can be null, however if you mention the start date, you must provide end date as well.

Response

200 - application/json

_id

string

fabric internal unique id

createdAt

string

Creation date of the record

currency

string

3 letter currency code, as defined by ISO-4217, of the price specified in the price list

deleted

boolean

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

endDate

string

End date of the price list

isDefault

boolean

true: indicates this is the default price list.<br /> false: indicates 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

Start date of the price list

updatedAt

string

Last updated date of the record