Void Order - CrossBorderly API

{
  "idempotencyKey": "void-2024-001",
  "trackingNumbers": [
    "CBECUSD123456789",
    "CBECUSD987654321"
  ],
  "reason": "Customer cancelled order before shipment"
}

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

{
  "success": true,
  "voided": ["CBECUSD123456789"],
  "failed": [
    {
      "trackingNumber": "CBECUSD987654321",
      "reason": "Parcel is already in transit and cannot be voided"
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Reason must be at least 5 characters",
    "message_es": "La razón debe tener al menos 5 caracteres",
    "requestId": "req_abc123"
  }
}

POST

api

orders

void

{
  "idempotencyKey": "void-2024-001",
  "trackingNumbers": [
    "CBECUSD123456789",
    "CBECUSD987654321"
  ],
  "reason": "Customer cancelled order before shipment"
}

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

{
  "success": true,
  "voided": ["CBECUSD123456789"],
  "failed": [
    {
      "trackingNumber": "CBECUSD987654321",
      "reason": "Parcel is already in transit and cannot be voided"
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Reason must be at least 5 characters",
    "message_es": "La razón debe tener al menos 5 caracteres",
    "requestId": "req_abc123"
  }
}

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

string

required

Unique key to prevent duplicate void operations (8-64 characters).

array

required

List of tracking numbers to void (1-100 items).

string

required

Reason for voiding (5-500 characters). Required for audit purposes.

Response

boolean

Whether the request succeeded

array

List of successfully voided tracking numbers

array

List of tracking numbers that could not be voided

Show Failed item fields

string

The tracking number that failed

string

Why the void operation failed

{
  "idempotencyKey": "void-2024-001",
  "trackingNumbers": [
    "CBECUSD123456789",
    "CBECUSD987654321"
  ],
  "reason": "Customer cancelled order before shipment"
}

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

{
  "success": true,
  "voided": ["CBECUSD123456789"],
  "failed": [
    {
      "trackingNumber": "CBECUSD987654321",
      "reason": "Parcel is already in transit and cannot be voided"
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Reason must be at least 5 characters",
    "message_es": "La razón debe tener al menos 5 caracteres",
    "requestId": "req_abc123"
  }
}

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

Create Order Submit Manifest

​Request Body

​Response

​Void Rules

​Idempotency

Request Body

Response

Void Rules

Idempotency