List Brands

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

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

client.brands.list()

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

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

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "logo_url": "<string>",
      "description": "<string>",
      "best_commission_rate": 0
    }
  ],
  "next_cursor": "<string>"
}

GET

brands

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

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

client.brands.list()

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

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

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "logo_url": "<string>",
      "description": "<string>",
      "best_commission_rate": 0
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

x-api-key

string

header

required

Query Parameters

limit

integer

default:20

Max items per page (1-100).

Required range: 1 <= x <= 100

cursor

string | null

Pagination cursor returned by a prior call. Omit for the first page.

category_ids

string[] | null

If provided, only brands selling in these categories will be returned. Accepts category slugs. Categories that do not exist, or that are not available for search, are rejected with a 422.

country

enum<string> | null

ISO 3166-1 alpha-2 country code that best_commission_rate is scoped to. Defaults to 'US' when unset. ISO 3166-1 alpha-2 country code (plus the pan-region EU).

Available options:

US,

GB,

EU,

AU,

CA,

IE,

DE,

AT,

FR,

BE,

IT,

ES,

NL,

SE,

FI,

PT,

CZ,

GR,

RO,

CH

Response

Successful Response

items

Brand · object[]

required

List of brands

Show child attributes

next_cursor

string | null

Cursor to fetch the next page of results. Null if no more results.

Products

Conversational Agent

Collections

Brands

Categories

Websites

Reporting

Price tracking

Models

Authorizations

Query Parameters

Response