channel3-api
Search
Search for products.
post/v0/search
Request body
querystring nullable
Search query
image_urlstring nullable
Image URL
base64_imagestring nullable
Base64 encoded image
limitinteger nullable
Optional limit on the number of results. Default is 20, max is 30.
contextstring nullable
Optional customer information to personalize search results
Response
Successful Response
idstring required
titlestring required
descriptionstring nullable
categoriesstring[]
gender'male' | 'female' | 'unisex' nullable
age'newborn' | 'infant' | 'toddler' | 'kids' | 'adult' nullable
Target age group. Age-agnostic products are typically returned as 'adult'.
materialsstring[] nullable
key_featuresstring[] nullable
structured_attributesobject
Structured attributes extracted for this product, keyed by attribute handle (e.g. 'color', 'material'). Values are the canonical allowed values for that handle.
urlstring required
Deprecated, use offers field
brand_idstring nullable
brand_namestring nullable
image_urlsstring[]
List of image URLs (deprecated, use images field)
availability'InStock' | 'OutOfStock' required
Deprecated, use offers field
scoreinteger required
image_urlstring required
Main product image (deprecated, use images field)
family_id_v3string nullable