GET
/
vendor
/
price-lists
/
{id}
/
products
{
  "products": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "subtitle": "<string>",
      "description": "<string>",
      "handle": "<string>",
      "is_giftcard": true,
      "status": "draft",
      "thumbnail": "<string>",
      "width": 123,
      "weight": 123,
      "length": 123,
      "height": 123,
      "origin_country": "<string>",
      "hs_code": "<string>",
      "mid_code": "<string>",
      "material": "<string>",
      "collection": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "handle": "<string>",
        "metadata": {
          "car": "white"
        }
      },
      "type": {
        "id": "<string>",
        "value": "<string>",
        "metadata": {
          "car": "white"
        }
      },
      "tags": [
        {
          "id": "<string>",
          "value": "<string>",
          "metadata": {
            "car": "white"
          }
        }
      ],
      "categories": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "handle": "<string>",
          "is_active": true,
          "is_internal": true,
          "rank": 123,
          "parent_category": {},
          "category_children": [
            {}
          ],
          "metadata": {
            "car": "white"
          }
        }
      ],
      "variants": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "sku": "<string>",
          "barcode": "<string>",
          "ean": "<string>",
          "upc": "<string>",
          "allow_backorder": true,
          "manage_inventory": true,
          "hs_code": "<string>",
          "origin_country": "<string>",
          "mid_code": "<string>",
          "material": "<string>",
          "weight": 123,
          "length": 123,
          "height": 123,
          "width": 123,
          "options": [
            {
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "value": "<string>",
              "metadata": {
                "car": "white"
              }
            }
          ],
          "metadata": {
            "car": "white"
          }
        }
      ],
      "options": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "values": [
            {
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "value": "<string>",
              "metadata": {
                "car": "white"
              }
            }
          ],
          "metadata": {
            "car": "white"
          }
        }
      ],
      "images": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "url": "<string>",
          "rank": 123,
          "metadata": {
            "car": "white"
          }
        }
      ],
      "discountable": true,
      "external_id": "<string>",
      "metadata": {
        "car": "white"
      },
      "rating": "<string>"
    }
  ],
  "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.

Path Parameters

​
id
string
required

The ID of the price list.

Query Parameters

​
offset
number

The number of items to skip before starting to collect the result set.

​
limit
number

The number of items to return.

​
fields
string

Comma-separated fields to include in the response.

Response

200 - application/json

OK

The response is of type object.