PUT
/
api-offers
/
price-list
/
{priceListId}
curl --request PUT \
  --url https://live.copilot.fabric.inc/api-offers/price-list/{priceListId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "name": "BuildMuscles-CONTRACT123",
  "isDefault": false,
  "currency": "CAD",
  "startDate": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-06-09T09:23:51.459Z"
}'
{
  "_id": "614b58924e92f6861ac9d43b",
  "priceListId": 10000003,
  "name": "BuildMuscles-CONTRACT123",
  "isDefault": false,
  "currency": "CAD",
  "startDate": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-06-09T09:23:51.459Z",
  "deleted": false,
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
priceListId
number
required

Price list ID

Example:

10000003

Body

application/json
​
name
string
required

Pricelist name

Maximum length: 300
Example:

"BuildMuscles-CONTRACT123"

​
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.

Example:

false

​
currency
string

3 letter currency code as defined by ISO-4217

Example:

"CAD"

​
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.

Example:

"2021-05-04T09:23:51.459Z"

​
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.

Example:

"2021-06-09T09:23:51.459Z"

Response

200
application/json
OK
​
_id
string

fabric internal unique id

Example:

"614b58924e92f6861ac9d43b"

​
priceListId
number

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

Example:

10000003

​
name
string

Price list name

Example:

"BuildMuscles-CONTRACT123"

​
isDefault
boolean

true: indicates this is the default price list.<br /> false: indicates this is not the default price list

Example:

false

​
currency
string

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

Example:

"CAD"

​
startDate
string

Start date of the price list

Example:

"2021-05-04T09:23:51.459Z"

​
endDate
string

End date of the price list

Example:

"2021-06-09T09:23:51.459Z"

​
deleted
boolean

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

Example:

false

​
createdAt
string

Creation date of the record

Example:

"2020-12-14T12:15:43.646Z"

​
updatedAt
string

Last updated date of the record

Example:

"2021-12-14T12:15:43.646Z"

Was this page helpful?

Create price listDelete a specific price list