This documentation is generated by Sensefuel.
AI Search & Product Discovery platform that makes ecommerce search personal.
List products
GET
/{siteUUID}/listing/products
Access requirements:
Response:
Request
Path Params
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/00c5b43d-9306-49e0-8c39-04e77aa4bf56/listing/products?scope_name=Skincare%20%3E%20Face&scope_id=cat-123&user_id=22dbe3da-82f9-41cb-b782-2e209924df42&from=0&size=24&sort=price&order=asc&include=filters&include=showcases&spotlights=spotlight_brand_1&filter=[object%20Object]&store_code=store_123&fields=title&fields=price&fields=brand&fields=color&variants=&segments=[object%20Object]' \
--header 'x-ranking-token: eyJyYW5raW5nIjoiLi4uIn0=' \
--header 'x-session-id: session-123' \
--header 'X-API-KEY: <api-key>'Response Response Example
200 - Example 1
{
"total": 100,
"products": [
{
"score": 8.949373,
"product_id": "81905_Marine",
"article_id": "819050155",
"title": "Moisturizing cream",
"brand": "Yves Rocher",
"color": "white",
"price": 10.99,
"variants": [
{
"article_id": "819050155",
"price": 10.99,
"product_id": "81905_Marine"
},
{
"article_id": "819050163",
"price": 10.99,
"product_id": "81905_Marine"
},
{
"article_id": "819050171",
"price": 10.99,
"product_id": "81905_Marine"
}
]
}
],
"filters": [
{
"field": "brand",
"labels": {
"singular": "Brand",
"plural": "Brands"
},
"values": [
{
"value": "Yves Rocher",
"count": 10,
"score": 5,
"pr": 1
}
],
"score": 5,
"pr": 1
}
],
"autocomplete": [
{
"value": "moisturizing cream",
"score": 4,
"pr": 1
}
],
"spellcheck": {
"corrected": "cream"
},
"rankingToken": "eyJyYW5raW5nIjoiLi4uIn0="
}