← Home
GET/hyax-api/v1/products/:id/variants/:variantId

Get variant

`:variantId` resolves against the row id, the SKU code (case-insensitive, punctuation-insensitive), or the variant title — so the value out of a `buyUrl` works directly.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request

curl -X GET 'https://platform.hyax.com/hyax-api/v1/products/clx_example_id/variants/:variantId' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "id": "clx…",
    "sku": "BLACK-XS",
    "title": "Black / XS",
    "price": 29,
    "inventory": 12,
    "isSoldOut": false,
    "isRetired": false,
    "options": [{ "group": "Color", "value": "Black" }],
    "variantRef": "BLACK-XS",
    "buyUrl": "https://shop.example.com/buy/studio-tee?variant=BLACK-XS"
  }
}