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

Delete variant

Retires the variant by default: it stops being purchasable but past orders still resolve it. Pass `?force=true` to delete the row outright, which detaches it from purchase history — only do that for a variant that was never sold.

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

Query parameters

NameRequiredDescription
forceNo`true` to permanently delete instead of retiring

Request

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

Response

{
  "success": true,
  "message": "Variant retired. It is no longer purchasable but past orders still resolve it.",
  "data": { "id": "clx…", "sku": "BLACK-XL", "retired": true }
}