Cancel a pending parcel quote

View as Markdown
Cancel a parcel quote that has **not** been converted to a shipment. Only `pending` quotes can be cancelled. Cancelling a quote is a soft action: the quote stays retrievable with `status` set to `cancelled` (see `cancelled_at`, `closed_reason`, and `comment`). Once cancelled it cannot be purchased (`create_shipment` will reject it).

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

idstringRequired
Parcel quote token

Request

This endpoint expects an object.
commentstringOptional

Optional free-text reason for the cancellation.

Response

OK — quote cancelled

parcel_quote_idstringOptional
statusenumOptional
sourcestringOptional
directionstringOptional
referencestringOptional
rateslist of objectsOptional
senderobjectOptional
recipientobjectOptional
packageobjectOptional

Air weight/dimensions, or ocean packages[] nested under package in responses.

cargo_volumestringOptional

Human-readable cargo summary, e.g. 2 x 40' (ocean) or 5 kg (air).

origin_detailsobjectOptional
dest_detailsobjectOptional
parcel_detailsobjectOptional
tracking_codestring or nullOptional
label_urlstring or nullOptional
selected_rateobject or nullOptional
tracker_idstring or nullOptional
purchased_atdatetime or nullOptional

Legacy booking timestamp when status is booked. Same moment as booked_at. Not payment confirmation for ocean/import intake quotes.

booked_atdatetime or nullOptional

When the quote became booked. Null while pending.

cancelled_atdatetime or nullOptional

When the quote was cancelled. Null while not cancelled.

closed_reasonstring or nullOptional
Reason the quote was cancelled.
commentstring or nullOptional

Optional free-text note attached when the quote was cancelled.

estimated_pricedouble or nullOptional

NGN total from selected_rate.rate. For ocean/import intake, provisional until warehouse receive; customer payment is invoiced separately.

created_atdatetimeOptional

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error