Skip to content

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

Method: POST

URL:

Sandbox URL:

Description: Cancels a shipping label immediately in ZhenHub when it has not been scanned by the warehouse.

Parameters ​

ParameterDescriptionType
idLabel ID returned by the Create Shipping Label API.Long, Required
reasonOptional cancellation reason. Maximum length: 250.String

Body ​

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

The body may be omitted when no reason is required.

Response ​

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

Possible status values:

StatusDescription
cancelledThe label has been cancelled in ZhenHub.

Notes ​

  • Repeating a cancellation request for a label that is already cancelled is safe.
  • A label cannot be cancelled after the shipment has been scanned by the warehouse.
  • If a shipment was scanned by the warehouse, remove it from the warehouse operation before requesting cancellation again.
  • Carrier cancellation is a follow-up cleanup action. A carrier error does not roll back the ZhenHub cancelled status.
  • A 409 response means the label has already been scanned by the warehouse.