POST
/
price-lists
curl --request POST \
  --url https://api.fabric.inc/v3/price-lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "name": "US price list",
  "isDefault": true,
  "currency": "USD",
  "startAt": "2021-05-04T09:23:51.459Z",
  "endAt": "2021-06-09T09:23:51.459Z"
}'
{
  "id": 1000003,
  "name": "US price list",
  "isDefault": true,
  "currency": "USD",
  "channelId": "12",
  "startAt": "2021-05-04T09:23:51.459Z",
  "endAt": "2021-06-09T09:23:51.459Z",
  "createdAt": "2019-08-20T14:15:22Z",
  "updatedAt": "2019-08-20T14:15:22Z",
  "isDeleted": true
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string
required

The sales channel ID.

x-client-id
string

The platform where the request is made.

x-fabric-request-id
string

A unique request ID.

Body

application/json
name
string
required

The name of the price list.

isDefault
boolean
required

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

currency
string
required

The currency code defined for the price list.

startAt
string

The start time when the price list becomes active. If no value is specified, the current date is used as the start time.

endAt
string

The end time of the price list. If startAt is specified, then `endAt becomes mandatory.

Response

201 - application/json
id
integer
required

The price list ID.

name
string
required

The name of the price list.

isDefault
boolean
required

true: Price list is marked default<br />false: Price list is not the default

currency
string
required

The currency code of the price list.

channelId
string

The sales channel.

startAt
string

Start time for the price list to be active. If no value is sent, the current date will be set as the start date.

endAt
string

The end time of price list. The end time must be specified if the price list's start time is provided.

createdAt
string

Record's creation time

updatedAt
string

Record's last updated time

isDeleted
boolean
required

true:Record is deleted<br />false:Record is not deleted

Was this page helpful?

Get a specific price listUpdate a specific price list