GET
/
vendor
/
price-lists
{
  "price_lists": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "rules": {},
      "starts_at": "<string>",
      "ends_at": "<string>",
      "status": "draft",
      "type": "sale",
      "prices": [
        {
          "variant_id": "<string>",
          "rules": {},
          "id": "<string>",
          "title": "<string>",
          "currency_code": "usd",
          "amount": 123,
          "raw_amount": {},
          "min_quantity": 123,
          "max_quantity": 123,
          "price_set_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number

The number of items to return. Default 50.

​
offset
number

The number of items to skip before starting the response. Default 0.

​
fields
string

Comma-separated fields that should be included in the returned data.

Response

200 - application/json

OK

​
price_lists
object[]
​
count
integer

The total number of items available

​
offset
integer

The number of items skipped before these items

​
limit
integer

The number of items per page