Glossary

Freight carries a lot of vocabulary, and an API that returns it without explanation is an API you have to already know the trade to read. This page is the legend: every code, abbreviation and status a response can contain, and what it means.

The reference is generated from the API's own definitions and is the authority on which fields exist. This page is the authority on what their values mean.

How to read a value

Enum values arrive as strings, in capitals, prefixed with the thing they describe: STATUS_ACTIVE, TRANSPORT_MODE_SEA, INCOTERM_FOB. The prefix is part of the value, so compare against the whole string.

Two rules save you a bug each:

*_UNSPECIFIED means "not reported", not "none" and not "zero". Treat it as unknown and fall back to whatever your own default is.
Any enum can gain a member. A new document type or tracking milestone is an ordinary, non-breaking change. Handle the value you do not recognize rather than assuming your switch is exhaustive. See versioning.

Nothing here is a code you have to send us. The API is read-only, so every value on this page is something you will receive.

Codes and formats

Thing	Format	Example
Seaport (`un_locode`)	UN/LOCODE: two-letter country, three-letter place	`SGSIN` is Singapore, `NLRTM` is Rotterdam
Airport (`iata`)	IATA three-letter airport code	`SIN`, `AMS`
Container number	ISO 6346: four letters, seven digits. The last digit is a check digit	`MSKU1234567`
Vessel voyage	The carrier's own voyage number. No standard format	`001W`
Flight number	Airline code plus the flight's number	`KL0887`
Shipment and inquiry reference	Cargoplot reference, four characters, a hyphen, four more	`C2AE-XEE1`
Invoice reference	`F`, a sequence number, a hyphen, the shipment reference	`F2401-C2AE-XEE1`
Calendar date	ISO 8601 date, no time and no zone	`"2026-09-05"`
Instant	RFC 3339, always UTC	`"2026-09-05T10:00:00Z"`
Money	An amount in the currency's minor units, with an ISO 4217 code	`{"units": 125050, "currency": "EUR"}` is €1,250.50

Dates and instants are different on purpose. etd, eta, discharge_date, due_date and issue_date are calendar dates: the day something is planned for, with no time attached. Event timestamps are instants, because a milestone happened at a moment. A value that is not known is absent from the response rather than present and empty.

Carrier milestone codes

You will meet four-letter milestone codes in carrier portals, terminal screens and EDI messages. This API never returns them. It translates them into readable names first. They are here so you can line the two up when you are reading our response beside someone else's screen.

Sea:

Code	What the API returns
`EMSH`	`SEA_TRACKING_EVENT_TYPE_EMPTY_TO_SHIPPER`
`GTIN`	`SEA_TRACKING_EVENT_TYPE_GATE_IN`
`LOAD`	`SEA_TRACKING_EVENT_TYPE_LOADED`
`DEPA`	`SEA_TRACKING_EVENT_TYPE_DEPARTED`
`ARRV`	`SEA_TRACKING_EVENT_TYPE_ARRIVED`
`DISC`	`SEA_TRACKING_EVENT_TYPE_DISCHARGED`
`GTOT`	`SEA_TRACKING_EVENT_TYPE_GATE_OUT`
`EMRT`	`SEA_TRACKING_EVENT_TYPE_EMPTY_RETURNED`

Air:

Code	What the API returns
`RCS`	`AIR_TRACKING_EVENT_TYPE_RECEIVED_FROM_SHIPPER`
`MAN`	`AIR_TRACKING_EVENT_TYPE_MANIFESTED`
`DEP`	`AIR_TRACKING_EVENT_TYPE_DEPARTED`
`ARR`	`AIR_TRACKING_EVENT_TYPE_ARRIVED`
`RCF`	`AIR_TRACKING_EVENT_TYPE_RECEIVED_FROM_FLIGHT`
`DLV`	`AIR_TRACKING_EVENT_TYPE_DELIVERED`

GTIN is the one worth calling out: in freight it is Gate In, the moment a loaded container enters the port terminal. It is unrelated to the GTIN barcode number used in retail.

Tracking milestones and statuses

Sea events

In the order a container passes through them.

`SEA_TRACKING_EVENT_TYPE_*`	Meaning
`EMPTY_TO_SHIPPER`	The empty container was released to the shipper for loading
`GATE_IN`	The loaded container entered the port terminal
`LOADED`	The container was loaded onto the vessel
`DEPARTED`	The vessel sailed from the port
`ARRIVED`	The vessel arrived at the port
`DISCHARGED`	The container was lifted off the vessel
`GATE_OUT`	The container left the port terminal for delivery
`EMPTY_RETURNED`	The emptied container was handed back to the carrier
`UNSPECIFIED`	No milestone reported

Container status

A container's status follows its latest actual event, so an expected event does not move it forward.

`CONTAINER_TRACKING_STATUS_*`	Meaning
`EMPTY_TO_SHIPPER`	Released empty to the shipper, not yet back at the port
`GATE_IN`	At the port of loading, waiting for its vessel
`LOADED`	On board at the port of loading, not yet sailed
`SAILING`	At sea
`ARRIVED`	The vessel has arrived; the container is not yet discharged
`DISCHARGED`	Lifted off the vessel, still inside the terminal
`GATE_OUT`	Out of the terminal, on its way to the delivery address
`EMPTY_RETURNED`	Emptied and handed back to the carrier. The journey is over
`UNSPECIFIED`	Nothing reported yet

Air events

In the order a consignment passes through them.

`AIR_TRACKING_EVENT_TYPE_*`	Meaning
`RECEIVED_FROM_SHIPPER`	Cargo accepted from the shipper or their agent
`MANIFESTED`	Booked onto a specific flight
`DEPARTED`	Departed an airport
`ARRIVED`	Arrived at an airport
`RECEIVED_FROM_FLIGHT`	Taken off the aircraft at destination
`DELIVERED`	Delivered to the consignee
`UNSPECIFIED`	No milestone reported

Departure and arrival appear in both the sea and the air set. The two are separate vocabularies, so a switch over one is unaffected as the other grows.

Air status

air.status describes the consignment as a whole, and unlike a container's status it is stated rather than derived from the events.

`AIR_TRACKING_STATUS_*`	Meaning
`AWAITING_AIRLINE_DATA`	No airline movement data yet
`BOOKED`	Reserved, not yet dispatched
`IN_TRANSIT`	On its way to the destination
`LANDED`	Arrived at the destination airport
`DELIVERED`	Delivered to the consignee
`UNAVAILABLE`	No tracking information available
`UNSPECIFIED`	Nothing to report yet

Event state

Every milestone, in either mode, carries one of these.

`TRACKING_EVENT_STATE_*`	Meaning
`EXPECTED`	Planned or estimated. It has not happened yet
`ACTUAL`	Observed. It happened at the timestamp given
`UNSPECIFIED`	Neither. Treat it as unknown

See shipment tracking for how these fit together in a response.

Cargo and transport

Cargo type

Also the FCL/LCL discriminator, which decides the shape of the cargo fields on a shipment or inquiry.

`CARGO_TYPE_*`	Meaning
`CONTAINERS`	Full container load (FCL). The cargo fills containers of its own
`PALLETS`	Less than container load (LCL), on pallets
`PACKAGES`	Less than container load (LCL), as loose packages
`UNSPECIFIED`	Not reported

FCL is a container booked for one shipper's cargo. LCL is cargo that shares a container with other shippers' goods, priced by volume and weight.

Transport mode

`TRANSPORT_MODE_*`	Meaning
`SEA`	Deep-sea container freight
`AIR`	Air freight
`ROAD`	Truck
`RAIL`	Rail freight
`BARGE`	Inland waterway
`EXPRESS`	Courier or integrator service
`UNSPECIFIED`	Not reported

A shipment has exactly one mode. An inquiry may ask across several. Tracking is available for sea and air.

Container type

Sizes are the container's nominal length in feet. A high cube is about a foot taller than a standard box, which buys roughly 13% more volume for the same floor space.

`CONTAINER_TYPE_*`	Meaning
`20_STANDARD_DRY`	20 ft general-purpose box
`40_STANDARD_DRY`	40 ft general-purpose box
`40_HIGH_CUBE`	40 ft high cube, often written 40HC
`45_HIGH_CUBE`	45 ft high cube
`20_REEFER`	20 ft refrigerated, temperature-controlled
`40_REEFER`	40 ft refrigerated, temperature-controlled
`20_OPEN_TOP`	20 ft with a removable roof, loaded from above
`40_OPEN_TOP`	40 ft with a removable roof
`40_OPEN_TOP_HIGH_CUBE`	40 ft high cube with a removable roof
`20_FLAT_RACK`	20 ft with no side walls, for out-of-gauge cargo
`40_FLAT_RACK`	40 ft with no side walls
`UNSPECIFIED`	Not reported

TEU, the twenty-foot equivalent unit, is the industry's volume unit: a 20 ft box is 1 TEU, a 40 ft box is 2. You will see it in carrier and terminal material; the API does not return it.

Special contents

Goods that need handling, paperwork or a carrier approval an ordinary load does not.

`SPECIAL_CONTENTS_*`	Meaning
`BATTERIES`	Lithium or other cells, usually dangerous goods
`LIQUIDS`	Liquid cargo
`GASES`	Compressed or liquefied gas
`TEXTILES`	Textiles, which carry their own customs scrutiny
`UNSPECIFIED`	Nothing special declared

Incoterms

An Incoterm is the three-letter rule, published by the ICC, that says how far the seller carries the cost and the risk, and where the buyer takes over. The API returns the 2020 edition.

Roughly, the further down this table, the more the seller does.

`INCOTERM_*`	Name	Who carries what
`EXW`	Ex Works	Buyer collects at the seller's premises and carries cost and risk from there
`FCA`	Free Carrier	Seller hands the goods to the buyer's carrier at a named place; risk passes there
`FAS`	Free Alongside Ship	Seller delivers alongside the vessel at the loading port
`FOB`	Free On Board	Seller delivers on board the vessel at the loading port
`CFR`	Cost and Freight	Seller pays carriage to the destination port; risk passes once on board
`CIF`	Cost, Insurance and Freight	As `CFR`, and the seller insures the cargo
`CPT`	Carriage Paid To	Seller pays carriage to the named destination; risk passes at the first carrier
`CIP`	Carriage and Insurance Paid To	As `CPT`, and the seller insures the cargo
`DAP`	Delivered At Place	Seller delivers ready for unloading; import clearance and duties are the buyer's
`DPU`	Delivered at Place Unloaded	As `DAP`, and the seller unloads
`DDP`	Delivered Duty Paid	Seller delivers cleared for import, duties paid
`UNSPECIFIED`		Not reported

FAS, FOB, CFR and CIF are for sea and inland waterway only. The other seven work for any mode.

Paid carriage is not transferred risk. Under CFR, CIF, CPT and CIP the seller pays for carriage the buyer is already bearing the risk of.

Documents

A shipment carries a checklist of document slots. A slot says what is expected; the file uploaded into it is the document. GET /v1/shipment/{shipment}/document returns the whole checklist, filled or not.

Document types

`TYPE_*`	Name	What it is
`COMMERCIAL_INVOICE`	Commercial invoice	The seller's invoice for the goods. Customs values the shipment from it
`PACKING_LIST`	Packing list	What is in the shipment: pieces, weights, dimensions, volume
`MASTER_BILL_OF_LADING`	Master bill of lading	The carrier's sea transport contract and title document, issued to the forwarder. Often MBL or B/L
`HOUSE_BILL_OF_LADING`	House bill of lading	The forwarder's own bill of lading, issued to the shipper. Often HBL
`MASTER_AIRWAY_BILL`	Master airway bill	The airline's air waybill for the whole consignment. Often MAWB
`HOUSE_AIRWAY_BILL`	House airway bill	The forwarder's air waybill for one shipper's cargo. Often HAWB
`CMR`	CMR consignment note	The road transport consignment note, named after the UN convention. Signed on delivery
`DELIVERY_ORDER`	Delivery order	The instruction releasing cargo to the party collecting it
`INSURANCE_CERTIFICATE`	Insurance certificate	Proof the cargo is insured, and for how much
`MSDS`	MSDS	Material Safety Data Sheet: the hazards and handling rules for a chemical. Required for dangerous goods
`TEST_CERTIFICATE`	Test certificate	A product conformity or inspection certificate
`COC_EXCERPT`	Chamber of Commerce extract	Proof of company registration, from the trade register
`DIRECT_REPRESENTATION`	Direct representation	Authorizes the forwarder to make customs declarations in your name
`FISCAL_REPRESENTATION`	Fiscal representation	Authorizes a representative to handle import VAT on your behalf
`DIRECT_FISCAL_COMBO_REPRESENTATION`	Direct/fiscal representation	Both of the above on one form
`UTB`	Payment notification	Dutch customs' demand for the import duties and VAT owed on a shipment (uitnodiging tot betaling)
`TTW`	Carry-off note	Dutch customs' permission to move goods away from temporary storage (toestemming tot wegvoering)
`ATB`	ATB document	The Dutch customs reference for goods entered into temporary storage on arrival
`OTHER`	Other	Anything the checklist has no specific slot for
`UNSPECIFIED`		Not reported

The file's format is published on document.media_type as an IANA media type; the reference lists the values.

Slot status

`STATUS_*`	Meaning
`TO_BE_RECEIVED`	Outstanding. Nothing uploaded yet
`RECEIVED`	A file was uploaded and accepted
`REJECTED`	A file was uploaded and refused. `rejection_reason` says what to correct
`DELETED`	The slot was removed from the shipment's checklist
`UNSPECIFIED`	Not reported

A slot with no file has document: null, which is what distinguishes an outstanding slot from a filled one.

Money and VAT

Amounts are integers in the currency's minor units, cents for EUR and USD, with an ISO 4217 currency code beside them. Never parse them as decimals, and never assume two decimal places: the number of minor units per major unit varies by currency.

An invoice publishes both amount_ex_vat and amount_inc_vat, so you do not have to reconstruct either.

`CATEGORY_*`	VAT treatment
`STANDARD`	The standard rate for the country of supply
`REDUCED`	A reduced rate
`ZERO`	Zero-rated. VAT applies at 0%, unlike an exemption
`REVERSE_CHARGED`	No VAT is charged on the invoice. The recipient accounts for it themselves, which is the usual treatment for cross-border B2B supplies inside the EU
`UNSPECIFIED`	Not reported

Lifecycle statuses

Shipment

`STATUS_*`	Meaning
`ACTIVE`	Booked and under way, or being prepared to move
`COMPLETED`	Delivered and closed
`ON_HOLD`	Paused. Still live, but not progressing
`CANCELLED`	Called off. It will not move
`UNSPECIFIED`	No status reported

Inquiry

An inquiry is a request for a price. It becomes a shipment once a quote is accepted.

`STATUS_*`	Meaning
`RECEIVED`	Submitted, and waiting to be priced
`PRICES_REQUESTED`	Rates are being gathered for it
`QUOTES_PROPOSED`	One or more quotes are ready to review
`QUOTE_ACCEPTED`	A quote was accepted. The shipment follows from here
`CANCELLED`	Withdrawn. No quote will follow
`UNSPECIFIED`	No status reported

Invoice

`STATUS_*`	Meaning
`PUBLISHED`	Issued to you and payable
`PAID`	Settled in full
`DISPUTED`	Queried. The amount is under discussion
`IN_PAYMENT_PLAN`	Being settled in agreed instalments
`IN_COLLECTION`	Overdue, and handed to a collection agency
`FORFEITED`	Written off. No further settlement is expected
`UNSPECIFIED`	No status reported

Organization

`TYPE_*`	Meaning
`CLIENT`	A party that ships cargo
`FORWARDER`	A party that moves it
`SUPPLIER`	A party the cargo is collected from
`UNSPECIFIED`	Not reported

Parties on a shipment

Not codes, but the words the fields are named after.

Term	Who
Shipper	The party sending the goods, usually the seller or their factory
Consignee	The party receiving them
Supplier	Where the cargo is collected from
Forwarder	The party arranging the transport
Carrier	The party physically moving it: the shipping line, the airline, the haulier