Skip to main content
POST
/
product
/
details
Product Details
curl --request POST \
  --url https://api.henrylabs.ai/v1/product/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "link": "https://www.nike.com/u/custom-nike-ja-3-by-you-10002205",
  "variant": {
    "size": "10",
    "color": "Black"
  },
  "country": "US"
}
'
{
  "refId": "<string>",
  "status": "pending",
  "result": {
    "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"
      }
    ],
    "metadata": {}
  },
  "error": {}
}

Authorizations

x-api-key
string
header
required

Body

application/json

Direct product URL

Example:

"https://www.nike.com/u/custom-nike-ja-3-by-you-10002205"

variant

Variant selection. Can be a simple string or a key-value object

Minimum string length: 1
Example:

"select the black shoe (ID: 4639822147), size M 10"

country
string

Response

Product details 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