List Collections

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.collections.list()

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.trychannel3.com/v1/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "collection_id": "<string>",
      "name": "<string>",
      "clauses": [
        {
          "clause_id": "<string>",
          "brand_ids": [
            "<string>"
          ],
          "website_ids": [
            "<string>"
          ],
          "category_ids": [
            "<string>"
          ],
          "product_ids": [
            "<string>"
          ]
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "user_id": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

GET

collections

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.collections.list()

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.trychannel3.com/v1/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "collection_id": "<string>",
      "name": "<string>",
      "clauses": [
        {
          "clause_id": "<string>",
          "brand_ids": [
            "<string>"
          ],
          "website_ids": [
            "<string>"
          ],
          "category_ids": [
            "<string>"
          ],
          "product_ids": [
            "<string>"
          ]
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "user_id": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

x-api-key

string

header

required

Query Parameters

user_id

string | null

Optional partner user id. When provided, returns only that user's collections. When omitted, returns all collections for this API key.

page_token

string | null

Opaque token from a previous list response.

limit

integer

default:50

Required range: 1 <= x <= 100

Response

Successful Response

items

CollectionResponse · object[]

required

Show child attributes

next_page_token

string | null

Products

Conversational Agent

Collections

Brands

Categories

Websites

Reporting

Price tracking

Models

Authorizations

Query Parameters

Response