Route Schema
Represents the shipping route for a trade shipment.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
origin_country | string | Yes | ISO 3166-1 alpha-2 country code |
destination_country | string | Yes | ISO 3166-1 alpha-2 country code |
transport_mode | string | Yes | sea, air, road, rail, or multimodal |
incoterms | string | Yes | Incoterms 2020 code |
port_of_loading | string | No | UN/LOCODE (e.g., USLAX) |
port_of_discharge | string | No | UN/LOCODE (e.g., DEHAM) |
vessel_name | string | No | Ship/aircraft name |
voyage_number | string | No | Voyage or flight number |
etd | string | No | Estimated time of departure (YYYY-MM-DD) |
eta | string | No | Estimated time of arrival (YYYY-MM-DD) |
Incoterms 2020
| Code | Name | Transport |
|---|---|---|
| EXW | Ex Works | Any |
| FCA | Free Carrier | Any |
| CPT | Carriage Paid To | Any |
| CIP | Carriage and Insurance Paid To | Any |
| DAP | Delivered at Place | Any |
| DPU | Delivered at Place Unloaded | Any |
| DDP | Delivered Duty Paid | Any |
| FAS | Free Alongside Ship | Sea only |
| FOB | Free on Board | Sea only |
| CFR | Cost and Freight | Sea only |
| CIF | Cost, Insurance and Freight | Sea only |
Validation Rules
- FAS, FOB, CFR, CIF are only valid for sea/inland waterway transport
- Port codes are validated against the UN/LOCODE database
- Origin and destination countries must be different
Example
{
"origin_country": "US",
"destination_country": "DE",
"transport_mode": "sea",
"incoterms": "CIF",
"port_of_loading": "USLAX",
"port_of_discharge": "DEHAM",
"vessel_name": "MSC Ravenna",
"etd": "2026-04-15",
"eta": "2026-05-02"
}