Shipments
Cancel before handoff
POST/shipments/{shipmentId}/cancel
Scope shipments.cancelIdempotency-Key required
LIVE only before custody handoff; a wallet-paid parcel also needs wallet.spend. Paid or uncertain-payment parcels need assisted cancellation (409).
Request
Headers
| Name | In | Type | Description |
|---|---|---|---|
AuthorizationRequired | header | string | Bearer <API key> |
Idempotency-KeyRequired | header | string | 8–160 characters (A-Z, a-z, 0-9, . _ : -). Retrying with the same key and body returns the original result; another body returns 409. See Idempotency.Pattern ^[A-Za-z0-9._:-]{8,160}$ |
Path parameters
| Name | In | Type | Description |
|---|---|---|---|
shipmentIdRequired | path | string | Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
Body CancelRequest
| Field | Type | Description |
|---|---|---|
reasonRequired | string | 10–500 characters |
Response
| Status | Meaning |
|---|---|
200 | Cancelled (or replay) |
The body is { "status": "success", "data": … }. Fields of data (CancelResult):
| Field | Type | Description |
|---|---|---|
shipmentRequired | object | |
public_idRequired | string | LIVE shipments use QDSHP or QD-SHP-. TEST shipments use QDTST or QD-TST-.Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
tracking_numberOptional | string | |
statusRequired | string | |
replayedRequired | boolean | |
simulatedRequired | boolean |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED). |
404 | Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404. |
409 | Idempotency key reused with another body, or the resource changed state. The idempotency key was used with a different body, a reference is already taken, or the resource changed state. |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |