Skip to main content
POST
/
v0
/
search
Python SDK
from channel3_sdk import Channel3

client = Channel3(api_key="YOUR_API_KEY")

response = client.search.perform(
    query="shoes",
    limit=10
)
print(response)
[
  {
    "id": "<string>",
    "score": 123,
    "url": "<string>",
    "title": "<string>",
    "description": "<string>",
    "brand_name": "<string>",
    "image_url": "<string>",
    "price": {
      "price": 123,
      "compare_at_price": 123,
      "currency": "<string>"
    },
    "categories": [],
    "availability": "InStock",
    "variants": []
  }
]
Send a search request to retrieve a ranked list of products.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
query
string | null
​
image_url
string | null
​
base64_image
string | null
​
limit
integer | null
default:20
​
filters
object
​
config
object
​
context
string | null

Response

​
id
string
required
​
score
integer
required
​
url
string
required
​
title
string
required
​
brand_name
string
required
​
image_url
string
required
​
price
object
required
​
availability
enum<string>
required
Available options:
InStock,
LimitedAvailability,
PreOrder,
BackOrder,
SoldOut,
OutOfStock,
Discontinued,
Unknown
​
description
string | null
​
categories
string[]
​
variants
Variant · object[]