/bff/product/delete-product-variant

Soft-deletes (hides) a product variant. The variant is removed from the read model and the public API, but preserved in the database and referenced by any existing orders/cart items. Use /restore-product-variant to bring it back.

ProductpostBffProductDelete-product-variant

Parameters

JSON body

Request body

application/json

codestringRequired

Product code the variant belongs to.

Examplemy-product

variantCodestringRequired

Variant code to hide.

Examplevariant-xl

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the variant was hidden.

Response example

application/json

{
  "success": false
}

Request example

POST /bff/product/delete-product-variant

post

curl -X POST "https://api.bizkithub.com/bff/product/delete-product-variant" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "my-product",
  "variantCode": "variant-xl"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key