Skip to main content
POST
/
product
/
search
/
status
Product Search Status
curl --request POST \
  --url https://api.henrylabs.ai/v1/product/search/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "refId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'
{
  "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": {}
}

Authorizations

x-api-key
string
header
required

Body

application/json
refId
string
required

Reference ID used for checking status

Pattern: ^[a-zA-Z]{3}-ref_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}$

Response

Product search status retrieved successfully

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