Skip to main content
POST
Void a declared parcel
Part of the Shipping Documents API integration guide — see it for when and how to use this endpoint.

Body

application/json
OrderId
string
required

Order unique identifier.

ParcelCode
string
required

Code used to identify the ParcelCode to void.

MerchantOrderId
string

The merchant's order unique identifier.

Response

200 - application/json

Result of the void request. Object-level problems are reported in the body with the Errors array populated; IsSuccess can still be true for a logged shipper-cancel failure (code C102).

IsSuccess
boolean

Indicates whether the parcel was voided successfully.

Errors
object[]

Error entries; empty on success. Documented Void Parcel error codes are C100 and C101 (parcel cannot be voided due to its status), C102 (parcel voided but the shipper's cancel API failed — logged, with IsSuccess still true), C103 (internal unknown failure), and C104 (parcel code not found or already voided).