Cancels an in-progress delivery for the given parcels, when cancellation is still permitted. Delivery cannot be cancelled once the parcel has been picked up. Cancellation is allowed in the following states: qualifiedforpickup, onroutetopickup, and pickingup. Please note that cancellation may incur costs.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Cancellation request accepted and is being processed.
Unauthorized. Missing or invalid authentication token.
One or more parcels were not found.
One or more parcels cannot be cancelled due to their current state. Cancellation is only allowed in the qualifiedforpickup, onroutetopickup, or pickingup states.
Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.