API Reference

Delete a product, or retire it when history references it; answers the document as it was

delete
https://apis.kentro.live/channel/v1/products/

A product with stock is refused (409 state_conflict). A product (or variant) that order, fulfillment, shipment, invoice, purchase-order or stock history references is RETIRED instead of deleted: its rows stay, its SKU and barcode take a -RETIRED- suffix, and its channel identities and listings are removed. outcome deleted or retired.

Scope: products:write, channel:write or admin.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Query Params
string
length between 1 and 2000

Comma-separated channel ids (uuid or 24-hex, at most 50) that must not receive the product-deleted event.

string

Legacy alias of the Idempotency-Key header.

Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?