GET
/
price-lists
curl --request GET \
  --url https://api.fabric.inc/v3/price-lists \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "query": {
    "size": 10,
    "nextCursor": "H796HJHGANLSADS"
  },
  "data": [
    {
      "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.

Query Parameters

size
integer
default: 10

The maximum number of records per page.

startCursor
string

Specifies the record from which the search will start, effectively skipping all records before this point.

sort
enum<string>
default: -updatedAt

The criteria to sort the results. Use the format {sort order}{field name}, where - refers to a descending order and + refers to an ascending order.

Available options:
-updatedAt,
+updatedAt,
-id,
+id
status
enum<string>

Status by which records are filtered.<br />ACTIVE: Active price lists are those whose endAt date is in future than the startAt date.

Available options:
ACTIVE
isDefault
boolean

true: Returns details of the default price list.<br />false: Returns all price lists.

Response

200 - application/json
query
object

The pagination details.

data
object[]

The details of price lists

Was this page helpful?

Delete a specific price listOverview