FAfabric
Price List

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.

post/api-offers/price-list

Request

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

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.

Request body

namestring required

Pricelist name

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

currencystring iso-4217 required

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

startDatestring date-time

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

endDatestring date-time

End date of the price list.

Example request

{
  "name": "BuildMuscles-CONTRACT123",
  "currency": "CAD",
  "startDate": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-06-09T09:23:51.459Z"
}

Response

OK

_idstring

fabric internal unique id

priceListIdnumber

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

namestring

Price list name

isDefaultboolean

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

currencystring iso-4217

3 letter currency code as defined by ISO-4217

startDatestring date-time nullable

Start date of the price list. This value can be null. However, if start date is mentioned, end date must also be mentioned.

endDatestring date-time nullable

The end date of priceList. This value can be null. However, if end date is mentioned, start date must also be mentioned.

deletedboolean

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

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "priceListId": 10000003,
  "name": "BuildMuscles-CONTRACT123",
  "currency": "USD",
  "startDate": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-06-09T09:23:51.459Z",
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.