curl --request POST \
--url https://api.henrylabs.ai/v0/products/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"query": "Air Max Shoes",
"brand": "Nike",
"merchant": "DICK's Sporting Goods",
"limit": 40,
"maxPrice": 200,
"minPrice": 50,
"freeShipping": false,
"smallBusiness": false,
"sortBy": "lowToHigh",
"cursor": 0,
"region": "Austin, Texas",
"country": "us",
"onSale": false,
"filter": "ppr_max:100",
"enrichTopK": 5
}
EOF{
"success": true,
"status": "<string>",
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"currency": "<string>",
"imageUrl": "<string>",
"source": "<string>",
"originalPrice": "<string>",
"enrichRequestId": "<string>"
}
],
"pagination": {
"nextCursor": "<string>",
"previousCursor": "<string>"
},
"filters": [
{
"type": "<string>",
"inputType": "<string>",
"options": [
{
"text": "<string>",
"value": "<string>"
}
]
}
]
}Search for products using keyword and passing various filters and criteria
curl --request POST \
--url https://api.henrylabs.ai/v0/products/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"query": "Air Max Shoes",
"brand": "Nike",
"merchant": "DICK's Sporting Goods",
"limit": 40,
"maxPrice": 200,
"minPrice": 50,
"freeShipping": false,
"smallBusiness": false,
"sortBy": "lowToHigh",
"cursor": 0,
"region": "Austin, Texas",
"country": "us",
"onSale": false,
"filter": "ppr_max:100",
"enrichTopK": 5
}
EOF{
"success": true,
"status": "<string>",
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"currency": "<string>",
"imageUrl": "<string>",
"source": "<string>",
"originalPrice": "<string>",
"enrichRequestId": "<string>"
}
],
"pagination": {
"nextCursor": "<string>",
"previousCursor": "<string>"
},
"filters": [
{
"type": "<string>",
"inputType": "<string>",
"options": [
{
"text": "<string>",
"value": "<string>"
}
]
}
]
}Search query
1"Air Max Shoes"
Limit the number of results
1 <= x <= 10040
Maximum price filter
x <= 1000000100
Minimum price filter
x <= 10000001
Restrict results to listings with free shipping
false
Restrict results to merchants labeled as small business
false
Sort by price: 'lowToHigh' or 'highToLow'
lowToHigh, highToLow "lowToHigh"
Cursor returned from the previous response
0 <= x <= 90071992547409910
us, uk, gb, ca, au, de, fr, es, it, jp, br, mx, in, nl, be, at, ch, se, no, dk, fi, pl, pt, ie, nz, sg, hk, kr Filter for items on sale
false
Experimental: Auto-enrich top K results. Returns enrichRequestId for each product to poll for enriched data.
1 <= x <= 205
Was this page helpful?