Cancel a Shipment
This endpoint allows you to cancel a shipment and void the label in eHub’s system. Please note that if the label has been scanned by the carrier, you will still be charged. Additionally, USPS, which operates on a prepay basis, holds funds for 30 days before issuing a refund to verify that the label was not used. If the shipment has already been shipped, you must contact the carrier directly to cancel.
Response
- If the shipment is successfully canceled, the response will have a status code of 200.
- The shipment resource will be returned with all original fields, but the status field will be updated to cancel_pending.
- These status updates are located in shipment.parcels[i].status and shipment.status.
Canceling a Production USPS Label
- You can cancel a USPS label in production up until it has been manifested in the USPS system.
- USPS manifests new shipments around 2:00 AM Central Time daily. If you don’t cancel before this time, USPS will reject your cancellation request.
- Shipments with a
ship_dateset to the current day will be automatically manifested. You can specify aship_dateup to 14 days in the future to avoid immediate manifesting.
Canceling a Test USPS Label
- You are not charged when a test USPS label is generated, so canceling a test label is not necessary.
- If you want to test your cancellation functionality, you can try canceling a test label. However, act quickly: USPS will reject cancel requests that aren't sent within a minute of label creation.
Canceling Other Carrier Labels
- For UPS, FedEx, or other carriers, the shipment will be canceled immediately.
- If the carrier receives the shipment and can verify that the label was used, your account will still be charged.
Path Parameters
idinteger Required
Response
200
Object
Cancel a Shipment
Response Attributes
shipmentobject
Shipment object
Show child attributes
paymentobject
Shipment payment
Show child attributes
Was this section helpful?
PUT
/
Select
1
Response
Was this section helpful?