We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

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.

SecurityAuthorizationToken
Request
header Parameters
required
object

Valid JSON object that must contain account, stage, date, and channel attributes. eg - {"stage":"prod","account":"5f328bf0b","date":"2020-12-12T08:00:00.000Z","channel":12}

Authorization
required
string

Authorization token or access token for the user, provided by fabric. It can be obtained after logging into fabric's copilot account.

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
name
required
string

Pricelist name

isDefault
required
boolean

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

currency
required
string <iso-4217>

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

startDate
string <date-time>

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

endDate
string <date-time>

End date of the price list.

Responses
200

OK

400

Bad request

500

Internal Server Error

post/api-offers/price-list
Request samples
application/json
{
  • "name": "BuildMuscles-CONTRACT123",
  • "isDefault": false,
  • "currency": "CAD",
  • "startDate": "2021-05-04T09:23:51.459Z",
  • "endDate": "2021-06-09T09:23:51.459Z"
}
Response samples
application/json
{
  • "_id": "614b58924e92f6861ac9d43b",
  • "priceListId": 10000003,
  • "name": "BuildMuscles-CONTRACT123",
  • "isDefault": false,
  • "currency": "USD",
  • "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"
}