Hanzo
OpenapiCommerce

Delete a sales channel, keeping a recoverable copy

A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.

DELETE /v1/commerce/saleschannel/{saleschannelid}

Addresshttps://api.hanzo.ai/v1/commerce/saleschannel/{saleschannelid}
MethodDELETE
Operationdelete_commerce_saleschannel_by_saleschannelid
AuthAuthorization: Bearer $HANZO_API_KEY

A sales channel is a named selling surface — a name, a description, a disabled flag and metadata. The flag is NEGATIVE, so a channel created from an empty body is enabled. Nothing on this row links products, prices or stock to the channel; here it is a label other surfaces scope themselves by. Removes the addressed row and answers 204 with no body. Before the live row goes it is written once more under a deleted tombstone kind, so a deletion leaves a recoverable copy rather than destroying the record outright — and a tombstone that cannot be written fails the call with 500 before anything is removed. The id is resolved inside the caller org's own namespace, so an absent or foreign id is 404. Any valid access token reaches it. The org must also be entitled to the commerce admin: the paywall answers 402 subscription_required unless the org holds an active or trialing pro subscription, a live trial credit or a redeemed invite, and 503 when that entitlement cannot be read rather than admitting on an unknown. The internal service token and a platform superadmin pass straight through. The per-kind permission table has no entry for saleschannel, so the scaffold skips that second check with a warning and the gate above is the whole authorization story.

Request

1 field.

FieldInTypeRequiredDescription
saleschannelidpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo commerce saleschannel rm <saleschannelid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page