Skip to main content
GET
/
vendor
/
product-collections
List product collections
curl --request GET \
  --url https://api.example.com/vendor/product-collections \
  --header 'Authorization: Bearer <token>'
{
  "product_collections": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "handle": "<string>",
      "metadata": {
        "car": "white"
      }
    }
  ],
  "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

fields
string

The comma-separated fields to include in the response

offset
number

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

limit
number

The number of items to return.

q
string

Search term to filter collections by title or handle.

created_at
object

Filter by creation date using operators ($lt, $gt, $lte, $gte).

updated_at
object

Filter by update date using operators ($lt, $gt, $lte, $gte).

Response

200 - application/json

OK

product_collections
Product Collection · 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