Introduction
The Void Parcel API lets you take out a declared parcel if you do not intend to send it or if it needs to be updated due to changed shipment requirements. **Note:**At least one order ID should be provided in the request, Global-eOrderId or the merchant’s MerchantOrderId.
Integration Overview
Method/URL- string
OrderId(mandatory) - Order unique identifier - string
ParcelCode(mandatory) - Code used to identify theParcelCodeto void. - string
MerchantOrderId- The merchant’s order unique identifier.
Example
Request:Error Handling
| Error Code | Error Text | Additional Information |
|---|---|---|
| C100 | The parcel cannot be voided due to the status of the parcel.For a Global‑e operated hub, only the following statuses can be voided:Failed Transfer To ShippingShipped By Merchant | This is the error in case the hub is operated by Global-e and the parcel has the wrong status. |
| C101 | The parcel cannot be voided due to the status of the parcel. For merchant-operated hubs, only the following statuses can be voided:Failed Transfer To ShippingShipped By MerchantReceived In Hub | This is the error in case the hub is operated by the Merchant and the parcel has the wrong status. |
| C102 (Log) | The parcel was voided, but the shipper’s API to cancel the shipment failed.The following information is available from the shipper.Error code: <shipper error code>Error text: <error text> | The API success (IsSuccess=True).Add it to the log and to the relevant field in the response |
| C103 | Internal unknown failure | - |
| C104 | The parcel code was not found, or the parcel was already voided | - |