Skip to main content

Void Sales Channel Shipping Label

POST 

/api/sales-orders/:salesOrder/channel-shipping-labels/:label/void

Void (discard) one of the order's channel shipping labels with the channel that bought it, so it is not used or billed. No request body.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Requires the sales_orders.update permission.

Only labels whose can_void is true in List Sales Channel Shipping Labels can be voided. A label already used to ship cannot be voided, and TikTok Shop labels can only be cancelled in TikTok Seller Center. When the channel refuses, the label keeps its cost on the order and the reason is returned. Voiding an already-voided label succeeds without calling the channel.

Response fields: status (the label's status after the call, voided on success) and voided_at (ISO 8601 UTC).

Errors: 422 with a message when the label does not belong to the order, cannot be voided, or the channel refused; 404 when the sales order does not exist.

Path parameters:

  • salesOrder (required): Sales order ID.
  • label (required): the label's label_id.

Request​

Responses​

OK

Response Headers
    Content-Type