", "url": "<string>", "title": "<string>", "price": ..." />", "url": "<string>", "title": "<string>", "price": ..." />Search - Channel3
Skip to main content
POST
/
v0
/
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
)
products = client.search.perform()
print(products)
[
  {
    "id": "<string>",
    "url": "<string>",
    "title": "<string>",
    "price": {
      "price": 123,
      "currency": "<string>",
      "compare_at_price": 123
    },
    "availability": "InStock",
    "score": 123,
    "image_url": "<string>",
    "description": "<string>",
    "brand_id": "<string>",
    "brand_name": "<string>",
    "image_urls": [],
    "images": [],
    "categories": [],
    "gender": "male",
    "materials": [
      "<string>"
    ],
    "key_features": [
      "<string>"
    ],
    "variants": []
  }
]

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
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

​
context
string | null

Optional customer information to personalize search results

Response

Successful Response

​
id
string
required
​
url
string
required
​
title
string
required
​
price
Price · object
required
​
availability
enum<string>
required
Available options:
InStock,
LimitedAvailability,
PreOrder,
BackOrder,
SoldOut,
OutOfStock,
Discontinued,
Unknown
​
score
integer
required
​
image_url
string
required
deprecated

Main product image (deprecated, use images field)

​
description
string | null
​
brand_id
string | null
​
brand_name
string | null
​
image_urls
string[]
deprecated

List of image URLs (deprecated, use images field)

​
images
ProductImage · object[]
​
categories
string[]
​
gender
enum<string> | null
Available options:
male,
female,
unisex
​
materials
string[] | null
​
key_features
string[] | null
​
variants
Variant · object[]