Skip to main content
POST
/
product
/
search
curl --request POST \
  --url https://api.henrylabs.ai/v1/product/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "searchType": "text",
  "query": "Air Max Shoes",
  "merchant": "Nike",
  "cursor": 0,
  "limit": 40,
  "minPrice": 1,
  "maxPrice": 100,
  "sortBy": "lowToHigh",
  "country": "US",
  "mode": "async"
}
'
{
  "refId": "<string>",
  "status": "pending",
  "result": {
    "products": [
      {
        "link": "<string>",
        "merchant": "<string>",
        "host": "<string>",
        "name": "<string>",
        "sku": "<string>",
        "description": "<string>",
        "images": [
          {
            "url": "<string>",
            "isFeatured": true
          }
        ],
        "price": {
          "value": 123,
          "currency": "USD"
        },
        "originalPrice": {
          "value": 123,
          "currency": "USD"
        },
        "availability": "in_stock",
        "variants": [
          {
            "name": "<string>",
            "sku": "<string>",
            "availability": "in_stock"
          }
        ]
      }
    ],
    "pagination": {
      "nextCursor": "<string>",
      "previousCursor": "<string>"
    }
  },
  "error": {}
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
searchType
string
required

Search using a text query

Allowed value: "text"
Example:

"text"

​
query
string
required

Search query

Minimum string length: 1
Example:

"Air Max Shoes"

​
mode
enum<string>

Response mode. Use sync to wait up to 30 seconds for the backing worker flow to complete.

Available options:
async,
sync
Example:

"async"

​
merchant
string

Merchant to filter results

Example:

"Nike"

​
cursor
integer

Cursor returned from the previous response

Required range: 0 <= x <= 9007199254740991
Example:

0

​
limit
number
default:20

Limit the number of results

Required range: 1 <= x <= 100
Example:

20

​
maxPrice
number

Maximum price filter

Required range: x <= 1000000
Example:

100

​
minPrice
number

Minimum price filter

Required range: x <= 1000000
Example:

1

​
sortBy
enum<string>

Sort by price: 'lowToHigh' or 'highToLow'

Available options:
lowToHigh,
highToLow
Example:

"lowToHigh"

​
country
string

Country code for the search results

Example:

"US"

Response

Product search queued successfully, use refId to check status and retrieve results

​
refId
string
required
Pattern: ^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$
​
status
enum<string>
required
Available options:
pending,
processing,
complete,
failed
​
result
object
​
error
object