The Cancel Shipment API allows for an existing shipment case to be cancelled. It is a very simple call that only requires a valid Shipment ID and Disposition Reason. Note that this API cancels the entire shipment. Use the Assign Shipment API and its appropriate item assignment configuration to cancel only part of the shipment.
The .json address above can be used to access the schema within Postman. An example use of the Shipment API follows below, or view the schema or the sample Postman Collection.
The example case creates a cancel request with the following information:
- Shipment ID – 1010101
- Disposition Reason – Customer changed mind
Canceling a shipment is simple, as it has two required parameters and only one optional:
|shipmentID||integer||A unique identifier for the shipment. The minimum value is "1".|
|dispositionReason||enum||The reason for the cancellation (customer_changed_mind, created_by_mistake, etc.). See the schema for the full list of possible values.|
This optional parameter is only used to provide an additional explanation when the Disposition Reason was set to “other”.
|dispositionOtherReason||string||If dispositionReason is ’other’, provide an explanation here. Minimum length is 1 and maximum length is 255.|
The Full Request
This is the entire request that will cancel the example shipment. Note how the disposition reason is defined.
"dispositionOtherReason": "Customer changed mind"
The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was canceled.