Shipment Cancellation API
The Shipment Cancellation API allows customers to cancel consignments that have been created but not yet picked up.
Cancel a Consignment
Endpoint:POST /v1/carriers/{carrierName}/customers/{customerId}/consignments/{consignmentId}/cancellationrequests
Description:
Requests the cancellation of a consignment by its unique identifier.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
carrierName |
string | ✅ | Freightways carrier (e.g., PostHaste, NowCouriers) |
customerId |
string | ✅ | Customer ID under the carrier account |
consignmentId |
string | ✅ | Unique consignment identifier to be cancelled |
Request Body Example
Response Example (200 OK)
Behavior Notes
Cancelling a shipment is subject to timing — consignments already picked up or manifested cannot be cancelled.
The system logs cancellation requests asynchronously and returns a confirmation ID for tracking.
If cancellation cannot be processed (e.g., consignment already in transit), a detailed error is returned.
Error Codes
| HTTP | Description |
|---|---|
| 400 | Bad request (missing required field) |
| 401 | Unauthorized — invalid API key or token |
| 403 | Forbidden — insufficient permissions |
| 404 | Consignment not found |
| 429 | Too many requests |
| 500 | Internal error — cancellation service unavailable |