Get Rate

Creates an import quote and returns the rate. | Field | Air (`air`) | Ocean FCL (`ocean_fcl`) | Ocean LCL (`ocean_lcl`) | | --- | --- | --- | --- | | `lane_code` | Required | Required | Required | | `transport_mode` | `air` | `ocean_fcl` | `ocean_lcl` | | `commodity_code` | Required | Required | Required | | `weight` (kg) | Required, positive | Not accepted | Not accepted | | `volume` (CBM, total) | Not accepted | Not accepted | Required, positive | | `container_size` | Not accepted | Required: `20ft` or `40ft` | Not accepted | | `quantity` | Not accepted | Required, whole number | Not accepted |

Authentication

X-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
transport_modeenumRequired

Air (weight only) | Ocean FCL (20ft/40ft + quantity) | Ocean LCL (volume).

lane_codestringRequired
Lane identifier from List lanes. Required.
commodity_codestringRequired
Catalogue code from List commodities. Required.
directionenumOptional

Trade direction. Only import is supported; exports are rejected.

weightdoubleOptional

Weight in kg. Required for air; rejected otherwise.

volumedoubleOptional

Total volume in CBM. Required for ocean_lcl; rejected otherwise.

container_sizeenumOptional

Required for ocean_fcl. 20ft and 20' (likewise 40ft/40') are the same size.

quantityintegerOptional

Required container count for ocean_fcl. Not accepted for air or ocean_lcl.

Response

Created
idstring

Stable public quote identifier. Use as quote_id when creating a booking.

statusenum

Always pending on create.

laneobject

Origin/destination pair from lane_code.

commodityobject

Commodity from commodity_code. Does not change pricing.

transport_modeenum

Unified-flow mode.

totaldouble

NGN grand total (freight rate plus charges).

estimated_delivery_datedate
Estimated delivery date.
created_atdatetime
Quote creation timestamp.
rateobject

Freight rate for this quote. Use id as rate_id when creating a booking.

chargeslist of objects

Additional fees included in total. A charge id is not a bookable rate id.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error