v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Collections

Retrieve collection items

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: collections(r).

Retrieve all items of a collection, optionally filtered by type, i.e. method of addition to the collection.

get/v1/collections/{collection_id}/items

collection_idstring required

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

manual_itemsboolean

Specifies whether to include manually added items in the response.

dynamic_itemsboolean

Specifies whether to include dynamic items (matching collection.filter_expression) in the response.

unindexed_itemsboolean

Specifies whether to include unindexed collection items. Supported only for manual items, hence mutually exclusive with dynamic_items filter

{
  "manual_items": true
}

num_results_per_pageinteger

The number of results per page to return.

Example:20

pageinteger

The page of results to return.

Example:1

offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

total_countinteger required

{
  "items": [
    {
      "source": "manual_upload",
      "variation_ids": [
        "var-red"
      ]
    }
  ]
}