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

Get product

`:id` accepts the product id **or** its slug. Returns the option groups, every variant with its own `buyUrl`, the category, media/download/review counts, and the type-specific fields (meeting, membership, webinar, event).

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' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "id": "clx…",
    "title": "Studio Tee",
    "slug": "studio-tee",
    "type": "PHYSICAL",
    "pricingType": "SINGLE",
    "price": 29,
    "currency": "USD",
    "isActive": true,
    "hasVariants": true,
    "exposesVariants": true,
    "requiresVariantSelection": true,
    "buyUrl": "https://shop.example.com/buy/studio-tee",
    "productPageUrl": "https://shop.example.com/p/studio-tee",
    "optionGroups": [
      {
        "id": "color",
        "name": "Color",
        "order": 0,
        "values": [
          { "id": "black", "name": "Black", "order": 0 },
          { "id": "white", "name": "White", "order": 1 }
        ]
      }
    ],
    "counts": { "downloads": 0, "media": 3, "reviews": 12 },
    "skus": [
      {
        "id": "clx…",
        "sku": "BLACK-XS",
        "title": "Black / XS",
        "price": 29,
        "inventory": 12,
        "isSoldOut": false,
        "unitsGranted": null,
        "sortOrder": 0,
        "isRetired": false,
        "options": [{ "group": "Color", "value": "Black" }],
        "variantRef": "BLACK-XS",
        "buyPath": "/buy/studio-tee?variant=BLACK-XS",
        "buyUrl": "https://shop.example.com/buy/studio-tee?variant=BLACK-XS"
      }
    ],
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-15T12:00:00.000Z"
  }
}