Cancel a booked dispatch, by the same resource_id the booking response and the dispatch
job document both carry.
Answers 200 either way, because what the carrier can do is not an HTTP error, the same
rule the dispatch job document itself follows. carrier_cancellation_requested true means
Genesis asked the carrier to cancel and is waiting for it to confirm -- poll the dispatch job
for the final status. False means this carrier does not support cancellation through
Shipwell (reason says so); the dispatch is released on Shipwell's side, but the freight
itself must still be cancelled with the carrier directly.
Successful Response
required | object (CancelDispatchResult) The outcome of a cancel request. Always
|
Validation Error
No such rate, or no such dispatch job for this tenant.
The resource being updated or created already exists.
An unknown internal server issue occured while processing a request. A report is created and logged.
{- "data": {
- "carrier_cancellation_requested": false,
- "reason": "This carrier does not support dispatch cancellation through Shipwell. You must cancel the load directly with the carrier.",
- "requires_manual_carrier_cancellation": true,
- "resource_id": "9f2c1b84-6d3a-4c17-9b0e-2f5a7c48d31e"
}
}