DocsAPI ReferenceProduct/bff/product/product-soft-delete
postProductAdmin BFF

/bff/product/product-soft-delete

Stamps deleted_date = NOW(), flips the legacy deleted boolean, and turns active = false. The product disappears from the default product list, public storefront, feeds and search. Idempotent at the DB layer — but the BFF returns 410 Gone if you call this on an already-deleted product (the resolver refuses to load it). Use /product-restore to undo.

ProductpostBffProductProduct-soft-delete

Parameters

2 body

2 total
Body · 2
productCodestringRequired

Product code to soft-delete.

Length: 1
reasonstring

Free-form reason recorded in the activity log (no validation).

Request

POST /bff/product/product-soft-delete

post
curl -X POST "https://api.bizkithub.com/bff/product/product-soft-delete" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "productCode": "my-product",
  "reason": "Removed from catalogue per supplier request"
}'

Response

JSON payload

{
  "success": false,
  "code": "example_code",
  "deletedDate": "example_deletedDate"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key