POST /2026-05/cloud/label/{id}/cancel

Method: POST

URL:

Sandbox URL:

Description: Cancels a shipping label. Cancellation may be processed asynchronously by the carrier.

Parameters

Parameter	Description	Type
id	Label ID returned by the Create Shipping Label API.	Long, Required
reason	Optional cancellation reason. Maximum length: 250.	String

Body

{
  "reason": "Shipment is no longer required"
}

The body may be omitted when no reason is required.

Response

{
  "code": 200,
  "message": "OK – The request was successful.",
  "data": {
    "id": 8050996080689152,
    "status": "cancelling"
  }
}

Possible status values:

Status	Description
cancelling	The cancellation request has been accepted and is being processed.
cancelled	The label has been cancelled.

Notes

• Repeating a cancellation request for a label that is already cancelling or cancelled is safe.
• A label cannot be cancelled after the shipment has been scanned by the warehouse.
• A label cannot be cancelled after it has entered a non-cancellable shipment stage.
• A successful response with cancelling means the request was accepted; it does not mean carrier cancellation has completed.
• When the response status is cancelling, poll the Cancellation Status API until it returns cancelled or cancellation_failed.
• A 409 response means the label has been scanned by the warehouse or is otherwise no longer cancellable.