Skip to main content
POST
/
api
/
v1
/
orders
/
void
{
  "idempotencyKey": "void-2024-001",
  "trackingNumbers": [
    "CBECUSD123456789",
    "CBECUSD987654321"
  ],
  "reason": "Customer cancelled order before shipment"
}

{
  "success": true,
  "voided": ["CBECUSD123456789", "CBECUSD987654321"],
  "failed": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.crbtrack.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
idempotencyKey
string
required
Unique key to prevent duplicate void operations (8-64 characters).
​
trackingNumbers
array
required
List of tracking numbers to void (1-100 items).
​
reason
string
required
Reason for voiding (5-500 characters). Required for audit purposes.

​
Response

​
success
boolean
Whether the request succeeded
​
voided
array
List of successfully voided tracking numbers
​
failed
array
List of tracking numbers that could not be voided
{
  "idempotencyKey": "void-2024-001",
  "trackingNumbers": [
    "CBECUSD123456789",
    "CBECUSD987654321"
  ],
  "reason": "Customer cancelled order before shipment"
}

{
  "success": true,
  "voided": ["CBECUSD123456789", "CBECUSD987654321"],
  "failed": []
}

​
Void Rules

Parcel StatusCan 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