Voids (cancels) one or more orders by tracking number. Voided orders cannot be shipped.
Orders cannot be voided after they enter IN_TRANSIT status.
Request Body
Unique key to prevent duplicate void operations (8-64 characters).
List of tracking numbers to void (1-100 items).
Reason for voiding (5-500 characters). Required for audit purposes.
Response
Whether the request succeeded
List of successfully voided tracking numbers
List of tracking numbers that could not be voided
The tracking number that failed
Why the void operation failed
{
"idempotencyKey": "void-2024-001",
"trackingNumbers": [
"CBECUSD123456789",
"CBECUSD987654321"
],
"reason": "Customer cancelled order before shipment"
}
{
"success": true,
"voided": ["CBECUSD123456789", "CBECUSD987654321"],
"failed": []
}
Void Rules
| Parcel Status | Can Void? |
|---|
ORDERED | ✅ Yes |
LABEL_GENERATED | ✅ Yes |
MANIFEST_SUBMITTED | ⚠️ Depends on carrier |
CUSTOMS_CLEARANCE | ❌ No |
IN_TRANSIT | ❌ No |
DELIVERED | ❌ No |
ALREADY_VOIDED | ✅ Returns success (idempotent) |
Idempotency
If you retry a void request with the same idempotencyKey, the original response is returned:
- If the original void succeeded, success is returned again
- Already-voided parcels return success without error