Category Detail

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

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

client.categories.retrieve(
    slug="slug",
)

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

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

{
  "slug": "<string>",
  "title": "<string>",
  "has_children": true,
  "path": [
    {
      "slug": "<string>",
      "title": "<string>"
    }
  ],
  "description": "<string>",
  "children": [
    {
      "slug": "<string>",
      "title": "<string>"
    }
  ],
  "attributes": [
    {
      "slug": "<string>",
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ]
}

GET

categories

{slug}

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

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

client.categories.retrieve(
    slug="slug",
)

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

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

{
  "slug": "<string>",
  "title": "<string>",
  "has_children": true,
  "path": [
    {
      "slug": "<string>",
      "title": "<string>"
    }
  ],
  "description": "<string>",
  "children": [
    {
      "slug": "<string>",
      "title": "<string>"
    }
  ],
  "attributes": [
    {
      "slug": "<string>",
      "name": "<string>",
      "values": [
        "<string>"
      ]
    }
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

slug

string

required

Response

Successful Response

Full category representation used in detail responses.

slug

string

required

URL-friendly slug (e.g. 'sofas')

title

string

required

Human-readable category title

has_children

boolean

required

Whether this category has subcategories

path

CategoryRef · object[]

Hierarchical path as a structured list, root first; the last entry is this category itself

Show child attributes

description

string | null

Natural-language description of products in this category

children

CategoryRef · object[]

Direct subcategories only (one level)

Show child attributes

attributes

CategoryAttribute · object[]

Structured attributes applicable to this category, with their allowed values. Usable as keys in SearchFilters.attributes. Includes the variant axes ('color', 'size', 'shoe-size') where the category defines them; those match against each offer's variant options.

Show child attributes

Products

Conversational Agent

Collections

Brands

Categories

Websites

Reporting

Price tracking

Models

Authorizations

Path Parameters

Response