GET /2026-05/cloud/label/{id}/cancellation-status
Method: GET
URL:
Sandbox URL:
Description: Retrieves the current outcome of a previously requested shipping-label cancellation.
Parameters
| Parameter | Description | Type |
|---|---|---|
id | Label ID returned by the Create Shipping Label API. | Long, Required |
Response
json
{
"code": 200,
"message": "OK – The request was successful.",
"data": {
"id": 8050996080689152,
"status": "cancelled"
}
}| Status | Description | Client action |
|---|---|---|
cancelling | Cancellation has been accepted and is still being processed or retried. | Keep the label active and poll again. |
cancelled | Cancellation completed successfully. This is terminal. | Mark the label cancelled. |
cancellation_failed | Cancellation has stopped retrying and did not complete. The label remains active. | Keep the label active and resolve the failure before attempting another cancellation. |
Notes
- Poll this endpoint only after the Cancel Shipping Label API returns
cancelling. - A
409response means cancellation was not requested for this label. - A
404response means the label does not exist or does not belong to the authenticated account. - Do not treat
cancellingascancelled; a cancellation can still fail until this endpoint returnscancelled.
