Search Categories

Python

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
search_categories_response = client.categories.search(
    query="x",
)
print(search_categories_response.categories)

{
  "categories": [
    {
      "slug": "<string>",
      "title": "<string>",
      "has_children": true,
      "path": [
        {
          "slug": "<string>",
          "title": "<string>"
        }
      ]
    }
  ]
}

GET

categories

Python

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
search_categories_response = client.categories.search(
    query="x",
)
print(search_categories_response.categories)

{
  "categories": [
    {
      "slug": "<string>",
      "title": "<string>",
      "has_children": true,
      "path": [
        {
          "slug": "<string>",
          "title": "<string>"
        }
      ]
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

query

string

required

Free-text query (e.g. 'sofas', 'yoga mats').

Required string length: 1 - 200

limit

integer

default:5

Maximum number of categories to return.

Required range: 1 <= x <= 20

Response

Successful Response