curl --request POST \
--url https://api.henrylabs.ai/v1/product/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "Air Max Shoes",
"merchant": "Nike",
"cursor": 0,
"limit": 40,
"minPrice": 1,
"maxPrice": 100,
"sortBy": "lowToHigh",
"country": "us"
}
'{
"refId": "<string>",
"status": "pending",
"result": {
"products": [
{
"link": "<string>",
"merchant": "<string>",
"host": "<string>",
"sku": "<string>",
"name": "<string>",
"price": {
"value": 123,
"currency": "USD"
},
"description": "<string>",
"images": [
{
"url": "<string>",
"isFeatured": true
}
],
"originalPrice": {
"value": 123,
"currency": "USD"
},
"availability": "in_stock",
"variants": [
{
"sku": "<string>",
"name": "<string>",
"availability": "in_stock"
}
]
}
],
"pagination": {
"nextCursor": "<string>",
"previousCursor": "<string>"
}
},
"error": {}
}Search for products using keyword and passing various filters and criteria
curl --request POST \
--url https://api.henrylabs.ai/v1/product/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "Air Max Shoes",
"merchant": "Nike",
"cursor": 0,
"limit": 40,
"minPrice": 1,
"maxPrice": 100,
"sortBy": "lowToHigh",
"country": "us"
}
'{
"refId": "<string>",
"status": "pending",
"result": {
"products": [
{
"link": "<string>",
"merchant": "<string>",
"host": "<string>",
"sku": "<string>",
"name": "<string>",
"price": {
"value": 123,
"currency": "USD"
},
"description": "<string>",
"images": [
{
"url": "<string>",
"isFeatured": true
}
],
"originalPrice": {
"value": 123,
"currency": "USD"
},
"availability": "in_stock",
"variants": [
{
"sku": "<string>",
"name": "<string>",
"availability": "in_stock"
}
]
}
],
"pagination": {
"nextCursor": "<string>",
"previousCursor": "<string>"
}
},
"error": {}
}Search query
1"Air Max Shoes"
Merchant to filter results
"Nike"
"https://www.nike.com/"
Cursor returned from the previous response
0 <= x <= 90071992547409910
Limit the number of results
1 <= x <= 10020
Maximum price filter
x <= 1000000100
Minimum price filter
x <= 10000001
Sort by price: 'lowToHigh' or 'highToLow'
lowToHigh, highToLow "lowToHigh"
Product search queued successfully, use refId to check status and retrieve results
Was this page helpful?