Retrieve a parcel quote

View as Markdown
Returns the quote with sender, recipient, package/cargo, and pricing. - **Pending export air** — rates are refreshed automatically on each `GET`. - **Pending ocean** — if the estimate is older than one hour, ocean pricing is recomputed (new `rate_id` and amount); otherwise returns the cached single `Ocean Freight` rate in `rates[]`. - **Booked** quotes — `rates[]` may be empty; see `selected_rate` and `estimated_price`. Customer payment is on **invoices**, not the quote.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

idstringRequired
Parcel quote token

Response

OK
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.

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