Skip to main content
POST
/
v1
/
search
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_response = client.search.perform()
print(search_response.products)
{
  "products": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "brands": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "images": [],
      "categories": [],
      "gender": "male",
      "materials": [
        "<string>"
      ],
      "key_features": [
        "<string>"
      ],
      "offers": [
        {
          "url": "<string>",
          "domain": "<string>",
          "price": {
            "price": 123,
            "currency": "<string>",
            "compare_at_price": 123
          },
          "availability": "InStock",
          "max_commission_rate": 0
        }
      ]
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Search request with pagination support.

​
query
string | null

Search query

​
image_url
string | null

Image URL

​
base64_image
string | null

Base64 encoded image

​
limit
integer | null
default:20

Optional limit on the number of results. Default is 20, max is 30.

Required range: x >= 1
​
filters
SearchFilters · object

Optional filters. Search will only consider products that match all of the filters.

​
config
SearchConfig · object

Optional configuration

​
page_token
string | null

Opaque token from a previous search response to fetch the next page of results.

Response

Successful Response

v1 paginated search response.

​
products
Product · object[]
required
​
next_page_token
string | null

Token to fetch the next page. Null when no more results.