> ## Documentation Index > Fetch the complete documentation index at: https://docs.terratwin.com/llms.txt > Use this file to discover all available pages before exploring further. # Calculate transport routes > Calculates the routes and distances of a transport chain without calculating emissions. Locations, transport modes, and fallback transport modes are handled exactly as for an emissions calculation, so the distances match those used there. The response contains the resolved locations, distances, and optionally route polylines. `WEIGHTED_MODES` transport operations are not supported. ## OpenAPI ````yaml /content/api-reference/openapi.yaml post /routes/calculate openapi: 3.1.0 info: title: Calculation API version: 1.0.0 description: > **Overview** The Calculation API provides methods for estimating greenhouse gas emissions from transporting cargo and retrieving stored calculation results. Use the calculate endpoint to create a new calculation, retrieve a calculation result by client provided ID, or browse stored calculation results using a filtered, paginated list method. Use the routes endpoint to calculate just the routes and distances of a transport chain, without emissions. **Base URL** https://api.terratwin.com/api/v1/transportation **Authentication** Every request to this API requires authentication with an API key. Add your key to the `x-api-key` header to identify and authorize your account. API keys can be obtained from your account dashboard at https://www.terratwin.com/account/settings/api-key-manager **Rate limits** Each account is limited to 5 requests per second. Requests exceeding this threshold may be temporarily rejected with a `429 Too Many Requests` response. You can retry after a short delay. **Cost** The API uses a credit-based billing model. Each transport operation processed counts as 1 credit, including connector segments such as first-mile and last-mile road operations. Weighted-mode operations may expand into multiple component operations; in these cases, each child operation is charged as a separate credit. Air transport operations are billed as a single credit, even when the model inserts multiple stopovers automatically. Road sub-operations occurring as part of roll-on/roll-off ferry or train movements are included at no extra cost. Emissions associated with logistics hubs don’t incur any credit charges. Routes requests are charged in the same way as emissions calculations. servers: - url: https://api.terratwin.com/api/v1/transportation security: [] paths: /routes/calculate: post: summary: Calculate transport routes description: > Calculates the routes and distances of a transport chain without calculating emissions. Locations, transport modes, and fallback transport modes are handled exactly as for an emissions calculation, so the distances match those used there. The response contains the resolved locations, distances, and optionally route polylines. `WEIGHTED_MODES` transport operations are not supported. operationId: calculateRoutes requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteRequest' example: id: '123456789' options: fallbackTransportModes: - ROAD - AIR cargo: category: GENERAL origin: type: PLACE street: 221B Baker Street postCode: NW1 6XE city: London country: GB destination: type: PLACE street: Rue Brederode 16 postCode: '1000' city: Brussel country: BE transportChain: - id: 123456789-01 type: WATER departureDateTime: '2025-12-25T00:00:00+00:00' arrivalDateTime: '2026-01-01T18:12:30Z' vehicle: CONTAINER navigationConstraints: - AVOID_KIEL_CANAL - AVOID_NORTHEAST_PASSAGE - AVOID_NORTHWEST_PASSAGE context: additionalInformation: customWaterLegValue - type: HUB location: type: HARBOR unLoCode: BEANR - id: 123456789-02 type: RAIL departureDateTime: '2026-01-02T10:00:00+01:00' arrivalDateTime: '2026-01-02T22:00:00+01:00' trainType: MANIFEST energyType: ELECTRICITY context: customProperty: customRailLegValue responses: '200': description: Routes successfully calculated content: application/json: schema: $ref: '#/components/schemas/RouteResponse' example: id: '123456789' origin: type: PLACE countryCode: GB latitude: 51.5237629 longitude: -0.1584743 region: England postcode: NW1 6XE city: London street: 221B Baker Street name: Sherlock Holmes Museum formatted: |- Sherlock Holmes Museum 221B Baker Street Marylebone London NW1 6XE United Kingdom destination: type: PLACE countryCode: BE latitude: 50.8405365 longitude: 4.3622675 region: Brussels-Capital postcode: '1000' city: Brussels street: Rue Brederode - Brederodestraat 16 formatted: |- Rue Brederode - Brederodestraat 16 1000 Brussels Belgium distanceKm: 428.17868397480544 transportChain: - type: WATER id: 123456789-01 start: type: PLACE countryCode: GB latitude: 51.5237629 longitude: -0.1584743 region: England postcode: NW1 6XE city: London street: 221B Baker Street name: Sherlock Holmes Museum formatted: |- Sherlock Holmes Museum 221B Baker Street Marylebone London NW1 6XE United Kingdom end: type: HARBOR countryCode: BE latitude: 51.27936713324465 longitude: 4.3567657470703125 region: Antwerp postcode: '2030' city: Antwerp name: Port of Antwerp code: BEANR formatted: |- Port of Antwerp 2030 Antwerp Belgium distanceKm: 361.25686120325236 context: additionalInformation: customWaterLegValue elements: - type: ROAD start: type: PLACE countryCode: GB latitude: 51.5237629 longitude: -0.1584743 region: England postcode: NW1 6XE city: London street: 221B Baker Street name: Sherlock Holmes Museum formatted: |- Sherlock Holmes Museum 221B Baker Street Marylebone London NW1 6XE United Kingdom end: type: HARBOR countryCode: GB latitude: 51.459502138725945 longitude: 0.3407907485961914 region: England postcode: RM18 7DP city: Tilbury name: Port of Tilbury code: GBTIL formatted: |- Port of Tilbury Tilbury RM18 7DP United Kingdom of Great Britain and Northern Ireland distanceKm: 47.708259845301605 - vehicle: CONTAINER capacityBand: POST_PANAMAX type: WATER start: type: HARBOR countryCode: GB latitude: 51.459502138725945 longitude: 0.3407907485961914 region: England postcode: RM18 7DP city: Tilbury name: Port of Tilbury code: GBTIL formatted: |- Port of Tilbury Tilbury RM18 7DP United Kingdom of Great Britain and Northern Ireland end: type: HARBOR countryCode: BE latitude: 51.27936713324465 longitude: 4.3567657470703125 region: Antwerp postcode: '2030' city: Antwerp name: Port of Antwerp code: BEANR formatted: |- Port of Antwerp 2030 Antwerp Belgium distanceKm: 313.54860135795076 - type: RAIL id: 123456789-02 start: type: PLACE countryCode: BE latitude: 51.279002 longitude: 4.356769 region: Antwerp postcode: '2030' city: Antwerp formatted: |- 2030 Antwerp Belgium end: type: PLACE countryCode: BE latitude: 50.8405365 longitude: 4.3622675 region: Brussels-Capital postcode: '1000' city: Brussels street: Rue Brederode - Brederodestraat 16 formatted: |- Rue Brederode - Brederodestraat 16 1000 Brussels Belgium distanceKm: 66.92182277155307 context: customProperty: customRailLegValue elements: - type: RAIL start: type: PLACE countryCode: BE latitude: 51.279002 longitude: 4.356769 region: Antwerp postcode: '2030' city: Antwerp formatted: |- 2030 Antwerp Belgium end: type: PLACE countryCode: BE latitude: 50.844459 longitude: 4.356229 region: Brussels-Capital postcode: '1000' city: Brussels formatted: |- Pentagon 1000 Brussels Brussels-Capital Belgium distanceKm: 65.84587562993619 - type: ROAD start: type: PLACE countryCode: BE latitude: 50.844459 longitude: 4.356229 region: Brussels-Capital postcode: '1000' city: Brussels formatted: |- Pentagon 1000 Brussels Brussels-Capital Belgium end: type: PLACE countryCode: BE latitude: 50.8405365 longitude: 4.3622675 region: Brussels-Capital postcode: '1000' city: Brussels street: Rue Brederode - Brederodestraat 16 formatted: |- Rue Brederode - Brederodestraat 16 1000 Brussels Belgium distanceKm: 1.075947141616878 creditCost: 4 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: title: Invalid property value status: 400 code: 5 details: - Property 'type' contains invalid value 'WEIGHTED_MODES' instance: /api/v1/transportation/routes/calculate recommendation: >- Alter your request to use one of these values: UNKNOWN,AIR,RAIL,ROAD,WATER,HUB '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: title: API key invalid status: 401 code: 41 details: - '''...'' is not a valid API key' instance: /api/v1/transportation/routes/calculate recommendation: >- Provide a valid API key. If you don’t have one, then apply to TerraTwin '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: title: Insufficient credits status: 403 code: 42 details: - Your account has no remaining credits instance: /api/v1/transportation/routes/calculate recommendation: Purchase additional credits from TerraTwin '422': description: Unprocessable entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: title: Not routable by rail status: 422 code: 33 details: - >- Operation 'transportChain[0]' could not be routed by rail between '50.68689,7.16285' and '-36.85209,174.76318' instance: /api/v1/transportation/routes/calculate recommendation: Review the mode of transport selected and the locations '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: title: Rate limit exceeded status: 429 code: 45 details: - Too many requests. The limit is 5 requests per second instance: /api/v1/transportation/routes/calculate recommendation: Reduce your request rate to ≤ 5 requests/second '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: RouteRequest: type: object properties: id: type: string description: > An identifier for the routes calculation, such as a shipment ID. It is returned in the response. Routes calculation results are not stored. options: $ref: '#/components/schemas/RouteOptions' cargo: $ref: '#/components/schemas/RouteCargo' origin: $ref: '#/components/schemas/RequestLocation' destination: $ref: '#/components/schemas/RequestLocation' transportChain: type: array description: > Represents the sequence of transport and hub operations that define a complete multimodal logistics chain. #### Structure #### The `transportChain` is an ordered array of elements describing how cargo moves between points. - Each transport element represents a specific operation and has a `type` value of `AIR`, `RAIL`, `ROAD`, `WATER`, or `UNKNOWN`. - Each hub element has a `type` of `HUB` and represents the connecting location between consecutive transport segments. #### Behavior #### - If this array is not provided or is empty, fallback transport modes are attempted instead. The system will cycle through the fallback modes in order, applying default parameters for each until one succeeds or all fail. - Hubs must appear between each pair of transport operations to define the connecting locations between them. - Hubs may also appear as the first and/or last elements in the array, acting as the origin or destination in place of the top-level `origin` and `destination` properties. - The road operations connecting the start and end locations to the selected airports, harbors, and rail yards are added automatically. - `WEIGHTED_MODES` transport operations are not supported. items: oneOf: - $ref: '#/components/schemas/RouteUnknownTransport' - $ref: '#/components/schemas/RouteAirTransport' - $ref: '#/components/schemas/RouteRailTransport' - $ref: '#/components/schemas/RouteRoadTransport' - $ref: '#/components/schemas/RouteWaterTransport' - $ref: '#/components/schemas/RouteHub' context: type: object description: >- Any information you want returned in the response. It is returned unchanged. RouteResponse: type: object required: - origin - destination - distanceKm - transportChain - creditCost properties: id: type: string description: The `id` provided in the request. origin: $ref: '#/components/schemas/ResponseLocation' destination: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: > The total distance of the transport chain in kilometers. Distances are the routed distances; no distance adjustment factors are applied. context: type: object description: The `context` provided in the request. transportChain: type: array description: The legs of the transport chain, in order. items: $ref: '#/components/schemas/RouteLegResult' creditCost: type: number format: double description: >- The number of credits charged for the request. Credits are charged in the same way as for an emissions calculation. ErrorResponse: type: object required: - title - status - code - details - instance - recommendation properties: title: type: string description: Short, human readable summary of the error. status: type: number format: integer description: >- HTTP status code associated with the error, indicating the type of failure. code: type: number description: > Application-specific numeric error code that identifies the exact error condition. Error codes 10000 and above represent internal errors. | Code | Description | |------|----------------------------------------------------| | 1 | API key missing | | 2 | Invalid JSON | | 3 | API property missing | | 4 | Invalid weight | | 5 | Invalid property value | | 6 | Invalid transport chain element JSON | | 7 | Insufficient location information | | 8 | Unknown airport IATA code | | 9 | Missing coordinate | | 10 | Invalid coordinate | | 11 | Coordinates outside country borders | | 12 | Invalid country code | | 13 | Unknown UN/LOCODE | | 14 | Invalid UN/LOCODE | | 15 | Missing country code with address | | 16 | Unresolvable location | | 17 | Missing location | | 18 | Missing hub | | 19 | Invalid volume | | 20 | Invalid container count | | 21 | Incompatible capacity unit for water vessel | | 22 | Invalid load factor percentage | | 23 | Invalid empty running percentage | | 24 | Invalid energy consumption | | 25 | Invalid date/time | | 26 | Invalid container type code | | 27 | Unknown aircraft identifier | | 28 | Location not routable to airport | | 29 | Location not routable to rail yard | | 30 | Location not routable to harbor | | 31 | No rail system in country | | 32 | Not routable by air | | 33 | Not routable by rail | | 34 | Not routable by road | | 35 | Unknown rail yard identifier | | 36 | Fallback transport modes routing failure | | 37 | Invalid percentage | | 38 | Invalid percentage summation | | 39 | Energy type incompatible with consumption unit | | 40 | Energy type not supported for road transport | | 41 | Invalid API key | | 42 | Insufficient credits | | 43 | Account not found | | 44 | Service unavailable | | 45 | Rate limit exceeded | | 46 | Payload too large | | 47 | Invalid HTTP request | | 48 | Missing request id | | 49 | Invalid cursor | | 50 | Emissions result not found | enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 details: type: array description: > One or more strings providing additional details about the error. For internal errors (error codes 10000 and above), this includes a tracking code that users can provide to TerraTwin tech support for diagnosis and resolution. items: type: string instance: type: string description: Path of the API endpoint where the error occurred. recommendation: type: string description: Guidance on how to resolve the error. RouteOptions: title: Routes options type: object description: > Used to customize routes calculations and to control which details are included in the response. properties: fallbackTransportModes: $ref: '#/components/schemas/FallbackTransportModes' includeRoutePolylines: $ref: '#/components/schemas/IncludeRoutePolylines' RouteCargo: title: Cargo type: object description: > Optionally describes the transported goods. Only the cargo category is used: it determines the default vessel type for `WATER` transport operations, and so which harbors are selected. When not provided, the `GENERAL` category is used. properties: category: $ref: '#/components/schemas/CargoCategory' RequestLocation: anyOf: - $ref: '#/components/schemas/LocationCoordinates' - $ref: '#/components/schemas/LocationIata' - $ref: '#/components/schemas/LocationUnlocode' - $ref: '#/components/schemas/LocationUnstructured' - $ref: '#/components/schemas/LocationStructured' - $ref: '#/components/schemas/LocationStreetCity' - $ref: '#/components/schemas/LocationStreetPostcode' - $ref: '#/components/schemas/LocationPostcode' - $ref: '#/components/schemas/LocationCity' RouteUnknownTransport: title: Unknown transport type: object required: - type properties: type: type: string enum: - UNKNOWN description: > Indicates that no transport mode was provided. The fallback transport modes are attempted in order, using defaulted parameters for each mode, and the first mode that can be routed is used. The modes are taken from `options`.`fallbackTransportModes`, or default to [`ROAD`, `WATER`, `AIR`]. id: type: string description: > An optional identifier for the transport chain element. When provided, the same identifier is returned on the corresponding transport chain result element in the response. context: type: object description: > Any information you want returned in the response. It is returned unchanged on the corresponding transport chain result element. RouteAirTransport: title: Air transport type: object required: - type properties: type: type: string enum: - AIR description: > Transport by aircraft. Departure and arrival airports are selected, and stopovers inserted, exactly as for an emissions calculation. The aircraft (`vehicle` and `aircraftType`) determines the runway requirements and range used for airport and stopover selection. When the start or end location is not an airport, a road transport operation is automatically added to connect it to the selected airport. If an air route cannot be generated, the modes in the request `options`.`fallbackTransportModes` (except `AIR`) are attempted in listed order. id: type: string description: > An optional identifier for the transport chain element. When provided, the same identifier is returned on the corresponding transport chain result element in the response. departureDateTime: $ref: '#/components/schemas/AirTransportDepartureDateTime' arrivalDateTime: $ref: '#/components/schemas/AirTransportArrivalDateTime' aircraftType: $ref: '#/components/schemas/AirTransportAircraftType' vehicle: $ref: '#/components/schemas/AirTransportVehicle' context: type: object description: > Any information you want returned in the response. It is returned unchanged on the corresponding transport chain result element. RouteRailTransport: title: Rail transport type: object required: - type properties: type: type: string enum: - RAIL description: > Transport by train. The nearest rail yards to the start and end locations are selected, exactly as for an emissions calculation. When the start or end location is not a rail yard, a road transport operation is automatically added to connect it to the selected rail yard. If a rail route cannot be generated, the modes in the request `options`.`fallbackTransportModes` (except `RAIL`) are attempted in listed order. id: type: string description: > An optional identifier for the transport chain element. When provided, the same identifier is returned on the corresponding transport chain result element in the response. departureDateTime: $ref: '#/components/schemas/RailTransportDepartureDateTime' arrivalDateTime: $ref: '#/components/schemas/RailTransportArrivalDateTime' vehicle: $ref: '#/components/schemas/RailTransportVehicle' trainType: $ref: '#/components/schemas/RailTransportTrainType' grossTrainWeight: $ref: '#/components/schemas/RailTransportGrossTrainWeight' energyType: $ref: '#/components/schemas/RailTransportEnergyType' context: type: object description: > Any information you want returned in the response. It is returned unchanged on the corresponding transport chain result element. RouteRoadTransport: title: Road transport type: object required: - type properties: type: type: string enum: - ROAD description: > Transport by road. Roll-on/roll-off ferry and train crossings are included where the route requires them. If a road route cannot be generated, the modes in the request `options`.`fallbackTransportModes` (except `ROAD`) are attempted in listed order. id: type: string description: > An optional identifier for the transport chain element. When provided, the same identifier is returned on the corresponding transport chain result element in the response. departureDateTime: $ref: '#/components/schemas/RoadTransportDepartureDateTime' arrivalDateTime: $ref: '#/components/schemas/RoadTransportArrivalDateTime' vehicle: $ref: '#/components/schemas/RoadTransportVehicle' structure: $ref: '#/components/schemas/RoadTransportStructure' grossWeightBand: $ref: '#/components/schemas/RoadTransportGrossWeightBand' grossWeight: $ref: '#/components/schemas/RoadTransportGrossWeight' emptyWeight: $ref: '#/components/schemas/RoadTransportEmptyWeight' maximumWeight: $ref: '#/components/schemas/RoadTransportMaximumWeight' yearOfManufacture: $ref: '#/components/schemas/RoadTransportYearOfManufacture' emissionsStandard: $ref: '#/components/schemas/RoadTransportEmissionsStandard' loadFactor: $ref: '#/components/schemas/RoadTransportLoadFactor' emptyRunning: $ref: '#/components/schemas/RoadTransportEmptyRunning' packaging: $ref: '#/components/schemas/RoadTransportPackaging' energyType: $ref: '#/components/schemas/RoadTransportEnergyType' loadDistribution: $ref: '#/components/schemas/RoadTransportLoadDistribution' energyConsumption: $ref: '#/components/schemas/RoadTransportEnergyConsumption' context: type: object description: > Any information you want returned in the response. It is returned unchanged on the corresponding transport chain result element. RouteWaterTransport: title: Water transport type: object required: - type properties: type: type: string enum: - WATER description: > Transport by ship. Harbors are selected, and the voyage routed, exactly as for an emissions calculation. The vessel (`vehicle`, `capacity`, `size`, or the default vessel for the `cargo`.`category`) determines which harbors can be used, and `navigationConstraints` determines which canals and passages can be used. When the start or end location is not a harbor, a road transport operation is automatically added to connect it to the selected harbor. If a sea route cannot be generated, the modes in the request `options`.`fallbackTransportModes` (except `WATER`) are attempted in listed order. id: type: string description: > An optional identifier for the transport chain element. When provided, the same identifier is returned on the corresponding transport chain result element in the response. departureDateTime: $ref: '#/components/schemas/WaterTransportDepartureDateTime' arrivalDateTime: $ref: '#/components/schemas/WaterTransportArrivalDateTime' vehicle: $ref: '#/components/schemas/WaterTransportVehicle' capacity: $ref: '#/components/schemas/WaterTransportCapacity' size: $ref: '#/components/schemas/WaterTransportSize' containerTypeCode: $ref: '#/components/schemas/WaterTransportContainerTypeCode' energyType: $ref: '#/components/schemas/WaterTransportEnergyType' navigationConstraints: $ref: '#/components/schemas/WaterTransportNavigationConstraints' context: type: object description: > Any information you want returned in the response. It is returned unchanged on the corresponding transport chain result element. RouteHub: type: object title: Hub required: - type - location properties: type: type: string enum: - HUB description: > A location connecting transport legs, or the starting or ending location of the transport chain. Hubs act as connection points between transport operations (within or across modes), splitting the transport chain into legs. location: $ref: '#/components/schemas/RequestLocation' ResponseLocation: title: Location type: object required: - type - countryCode - latitude - longitude properties: type: type: string description: > Defines the category of the location, distinguishing between transport facilities such as airports, harbors, and rail yards, and general places such as buildings, streets, postcodes, or cities. `PLACE` Place A general geographic point such as a building, street, postcode area, or city, rather than to a transport facility. `AIRPORT` Airport An airport. `RAIL_YARD` Rail yard A rail yard. `HARBOR` Harbor A maritime port. enum: - PLACE - AIRPORT - RAIL_YARD - HARBOR latitude: type: number format: double description: Latitude in decimal degrees (WGS 84 - EPSG:4326), range -90 to 90. longitude: type: number format: double description: >- Longitude in decimal degrees (WGS 84 - EPSG:4326), range -180 to 180. countryCode: type: string description: ISO 3166-1 alpha-2 country code. minLength: 2 maxLength: 2 region: type: string description: | Administrative area (state/province/county/territory), e.g., - `Bretagne` - `Ontario` - `Bavaria` postcode: type: string description: > Postal or ZIP code identifying the area of the location. Format varies by country, e.g., - `90210` *(Beverly Hills)* - `WC2N 5DU` *(Trafalgar Square)* city: type: string description: | City, town, or municipality where the location is situated, e.g., - `Berlin` - `Paris` - `New York` street: type: string description: > Street name and number, when available, formatted in the order commonly used in the location’s country. E.g., - `1600 Pennsylvania Ave NW` - `Platz der Republik 1` name: type: string description: | The name of a recognized landmark for the location, e.g., - `Château de Versailles` - `The White House` formatted: type: string description: > Full multi-line address, including line breaks, formatted according to the addressing rules of the location’s country. E.g., - `White House` `1600 Pennsylvania Avenue Northwest` `Ward 2` `Washington, District of Columbia 20500` `United States` - `Sherlock Holmes Museum` `221B Baker Street` `Marylebone` `London` `NW1 6XE` `United Kingdom` code: type: string description: > Airport or harbor code, returned only when the location type is `AIRPORT` or `HARBOR`. For airports, this is a 3 character IATA considerations. For harbors, this is the 5 character UN/LOCODE. minLength: 3 maxLength: 5 RouteLegResult: type: object required: - type - start - end - distanceKm - elements properties: type: type: string description: >- The transport mode of the leg. For an `UNKNOWN` operation, this is the fallback mode that was used. enum: - AIR - RAIL - ROAD - WATER id: type: string description: >- The `id` provided on the corresponding transport operation in the request. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: >- The total distance of the leg in kilometers, including its connecting road operations. context: type: object description: >- The `context` provided on the corresponding transport operation in the request. elements: type: array description: > The operations making up the leg, in order. For example, a `WATER` leg starting from an address consists of a `ROAD` operation to the selected harbor followed by the `WATER` voyage. A flight with stopovers consists of consecutive `AIR` operations. items: oneOf: - $ref: '#/components/schemas/RouteAirOperationResult' - $ref: '#/components/schemas/RouteRailOperationResult' - $ref: '#/components/schemas/RouteRoadOperationResult' - $ref: '#/components/schemas/RouteWaterOperationResult' FallbackTransportModes: type: array description: > Fallback transport modes are evaluated sequentially. Each mode in the array is attempted one after another until one succeeds or all have failed. Every attempt uses a fully defaulted configuration for the mode being tried. If all modes fail, the error returned is the one produced by the final mode attempted. This fallback mechanism is applied in the following situations: - When a transport operation is configured with an `UNKNOWN` transport type. - When a transport operation fails. Each mode in the array is attempted in order (excluding the mode that failed). items: type: string description: | The fallback mode of transport. `AIR` Air Attempt to transport the cargo using aircraft. `RAIL` Rail Attempt to transport the cargo using rail infrastructure. `ROAD` Road Attempt to transport the cargo using road infrastructure. `WATER` Water Attempt to transport the cargo using maritime transport. enum: - AIR - RAIL - ROAD - WATER IncludeRoutePolylines: type: boolean default: false description: > Whether to include route polylines in the results of `ROAD`, `RAIL` and `WATER` transport operations. When enabled, polylines are encoded using the Google Encoded Polyline Algorithm Format. CargoCategory: type: string description: > Aids in selecting default vehicle classes and sizes when specific transport details are not provided. It is also used to determine default climate control requirements and cargo density properties. `AUTOMOBILES` Automobiles Finished vehicles transported by specialized carriers. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `AVERAGE_MIXED` by default. `BUILDING_MATERIALS` Building materials Construction materials like cement, sand and gravel, bricks, stone, and lumber. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. `CEREALS` Cereals Grain crops and similar agricultural bulk goods. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. `COAL_AND_STEEL` Coal and steel Extra heavy bulk where empty returns are almost always required. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. `GENERAL` General Default category for unspecified or miscellaneous cargo types. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `AVERAGE_MIXED` by default. `LIQUEFIED_GAS` Liquefied gas Gases liquefied for transport, such as LNG and LPG, carried in insulated or pressurized vessels. Climate control is `AT_AMBIENT` by default as road tankers do not typically use active refrigeration systems. The cargo density is characterized as `HEAVY` by default. `LIQUID_CHEMICALS` Liquid chemicals Materials in liquid form, typically transported in bulk using specialized tanks. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. `MANUFACTURED_PRODUCTS` Manufactured products Consumer or industrial goods produced by manufacturing, as opposed to raw materials. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `AVERAGE_MIXED` by default. `OIL` Oil Crude oil or refined petroleum products typically transported in bulk. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. `REFRIGERATED_BULK` Refrigerated bulk Perishable goods that must be kept cold during transit. Climate control is `REQUIRED` by default. The cargo density is characterized as `AVERAGE_MIXED` by default. `SOLID_CHEMICALS` Solid chemicals Powders, granules, pellets, or other solid packaged chemicals typically handled and shipped as dry bulk materials. Climate control is `AT_AMBIENT` by default. The cargo density is characterized as `HEAVY` by default. default: GENERAL enum: - AUTOMOBILES - BUILDING_MATERIALS - CEREALS - COAL_AND_STEEL - GENERAL - LIQUEFIED_GAS - LIQUID_CHEMICALS - MANUFACTURED_PRODUCTS - OIL - REFRIGERATED_BULK - SOLID_CHEMICALS LocationCoordinates: title: Coordinates allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - latitude - longitude LocationIata: title: IATA code allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - iataCode LocationUnlocode: title: UN/LOCODE allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - unLoCode LocationUnstructured: title: Unstructured address allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - address - country LocationStructured: title: Structured address allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - street - postcode - city - country LocationStreetCity: title: Street & city allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - street - city - country LocationStreetPostcode: title: Street & postcode allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - street - postcode - country LocationPostcode: title: Postcode allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - postcode - country LocationCity: title: City allOf: - $ref: '#/components/schemas/LocationBase' - type: object required: - city - country AirTransportDepartureDateTime: type: string format: date-time description: > When the aircraft departed its origin airport. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the origin airport's timezone. Example (origin JFK): `2025-03-28T09:00` → `2025-03-28T09:00-04:00` - UTC times are automatically converted to offset times based on the origin airport's timezone. Example (origin JFK): `2025-03-28T13:00Z` → `2025-03-28T09:00-04:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` AirTransportArrivalDateTime: type: string format: date-time description: > When the aircraft arrived at its destination airport. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the destination airport's timezone. Example (destination JFK): `2025-03-28T09:00` → `2025-03-28T09:00-04:00` - UTC times are automatically converted to offset times based on the destination airport's timezone. Example (destination JFK): `2025-03-28T13:00Z` → `2025-03-28T09:00-04:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` AirTransportAircraftType: type: string description: > Identifies the category of aircraft operation used for emissions estimation. Distinct ICAO computational methodologies are applied for passenger and freighter aircraft, yielding materially different emissions results. Used in conjunction with the `vehicle` property when the aircraft is referenced by ICAO or IATA code as these often do not distinguish between passenger and freighter configurations. `PASSENGER` Passenger An aircraft that carries freight in its belly hold alongside passengers. Calculations use the ICAO freighter algorithm, adjusted for belly-freight characteristics. When no `vehicle` is specified, a representative belly-freight emissions factor is used. `FREIGHTER` Freighter An aircraft that is purpose-built to carry freight or converted from a passenger aircraft. Calculations use the ICAO freighter algorithm, and default to a generic freighter emissions factor when `vehicle` is not provided. enum: - PASSENGER - FREIGHTER AirTransportVehicle: type: string description: | Identifies the aircraft used for emissions and performance calculations. #### Accepted identifiers #### - **System identifier**: A unique model id from this system. - **ICAO code**: A 4-character (occasionally 3-character) alphanumeric aircraft type designator (Doc 8643) that identifies an aircraft type or closely related sub-types. - **IATA code**: A 3-character alphanumeric equipment code that identifies an aircraft type or group of variants. #### Disambiguation #### - When an ICAO or IATA code is supplied that maps to both passenger and freighter variants, `aircraftType` can be used to disambiguate. - If an ICAO or IATA code still maps to multiple aircraft models after applying `aircraftType`, the system selects the most commonly operated model based on global fleet counts. - If `aircraftType` is omitted and a given ICAO/IATA code corresponds to both passenger and freighter variants, emissions will be calculated for both variants. The final emissions result will be produced by combining the passenger and freighter outputs and weighting them according to the IATA Global International Available Cargo Tonne-Kilometers (ACTK) shares by cargo business type for: - the year of departure, or - the year of arrival if departure is not provided, or - the current year if neither date is available.
Airbus aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `AIRBUS_A220_100_BELLY_FREIGHT` | `BCS1` | `221` | | `AIRBUS_A220_300_BELLY_FREIGHT` | `BCS3` | `223` | | `AIRBUS_A300_600_BELLY_FREIGHT` | `A306` | `AB6` | | `AIRBUS_A300_600F_FREIGHTER` | `A306` | `ABY` | | `AIRBUS_A300_B2_BELLY_FREIGHT` | `A30B` | `AB4` | | `AIRBUS_A300_B4_BELLY_FREIGHT` | `A30B` | `AB4` | | `AIRBUS_A300B4_200F_FREIGHTER` | `A30B` | `ABX` | | `AIRBUS_A310_200_BELLY_FREIGHT` | `A310` | `312` | | `AIRBUS_A310_200F_FREIGHTER` | `A310` | `31X` | | `AIRBUS_A310_300_BELLY_FREIGHT` | `A310` | `313` | | `AIRBUS_A310_300F_FREIGHTER` | `A310` | `31Y` | | `AIRBUS_A318_BELLY_FREIGHT` | `A318` | `318` | | `AIRBUS_A319_BELLY_FREIGHT` | `A319` | `319` | | `AIRBUS_A319_NEO_BELLY_FREIGHT` | `A19N` | `31N` | | `AIRBUS_A320_BELLY_FREIGHT` | `A320` | `320` | | `AIRBUS_A320_NEO_BELLY_FREIGHT` | `A20N` | `32N` | | `AIRBUS_A320_P2F_FREIGHTER` | `A320` | `32A` | | `AIRBUS_A320_SHARKLETS_BELLY_FREIGHT` | `A320` | `32A` | | `AIRBUS_A321_BELLY_FREIGHT` | `A321` | `321` | | `AIRBUS_A321_NEO_BELLY_FREIGHT` | `A21N` | `32Q` | | `AIRBUS_A321_P2F_FREIGHTER` | `A321` | `32B` | | `AIRBUS_A321_SHARKLETS_BELLY_FREIGHT` | `A321` | `32B` | | `AIRBUS_A321F_FREIGHTER` | `A321` | `32B` | | `AIRBUS_A330_200_BELLY_FREIGHT` | `A332` | `332` | | `AIRBUS_A330_200F_FREIGHTER` | `A332` | `33X` | | `AIRBUS_A330_300_BELLY_FREIGHT` | `A333` | `333` | | `AIRBUS_A330_300_P2F_FREIGHTER` | `A333` | `33Y` | | `AIRBUS_A330_800_NEO_BELLY_FREIGHT` | `A338` | `338` | | `AIRBUS_A330_900_NEO_BELLY_FREIGHT` | `A339` | `339` | | `AIRBUS_A330_P2F_FREIGHTER` | `A332` | `33X` | | `AIRBUS_A340_200_BELLY_FREIGHT` | `A342` | `342` | | `AIRBUS_A340_300_BELLY_FREIGHT` | `A343` | `343` | | `AIRBUS_A340_500_BELLY_FREIGHT` | `A345` | `345` | | `AIRBUS_A340_600_BELLY_FREIGHT` | `A346` | `346` | | `AIRBUS_A350_900_BELLY_FREIGHT` | `A359` | `359` | | `AIRBUS_A350_1000_BELLY_FREIGHT` | `A35K` | `351` | | `AIRBUS_A380_BELLY_FREIGHT` | `A388` | `380` |
Antonov aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `ANTONOV_AN_24_BELLY_FREIGHT` | `AN24` | `AN4` | | `ANTONOV_AN_24_FREIGHTER` | `AN24` | `AN4` | | `ANTONOV_AN_26_FREIGHTER` | `AN26` | `A26` | | `ANTONOV_AN_28_FREIGHTER` | `AN28` | `A28` | | `ANTONOV_AN_32_FREIGHTER` | `AN32` | `A32` | | `ANTONOV_AN_72_FREIGHTER` | `AN72` | `AN7` | | `ANTONOV_AN_74_FREIGHTER` | `AN72` | `AN7` | | `ANTONOV_AN_124_FREIGHTER` | `A124` | `A4F` | | `ANTONOV_AN_140_FREIGHTER` | `A140` | `A40` | | `ANTONOV_AN_148_BELLY_FREIGHT` | `A148` | `A81` |
ATR aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `ATR_42_300_BELLY_FREIGHT` | `AT43` | `AT4` | | `ATR_42_320_BELLY_FREIGHT` | `AT43` | `AT4` | | `ATR_42_400_BELLY_FREIGHT` | `AT44` | `ATD` | | `ATR_42_500_BELLY_FREIGHT` | `AT45` | `AT5` | | `ATR_42_600_BELLY_FREIGHT` | `AT46` | `ATR` | | `ATR_42_FREIGHTER` | `AT43` | `AT4` | | `ATR_72_200_BELLY_FREIGHT` | `AT72` | `AT7` | | `ATR_72_210_BELLY_FREIGHT` | `AT73` | `ATR` | | `ATR_72_500_BELLY_FREIGHT` | `AT75` | `ATR` | | `ATR_72_600_BELLY_FREIGHT` | `AT76` | `ATR` | | `ATR_72_FREIGHTER` | `AT72` | `ATF` |
Avro aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `AVRO_RJ70_BELLY_FREIGHT` | `RJ70` | `AR7` | | `AVRO_RJ85_BELLY_FREIGHT` | `RJ85` | `AR8` | | `AVRO_RJ100_BELLY_FREIGHT` | `RJ1H` | `AR1` |
Boeing aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `BOEING_717_BELLY_FREIGHT` | `B712` | `717` | | `BOEING_727_200F_FREIGHTER` | `B722` | `72Y` | | `BOEING_737_100_BELLY_FREIGHT` | `B731` | `731` | | `BOEING_737_200_BELLY_FREIGHT` | `B732` | `732` | | `BOEING_737_200F_FREIGHTER` | `B732` | `73X` | | `BOEING_737_300_BELLY_FREIGHT` | `B733` | `733` | | `BOEING_737_300F_FREIGHTER` | `B733` | `73Y` | | `BOEING_737_300SP_BELLY_FREIGHT` | `B733` | `73C` | | `BOEING_737_400_BELLY_FREIGHT` | `B734` | `734` | | `BOEING_737_400F_FREIGHTER` | `B734` | `73P` | | `BOEING_737_500_BELLY_FREIGHT` | `B735` | `735` | | `BOEING_737_500SP_BELLY_FREIGHT` | `B735` | `73E` | | `BOEING_737_600_BELLY_FREIGHT` | `B736` | `736` | | `BOEING_737_700_BELLY_FREIGHT` | `B737` | `73G` | | `BOEING_737_700_WINGLETS_BELLY_FREIGHT` | `B737` | `73W` | | `BOEING_737_700CF_FREIGHTER` | `B737` | `73R` | | `BOEING_737_800_BELLY_FREIGHT` | `B738` | `738` | | `BOEING_737_800_WINGLETS_BELLY_FREIGHT` | `B738` | `73H` | | `BOEING_737_800BCF_FREIGHTER` | `B738` | `7F8` | | `BOEING_737_800SF_FREIGHTER` | `B738` | `73K` | | `BOEING_737_900_BELLY_FREIGHT` | `B739` | `739` | | `BOEING_737_900_WINGLETS_BELLY_FREIGHT` | `B739` | `73J` | | `BOEING_737_MAX_8_BELLY_FREIGHT` | `B38M` | `7M8` | | `BOEING_737_MAX_9_BELLY_FREIGHT` | `B39M` | `7M9` | | `BOEING_747_100SF_FREIGHTER` | `B741` | `74T` | | `BOEING_747_200_BELLY_FREIGHT` | `B742` | `742` | | `BOEING_747_200F_FREIGHTER` | `B742` | `74X` | | `BOEING_747_200SF_FREIGHTER` | `B742` | `74X` | | `BOEING_747_300_BELLY_FREIGHT` | `B743` | `743` | | `BOEING_747_300SF_FREIGHTER` | `B743` | `74U` | | `BOEING_747_400_BELLY_FREIGHT` | `B744` | `744` | | `BOEING_747_400BCF_FREIGHTER` | `B744` | `74Y` | | `BOEING_747_400BDSF_FREIGHTER` | `B744` | `74Y` | | `BOEING_747_400ERF_FREIGHTER` | `B744` | `74Y` | | `BOEING_747_400F_FREIGHTER` | `B744` | `74Y` | | `BOEING_747_8F_FREIGHTER` | `B748` | `74N` | | `BOEING_747_8I_BELLY_FREIGHT` | `B748` | `74H` | | `BOEING_757_200_BELLY_FREIGHT` | `B752` | `752` | | `BOEING_757_200_WINGLETS_BELLY_FREIGHT` | `B752` | `75W` | | `BOEING_757_200F_FREIGHTER` | `B752` | `75F` | | `BOEING_757_200PCF_FREIGHTER` | `B752` | `75F` | | `BOEING_757_200PF_FREIGHTER` | `B752` | `75F` | | `BOEING_757_200SF_FREIGHTER` | `B752` | `75F` | | `BOEING_757_300_BELLY_FREIGHT` | `B753` | `753` | | `BOEING_757_300_WINGLETS_BELLY_FREIGHT` | `B753` | `75T` | | `BOEING_767_200_BELLY_FREIGHT` | `B762` | `762` | | `BOEING_767_200_FREIGHTER` | `B762` | `76X` | | `BOEING_767_200ER_BELLY_FREIGHT` | `B762` | `762` | | `BOEING_767_300_BELLY_FREIGHT` | `B763` | `763` | | `BOEING_767_300_FREIGHTER` | `B763` | `76Y` | | `BOEING_767_300BCF_FREIGHTER` | `B763` | `76Y` | | `BOEING_767_300BDSF_FREIGHTER` | `B763` | `76Y` | | `BOEING_767_300ER_BELLY_FREIGHT` | `B763` | `76T` | | `BOEING_767_300ER_WINGLETS_BELLY_FREIGHT` | `B763` | `76W` | | `BOEING_767_400ER_BELLY_FREIGHT` | `B764` | `764` | | `BOEING_777_200_BELLY_FREIGHT` | `B772` | `772` | | `BOEING_777_200ER_BELLY_FREIGHT` | `B772` | `772` | | `BOEING_777_200F_FREIGHTER` | `B77L` | `77X` | | `BOEING_777_200LR_BELLY_FREIGHT` | `B77L` | `77L` | | `BOEING_777_300_BELLY_FREIGHT` | `B773` | `773` | | `BOEING_777_300ER_BELLY_FREIGHT` | `B77W` | `77W` | | `BOEING_777_300ERSF_FREIGHTER` | `B773` | `77W` | | `BOEING_787_8_BELLY_FREIGHT` | `B788` | `788` | | `BOEING_787_9_BELLY_FREIGHT` | `B789` | `789` | | `BOEING_787_10_BELLY_FREIGHT` | `B78X` | `781` |
Bombardier aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `BOMBARDIER_CRJ100_ER_BELLY_FREIGHT` | `CRJ1` | `CR1` | | `BOMBARDIER_CRJ100_LR_BELLY_FREIGHT` | `CRJ1` | `CR1` | | `BOMBARDIER_CRJ200_ER_BELLY_FREIGHT` | `CRJ2` | `CR2` | | `BOMBARDIER_CRJ200_LR_BELLY_FREIGHT` | `CRJ2` | `CR2` | | `BOMBARDIER_CRJ200PF_ER_FREIGHTER` | `CRJ2` | `CRF` | | `BOMBARDIER_CRJ200PF_LR_FREIGHTER` | `CRJ2` | `CRF` | | `BOMBARDIER_CRJ200SF_ER_FREIGHTER` | `CRJ2` | `CRF` | | `BOMBARDIER_CRJ200SF_LR_FREIGHTER` | `CRJ2` | `CRF` | | `BOMBARDIER_CRJ550_BELLY_FREIGHT` | `CRJ7` | `CR7` | | `BOMBARDIER_CRJ700_BELLY_FREIGHT` | `CRJ7` | `CR7` | | `BOMBARDIER_CRJ705_BELLY_FREIGHT` | `CRJ9` | `CRA` | | `BOMBARDIER_CRJ900_BELLY_FREIGHT` | `CRJ9` | `CR9` | | `BOMBARDIER_CRJ1000_BELLY_FREIGHT` | `CRJX` | `CRK` |
British Aerospace aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `BRITISH_AEROSPACE_ATP_BELLY_FREIGHT` | `ATP` | `ATP` | | `BRITISH_AEROSPACE_BAE_146_100_BELLY_FREIGHT` | `B461` | `141` | | `BRITISH_AEROSPACE_BAE_146_100QC_FREIGHTER` | `B461` | `14X` | | `BRITISH_AEROSPACE_BAE_146_100QT_FREIGHTER` | `B461` | `14X` | | `BRITISH_AEROSPACE_BAE_146_200_BELLY_FREIGHT` | `B462` | `142` | | `BRITISH_AEROSPACE_BAE_146_200QC_FREIGHTER` | `B462` | `14Y` | | `BRITISH_AEROSPACE_BAE_146_200QT_FREIGHTER` | `B462` | `14Y` | | `BRITISH_AEROSPACE_BAE_146_300_BELLY_FREIGHT` | `B463` | `143` | | `BRITISH_AEROSPACE_BAE_146_300QC_FREIGHTER` | `B463` | `14Z` | | `BRITISH_AEROSPACE_BAE_146_300QT_FREIGHTER` | `B463` | `14Z` | | `BRITISH_AEROSPACE_JETSTREAM_31_BELLY_FREIGHT` | `JS31` | `J31` | | `BRITISH_AEROSPACE_JETSTREAM_32_BELLY_FREIGHT` | `JS32` | `J32` | | `BRITISH_AEROSPACE_JETSTREAM_41_BELLY_FREIGHT` | `JS41` | `J41` |
Britten-Norman aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `BRITTEN_NORMAN_BN_2_ISLANDER_BELLY_FREIGHT` | `BN2P` | `BNI` | | `BRITTEN_NORMAN_BN_2_ISLANDER_FREIGHTER` | `BN2P` | `BNI` | | `BRITTEN_NORMAN_TRISLANDER_BELLY_FREIGHT` | `TRIS` | `BNT` |
CASA / IPTN aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `CASA_C_212_100_BELLY_FREIGHT` | `C212` | `CS2` | | `CASA_C_212_100_FREIGHTER` | `C212` | `CS2` | | `CASA_C_212_200_BELLY_FREIGHT` | `C212` | `CS2` | | `CASA_C_212_200_FREIGHTER` | `C212` | `CS2` | | `CASA_C_212_300_BELLY_FREIGHT` | `C212` | `CS2` | | `CASA_C_212_300_FREIGHTER` | `C212` | `CS2` | | `CASA_C_212_400_BELLY_FREIGHT` | `C212` | `CS2` | | `CASA_C_212_400_FREIGHTER` | `C212` | `CS2` | | `CASA_NC_212I_BELLY_FREIGHT` | `C212` | `CS2` | | `CASA_NC_212I_FREIGHTER` | `C212` | `CS2` | | `CASA_CN_235_BELLY_FREIGHT` | `CN35` | `CS5` | | `CASA_CN_235_FREIGHTER` | `CN35` | `CS5` |
Cessna aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `CESSNA_208_BELLY_FREIGHT` | `C208` | `CNC` | | `CESSNA_208A_FREIGHTER` | `C208` | `CNC` | | `CESSNA_208B_BELLY_FREIGHT` | `C208` | `CNC` | | `CESSNA_208B_FREIGHTER` | `C208` | `CNC` | | `CESSNA_408_BELLY_FREIGHT` | `C408` | `CNT` | | `CESSNA_408_FREIGHTER` | `C408` | `CNT` |
Convair aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `CONVAIR_CV_580F_FREIGHTER` | `CVLT` | `CVF` | | `CONVAIR_CV_5800F_FREIGHTER` | `CVLT` | `CVF` |
Dassault aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `DASSAULT_FALCON_20DC_FREIGHTER` | `FA20` | `DF2` |
De Havilland Canada aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `DE_HAVILLAND_CANADA_DHC_2_BELLY_FREIGHT` | `DHC2` | `DHP` | | `DE_HAVILLAND_CANADA_DHC_2_FREIGHTER` | `DHC2` | `DHP` | | `DE_HAVILLAND_CANADA_DHC_2T_BELLY_FREIGHT` | `DH2T` | `DHR` | | `DE_HAVILLAND_CANADA_DHC_2T_FREIGHTER` | `DH2T` | `DHR` | | `DE_HAVILLAND_CANADA_DHC_3_BELLY_FREIGHT` | `DHC3` | `DHS` | | `DE_HAVILLAND_CANADA_DHC_3_FREIGHTER` | `DHC3` | `DHS` | | `DE_HAVILLAND_CANADA_DHC_3T_BELLY_FREIGHT` | `DH3T` | `DHL` | | `DE_HAVILLAND_CANADA_DHC_3T_FREIGHTER` | `DH3T` | `DHL` | | `DE_HAVILLAND_CANADA_DHC_6_100_BELLY_FREIGHT` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_6_100_FREIGHTER` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_6_300_BELLY_FREIGHT` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_6_300_FREIGHTER` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_6_400_BELLY_FREIGHT` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_6_400_FREIGHTER` | `DHC6` | `DHT` | | `DE_HAVILLAND_CANADA_DHC_7_BELLY_FREIGHT` | `DHC7` | `DH7` | | `DE_HAVILLAND_CANADA_DHC_8_100_BELLY_FREIGHT` | `DH8A` | `DH1` | | `DE_HAVILLAND_CANADA_DHC_8_100PF_FREIGHTER` | `DH8A` | `DH1` | | `DE_HAVILLAND_CANADA_DHC_8_200_BELLY_FREIGHT` | `DH8B` | `DH2` | | `DE_HAVILLAND_CANADA_DHC_8_300_BELLY_FREIGHT` | `DH8C` | `DH3` | | `DE_HAVILLAND_CANADA_DHC_8_400_BELLY_FREIGHT` | `DH8D` | `DH4` | | `DE_HAVILLAND_CANADA_DHC_8_402PF_FREIGHTER` | `DH8D` | `DH4` |
Douglas aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `DOUGLAS_DC3_FREIGHTER` | `DC3` | `D3F` |
Embraer aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `EMBRAER_E170_AR_BELLY_FREIGHT` | `E170` | `E70` | | `EMBRAER_E170_LR_BELLY_FREIGHT` | `E170` | `E70` | | `EMBRAER_E175_AR_BELLY_FREIGHT` | `E75L` | `E75` | | `EMBRAER_E175_LR_BELLY_FREIGHT` | `E75L` | `E75` | | `EMBRAER_E190_AR_BELLY_FREIGHT` | `E290` | `290` | | `EMBRAER_E190_LR_BELLY_FREIGHT` | `E190` | `E90` | | `EMBRAER_E195_AR_BELLY_FREIGHT` | `E295` | `295` | | `EMBRAER_E195_LR_BELLY_FREIGHT` | `E195` | `E95` | | `EMBRAER_EMB_110_BELLY_FREIGHT` | `E110` | `EMB` | | `EMBRAER_EMB_110_FREIGHTER` | `E110` | `EMB` | | `EMBRAER_EMB_120_BELLY_FREIGHT` | `E120` | `EM2` | | `EMBRAER_EMB_120FC_FREIGHTER` | `E120` | `EM2` | | `EMBRAER_EMB_120QC_FREIGHTER` | `E120` | `EM2` | | `EMBRAER_ERJ_135_BELLY_FREIGHT` | `E135` | `ER3` | | `EMBRAER_ERJ_140_BELLY_FREIGHT` | `E135` | `ERD` | | `EMBRAER_ERJ_145_BELLY_FREIGHT` | `E145` | `ER4` |
Fairchild Dornier aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `FAIRCHILD_DORNIER_DO_228_BELLY_FREIGHT` | `D228` | `D28` | | `FAIRCHILD_DORNIER_DO_228_FREIGHTER` | `D228` | `D28` | | `FAIRCHILD_DORNIER_DO_328_BELLY_FREIGHT` | `D328` | `D38` | | `FAIRCHILD_DORNIER_328JET_BELLY_FREIGHT` | `J328` | `FRJ` |
Fairchild Swearingen aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `FAIRCHILD_SWEARINGEN_METRO_II_BELLY_FREIGHT` | `SW2` | `SWM` | | `FAIRCHILD_SWEARINGEN_METRO_II_FREIGHTER` | `SW2` | `SWM` | | `FAIRCHILD_SWEARINGEN_METRO_III_BELLY_FREIGHT` | `SW3` | `SWM` | | `FAIRCHILD_SWEARINGEN_METRO_III_FREIGHTER` | `SW3` | `SWM` | | `FAIRCHILD_SWEARINGEN_METRO_23_BELLY_FREIGHT` | `SW4` | `SWM` |
Fokker aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `FOKKER_F27_BELLY_FREIGHT` | `F27` | `F27` | | `FOKKER_F27_FREIGHTER` | `F27` | `F27` | | `FOKKER_F50_BELLY_FREIGHT` | `F50` | `F50` | | `FOKKER_F50_FREIGHTER` | `F50` | `F5F` | | `FOKKER_F70_BELLY_FREIGHT` | `F70` | `F70` | | `FOKKER_100_BELLY_FREIGHT` | `F100` | `100` | | `FOKKER_100QC_FREIGHTER` | `F100` | `100` |
Harbin aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `HARBIN_Y12_BELLY_FREIGHT` | `Y12` | `YN2` | | `HARBIN_Y12F_FREIGHTER` | `Y12` | `YN2` |
Hawker Siddeley aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `HAWKER_SIDDELEY_HS_748_FREIGHTER` | `A748` | `HS7` |
Ilyushin aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `ILYUSHIN_IL_18_FREIGHTER` | `IL18` | `IL8` | | `ILYUSHIN_IL_76TD_90_FREIGHTER` | `IL76` | `IL7` | | `ILYUSHIN_IL_76TD_FREIGHTER` | `IL76` | `IL7` | | `ILYUSHIN_IL_96_300_BELLY_FREIGHT` | `IL96` | `I93` | | `ILYUSHIN_IL_96_400_BELLY_FREIGHT` | `IL96` | `I93` | | `ILYUSHIN_IL_96_400T_FREIGHTER` | `IL96` | `I9F` | | `ILYUSHIN_IL_96M_BELLY_FREIGHT` | `IL96` | `I9M` | | `ILYUSHIN_IL_96T_FREIGHTER` | `IL96` | `I9Y` | | `ILYUSHIN_IL114_BELLY_FREIGHT` | `I114` | `I14` | | `ILYUSHIN_IL114_FREIGHTER` | `I114` | `I14` |
Let Kunovice aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `LET_KUNOVICE_L_410_BELLY_FREIGHT` | `L410` | `L4T` | | `LET_KUNOVICE_L_410NG_FREIGHTER` | `L410` | `L4T` | | `LET_KUNOVICE_L_410T_FREIGHTER` | `L410` | `L4T` |
Lockheed aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `LOCKHEED_L_100_FREIGHTER` | `C130` | `LOH` | | `LOCKHEED_L_188_FREIGHTER` | `L188` | `LOF` |
McDonnell Douglas aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `MCDONNELL_DOUGLAS_DC_10_30F_FREIGHTER` | `DC10` | `D1Y` | | `MCDONNELL_DOUGLAS_DC8_55F_FREIGHTER` | `DC85` | `D8T` | | `MCDONNELL_DOUGLAS_DC8_62F_FREIGHTER` | `DC86` | `D8X` | | `MCDONNELL_DOUGLAS_DC8_63F_FREIGHTER` | `DC86` | `D8X` | | `MCDONNELL_DOUGLAS_DC8_73F_FREIGHTER` | `DC87` | `D8Y` | | `MCDONNELL_DOUGLAS_DC9_10_BELLY_FREIGHT` | `DC91` | `D91` | | `MCDONNELL_DOUGLAS_DC9_10C_FREIGHTER` | `DC91` | `D9X` | | `MCDONNELL_DOUGLAS_DC9_10F_FREIGHTER` | `DC91` | `D9X` | | `MCDONNELL_DOUGLAS_DC9_20_BELLY_FREIGHT` | `DC92` | `D92` | | `MCDONNELL_DOUGLAS_DC9_30_BELLY_FREIGHT` | `DC93` | `D93` | | `MCDONNELL_DOUGLAS_DC9_30F_FREIGHTER` | `DC93` | `D9C` | | `MCDONNELL_DOUGLAS_DC9_40_BELLY_FREIGHT` | `DC94` | `D94` | | `MCDONNELL_DOUGLAS_DC9_50_BELLY_FREIGHT` | `DC95` | `D95` | | `MCDONNELL_DOUGLAS_MD_11_FREIGHTER` | `MD11` | `M1F` | | `MCDONNELL_DOUGLAS_MD_81_BELLY_FREIGHT` | `MD81` | `M81` | | `MCDONNELL_DOUGLAS_MD_81SF_FREIGHTER` | `MD81` | `M81` | | `MCDONNELL_DOUGLAS_MD_82_BELLY_FREIGHT` | `MD82` | `M82` | | `MCDONNELL_DOUGLAS_MD_82SF_FREIGHTER` | `MD82` | `M82` | | `MCDONNELL_DOUGLAS_MD_83_BELLY_FREIGHT` | `MD83` | `M83` | | `MCDONNELL_DOUGLAS_MD_83SF_FREIGHTER` | `MD83` | `M83` | | `MCDONNELL_DOUGLAS_MD_87_BELLY_FREIGHT` | `MD87` | `M87` | | `MCDONNELL_DOUGLAS_MD_88_BELLY_FREIGHT` | `MD88` | `M88` | | `MCDONNELL_DOUGLAS_MD_88SF_FREIGHTER` | `MD88` | `M88` |
Mitsubishi aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `MITSUBISHI_MU_2_FREIGHTER` | `MU2` | `MU2` | | `MITSUBISHI_MU_2_LONG_FUSELAGE_BELLY_FREIGHT` | `MU2` | `MU2` | | `MITSUBISHI_MU_2_SHORT_FUSELAGE_BELLY_FREIGHT` | `MU2` | `MU2` |
PZL Mielec aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `PZL_MIELEC_M28_FREIGHTER` | `AN28` | `A28` |
Pilatus aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `PILATUS_PC_6_BELLY_FREIGHT` | `PC6T` | `PL6` | | `PILATUS_PC_6_FREIGHTER` | `PC6T` | `PL6` | | `PILATUS_PC_12_BELLY_FREIGHT` | `PC12` | `PL2` | | `PILATUS_PC_12_FREIGHTER` | `PC12` | `PL2` |
Piper aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `PIPER_PA_31_BELLY_FREIGHT` | `PA31` | `PA2` | | `PIPER_PA_31_FREIGHTER` | `PA31` | `PA2` | | `PIPER_PA_32_BELLY_FREIGHT` | `PA32` | `PA1` | | `PIPER_PA_32_FREIGHTER` | `PA32` | `PA1` | | `PIPER_PA_34_BELLY_FREIGHT` | `PA34` | `PA2` | | `PIPER_PA_34_FREIGHTER` | `PA34` | `PA2` | | `PIPER_PA_60_BELLY_FREIGHT` | `AEST` | `PA2` | | `PIPER_PA_60_FREIGHTER` | `AEST` | `PA2` |
Raytheon Beechcraft aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `RAYTHEON_BEECHCRAFT_1900C_BELLY_FREIGHT` | `B190` | `BES` | | `RAYTHEON_BEECHCRAFT_1900C_FREIGHTER` | `B190` | `BES` | | `RAYTHEON_BEECHCRAFT_1900D_BELLY_FREIGHT` | `B190` | `BEH` | | `RAYTHEON_BEECHCRAFT_1900D_FREIGHTER` | `B190` | `BEH` |
Saab AB aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `SAAB_2000_BELLY_FREIGHT` | `SB20` | `S20` | | `SAAB_340A_BELLY_FREIGHT` | `SF34` | `SF3` | | `SAAB_340A_FREIGHTER` | `SF34` | `SFF` | | `SAAB_340B_BELLY_FREIGHT` | `SF34` | `SF3` | | `SAAB_340B_FREIGHTER` | `SF34` | `SFF` |
Short Brothers aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `SHORT_BROTHERS_SC_5_FREIGHTER` | `BELF` | `SHB` | | `SHORT_BROTHERS_SC_7_FREIGHTER` | `SC7` | `SHS` | | `SHORT_BROTHERS_SD_330_BELLY_FREIGHT` | `SH33` | `SH3` | | `SHORT_BROTHERS_SD_330_FREIGHTER` | `SH33` | `SH3` | | `SHORT_BROTHERS_SD_360_300F_FREIGHTER` | `SH36` | `SH6` | | `SHORT_BROTHERS_SD_360_BELLY_FREIGHT` | `SH36` | `SH6` |
Sukhoi aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `SUKHOI_SUPERJET_100_BELLY_FREIGHT` | `SU95` | `SU9` |
Tupolev aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `TUPOLEV_TU_204_100_BELLY_FREIGHT` | `T204` | `T20` | | `TUPOLEV_TU_204_100C_FREIGHTER` | `T204` | `T20` | | `TUPOLEV_TU_204_120_BELLY_FREIGHT` | `T204` | `T20` | | `TUPOLEV_TU_204_120C_FREIGHTER` | `T204` | `T20` | | `TUPOLEV_TU_204_300_BELLY_FREIGHT` | `T204` | `T20` | | `TUPOLEV_TU_214_BELLY_FREIGHT` | `T204` | `T20` |
Xi'an aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `XIAN_MA60_BELLY_FREIGHT` | `MA60` | `MA6` | | `XIAN_MA600_BELLY_FREIGHT` | `MA60` | `MA6` | | `XIAN_MA600F_FREIGHTER` | `MA60` | `MA6` |
Yakovlev aircraft | System Identifier | ICAO code | IATA code | |------------------------------------------------|-----------|-----------| | `YAKOVLEV_YAK_40_BELLY_FREIGHT` | `YK40` | `YK4` | | `YAKOVLEV_YAK_40K_FREIGHTER` | `YK40` | `YK4` | | `YAKOVLEV_YAK_42_BELLY_FREIGHT` | `YK42` | `YK2` |
RailTransportDepartureDateTime: type: string format: date-time description: > When the train departed its origin railyard. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the origin railyard's timezone. Example (origin Paris): `2025-03-28T09:00` → `2025-03-28T09:00+01:00` - UTC times are automatically converted to offset times based on the origin railyard's timezone. Example (origin Paris): `2025-03-28T08:00Z` → `2025-03-28T09:00+01:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` RailTransportArrivalDateTime: type: string format: date-time description: > When the train arrived at its destination railyard. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the destination railyard's timezone. Example (destination London): `2025-03-28T09:00` → `2025-03-28T09:00+00:00` - UTC times are automatically converted to offset times based on the destination railyard's timezone. Example (destination London): `2025-03-28T09:00Z` → `2025-03-28T09:00+00:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` RailTransportVehicle: description: > The type of train used. When this property is set, the `trainType`, `grossTrainWeight`, and `cargo`.`category` properties are ignored. `LIGHT_TRAIN` Light train A mixed cargo (manifest) freight train with a gross weight less than 750 tonnes. `AVERAGE_TRAIN` Average train A mixed cargo (manifest) freight train with a gross weight between 750 and 1,250 tonnes. `LARGE_TRAIN` Large train A mixed cargo (manifest) freight train with a gross weight between 1,250 and 1,750 tonnes. `EXTRA_LARGE_TRAIN` Extra large train A mixed cargo (manifest) freight train with a gross weight between 1,750 and 2,250 tonnes. `HEAVY_TRAIN` Heavy train A mixed cargo (manifest) freight train with a gross weight greater than 2,250 tonnes. `AUTOMOBILE_TRAIN` Automobile A dedicated (unit) freight train composed solely of autorack wagons used for transporting road vehicles. `CHEMICALS_TRAIN` Chemicals train A dedicated (unit) freight train composed solely of tank or specialized wagons used for transporting chemical products, including oil, petroleum derivatives, and liquefied gases. `CONTAINER_TRAIN` Container train A dedicated (unit) freight train composed solely of flat or well wagons used for transporting containers. `DOUBLE_CONTAINER_TRAIN` Double container train A dedicated (unit) freight train composed solely of well wagons used for transporting double-stacked containers. `COAL_AND_STEEL_TRAIN` Coal and steel train A dedicated (unit) freight train composed solely of hopper and gondola wagons used for transporting coal and steel products. `BUILDING_MATERIALS_TRAIN` Building materials train A dedicated (unit) freight train composed solely of appropriate wagons used for transporting bulk and palletized building materials. `MANUFACTURED_PRODUCTS_TRAIN` Manufactured products train A dedicated (unit) freight train composed solely of covered or specialized wagons used for transporting manufactured goods. `CEREALS_TRAIN` Cereals train A dedicated (unit) freight train composed solely of covered hopper wagons used for transporting cereal grains. enum: - LIGHT_TRAIN - AVERAGE_TRAIN - LARGE_TRAIN - EXTRA_LARGE_TRAIN - HEAVY_TRAIN - AUTOMOBILE_TRAIN - CHEMICALS_TRAIN - CONTAINER_TRAIN - DOUBLE_CONTAINER_TRAIN - COAL_AND_STEEL_TRAIN - BUILDING_MATERIALS_TRAIN - MANUFACTURED_PRODUCTS_TRAIN - CEREALS_TRAIN RailTransportTrainType: description: | Indicates the type of train. `MANIFEST` Manifest A general or mixed-cargo train for which emissions are calculated based on the train’s gross tonnage. The `grossTrainWeight` (when provided) is used to determine the train size. If `grossTrainWeight` is not provided, the size defaults based on the region of operation (e.g., `AVERAGE_TRAIN` in Europe, and `HEAVY_TRAIN` in USA). `UNIT` Unit A freight train dedicated to a single type of cargo, with emissions calculated based on that cargo category. `grossTrainWeight` is ignored. The `cargo`.`category` is used to determine the train type. The `GENERAL` and `REFRIGERATED_BULK` cargo categories are treated as containerized, with wagon size varying by region (e.g., single-stacked containers in Europe, double-stacked in the USA). enum: - MANIFEST - UNIT RailTransportGrossTrainWeight: type: object description: > Gross weight of the train. For `MANIFEST` trains, this value is used to select the appropriate train size according to the following weight ranges | Gross Weight | Manifest Train Type | |---------------------------|-----------------------| | < 750 tonnes | `LIGHT_TRAIN` | | 750 to 1,250 tonnes | `AVERAGE_TRAIN` | | 1,250 to 1,750 tonnes | `LARGE_TRAIN` | | 1,750 to 2,250 tonnes | `EXTRA_LARGE_TRAIN` | | > 2,250 tonnes | `HEAVY_TRAIN` | required: - value - unit properties: value: type: number format: double description: Numeric value representing the train's gross weight. unit: type: string description: > Unit of measurement for the train's gross weight, in either metric or U.S. customary units. `KILOGRAM` Kilogram Measure in kilograms. `POUND` Pound Measure in U.S. customary / imperial pounds. `METRIC_TONNE` Metric tonne Measure in metric tonnes (1000 kg). `US_SHORT_TON` US short ton Measure in U.S. customary short tons (two thousand pounds). enum: - KILOGRAM - POUND - METRIC_TONNE - US_SHORT_TON RailTransportEnergyType: type: string description: | The form of energy used to power the train’s traction system. `ELECTRICITY` Electricity Energy supplied from the national electrical grid in the country of operation, with emissions based on the grid’s generation mix and including transmission, distribution, and pantograph connection losses. `DIESEL` Diesel Energy supplied by petroleum (fossil-derived) diesel fuel, with biofuel content, if any, determined by the country of operation. enum: - ELECTRICITY - DIESEL RoadTransportDepartureDateTime: type: string format: date-time description: > When the road vehicle departed its start location. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the start location's timezone. Example (origin Sydney): `2025-03-28T09:00` → `2025-03-28T09:00+11:00` - UTC times are automatically converted to offset times based on the start location's timezone. Example (origin Sydney): `2025-03-27T22:00Z` → `2025-03-28T09:00+11:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` RoadTransportArrivalDateTime: type: string format: date-time description: > When the road vehicle arrived at its end location. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the destination location's timezone. Example (destination Perth): `2025-03-28T09:00` → `2025-03-28T09:00+08:00` - UTC times are automatically converted to offset times based on the destination location's timezone. Example (destination Perth): `2025-03-28T01:00Z` → `2025-03-28T09:00+08:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` RoadTransportVehicle: type: string description: > Indicates a general category of vehicle used in the operation when only limited information is available. This value acts as a broad placeholder that the system will refine into a more specific vehicle classification based on other properties provided in this object and the `cargo`.`category`. `LCV_BELOW_3500_KG` Light commercial vehicle below 3,500kg Van or light commercial vehicle with gross vehicle weight (GVW) under 3.5 metric tonnes. `LCV_BELOW_8500_LB` Light commercial vehicle below 8,500lb Van or light commercial vehicle with gross vehicle weight (GVW) under 8,500 pounds. `LIGHT_DUTY_VEHICLE` Light duty vehicle Light truck used as a generic representation of small distribution or service vehicles typically operating over short distances in urban, suburban, or similar local environments. `MEDIUM_DUTY_VEHICLE` Medium duty vehicle Medium sized truck serving as a generic representation of vehicles typically used for medium haul freight movement with moderate cargo capacity. `HEAVY_DUTY_VEHICLE` Heavy duty vehicle High capacity vehicle used as a generic representation of vehicles typically operating over long haul routes carrying heavy cargo. enum: - LCV_BELOW_3500_KG - LCV_BELOW_8500_LB - LIGHT_DUTY_VEHICLE - MEDIUM_DUTY_VEHICLE - HEAVY_DUTY_VEHICLE RoadTransportStructure: type: string description: > The structural configuration of the vehicle. This property is used as an additional input to refine vehicle classification. `ARTICULATED` Articulated truck The vehicle consists of a towing unit connected to one or more trailers through pivoting joints. `RIGID` Rigid truck The vehicle is a single, fixed unit with no separate trailer sections. `DUMP` Dump truck The vehicle is equipped with an open bed that can be raised to unload bulk materials, typically used for transporting construction materials. enum: - ARTICULATED - RIGID - DUMP RoadTransportGrossWeightBand: type: string description: > The gross vehicle weight range for the vehicle, used together with the structure property (if provided, otherwise defaulted) to derive a vehicle classification. Some weight bands are specific to Chinese vehicles and will be automatically mapped to the most appropriate equivalent when used for vehicles operating outside China. Likewise, certain bands apply only to Indian vehicles and will be converted when used elsewhere. All other bands are intended for global use and may also be converted as needed. When both `grossWeight` and `grossWeightBand` are supplied, this banded value takes precedence. `BELOW_1890_KG` Below 1,890kg Light vans derived from cars, such as the Peugeot Bipper and Citroën Nemo. Converted when used in China, India and North America. By default, classified as a N1 Class I vehicle. `1890_TO_2725_KG` 1,890 to 2,725kg Medium vans and light pickup trucks. For example, the Toyota Proace City and Ford Maverick. Converted when used in China, India and North America. By default, classified as a N1 Class II vehicle. `2725_TO_3500_KG` 2,725 to 3,500kg Large vans and heavy pickup trucks. For example, the Volkswagen Crafter, Mercedes Sprinter and Ford F-350. Converted when used in China, India and North America. By default, classified as a N1 Class III vehicle. `3500_TO_4500_KG` 3,500 to 4,500kg Vehicles with a gross vehicle weight between 3.5 and 4.5 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `3500_TO_5000_KG` 3,500 to 5,000kg Vehicles with a gross vehicle weight between 3.5 and 5.0 tonnes. Converted when used outside of India. By default, classified as a `RIGID` vehicle. `3500_TO_7500_KG` 3,500 to 7,500kg Vehicles with a gross vehicle weight between 3.5 and 7.5 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `4500_TO_5500_KG` 4,500 to 5,500kg Vehicles with a gross vehicle weight between 4.5 and 5.5 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `5000_TO_12000_KG` 5,000 to 12,000kg Vehicles with a gross vehicle weight between 5.0 and 12.0 tonnes. Converted when used outside of India. By default, classified as a `RIGID` vehicle. `5500_TO_7000_KG` 5,500 to 7,000kg Vehicles with a gross vehicle weight between 5.5 and 7.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `7000_TO_8500_KG` 7,000 to 8,500kg Vehicles with a gross vehicle weight between 7.0 and 8.5 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `7500_TO_12000_KG` 7,500 to 12,000kg Vehicles with a gross vehicle weight between 7.5 and 12.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `8500_TO_10500_KG` 8,500 to 10,500kg Vehicles with a gross vehicle weight between 8.5 and 10.5 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `10500_TO_12500_KG` 10,500 to 12,500kg Vehicles with a gross vehicle weight between 10.5 and 12.5 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `12000_TO_14000_KG` 12,000 to 14,000kg Vehicles with a gross vehicle weight between 12.0 and 14.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `12000_TO_20000_KG` 12,000 to 20,000kg Vehicles with a gross vehicle weight between 12.0 and 20.0 tonnes. Converted when used outside of India. By default, classified as a `RIGID` vehicle. `12500_TO_14000_KG` 12,500 to 14,000kg Vehicles with a gross vehicle weight between 12.5 and 14.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `14000_TO_16000_KG` 14,000 to 16,000kg Vehicles with a gross vehicle weight between 14.0 and 16.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `14000_TO_18000_KG` 14,000 to 18,000kg Vehicles with a gross vehicle weight between 14.0 and 18.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `14000_TO_20000_KG` 14,000 to 20,000kg Vehicles with a gross vehicle weight between 14.0 and 20.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `16000_TO_20000_KG` 16,000 to 20,000kg Vehicles with a gross vehicle weight between 16.0 and 20.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `18000_TO_24000_KG` 18,000 to 24,000kg Vehicles with a gross vehicle weight between 18.0 and 24.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `20000_TO_25000_KG` 20,000 to 25,000kg Vehicles with a gross vehicle weight between 20.0 and 25.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `20000_TO_26000_KG` 20,000 to 26,000kg Vehicles with a gross vehicle weight between 20.0 and 26.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `20000_TO_30000_KG` 20,000 to 30,000kg Vehicles with a gross vehicle weight between 20.0 and 30.0 tonnes. Converted when used outside of India. By default, classified as a `RIGID` vehicle. `24000_TO_27000_KG` 24,000 to 27,000kg Vehicles with a gross vehicle weight between 24.0 and 27.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `25000_TO_29000_KG` 25,000 to 29,000kg Vehicles with a gross vehicle weight between 25.0 and 29.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `26000_TO_28000_KG` 26,000 to 28,000kg Vehicles with a gross vehicle weight between 26.0 and 28.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `27000_TO_29000_KG` 27,000 to 29,000kg Vehicles with a gross vehicle weight between 27.0 and 29.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `28000_TO_32000_KG` 28,000 to 32,000kg Vehicles with a gross vehicle weight between 28.0 and 32.0 tonnes. Converted when used in China, India and North America. By default, classified as a `RIGID` vehicle. `29000_TO_31000_KG` 29,000 to 31,000kg Vehicles with a gross vehicle weight between 29.0 and 31.0 tonnes. Converted when used outside of China. By default, classified as a `RIGID` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `30000_TO_50000_KG` 30,000 to 50,000kg Vehicles with a gross vehicle weight between 30.0 and 50.0 tonnes. Converted when used outside of India. By default, classified as an `RIGID` vehicle. `30000_TO_60000_KG` 30,000 to 60,000kg Vehicles with a gross vehicle weight between 30.0 and 60.0 tonnes. Converted when used outside of India. By default, classified as an `ARTICULATED` vehicle. `31000_TO_35000_KG` 31,000 to 35,000kg Vehicles with a gross vehicle weight between 31.0 and 35.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `31000_TO_60000_KG` 31,000 to 60,000kg Vehicles with a gross vehicle weight between 31.0 and 60.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `32000_TO_34000_KG` 32,000 to 34,000kg Vehicles with a gross vehicle weight between 32.0 and 34.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `34000_TO_40000_KG` 34,000 to 40,000kg Vehicles with a gross vehicle weight between 34.0 and 40.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `35000_TO_40000_KG` 35,000 to 40,000kg Vehicles with a gross vehicle weight between 35.0 and 40.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `40000_TO_43000_KG` 40,000 to 43,000kg Vehicles with a gross vehicle weight between 40.0 and 43.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `40000_TO_50000_KG` 40,000 to 50,000kg Vehicles with a gross vehicle weight between 40.0 and 50.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `43000_TO_46000_KG` 43,000 to 46,000kg Vehicles with a gross vehicle weight between 43.0 and 46.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `50000_TO_60000_KG` 50,000 to 60,000kg Vehicles with a gross vehicle weight between 50.0 and 60.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `46000_TO_49000_KG` 46,000 to 49,000kg Vehicles with a gross vehicle weight between 46.0 and 49.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `49000_TO_60000_KG` 49,000 to 60,000kg Vehicles with a gross vehicle weight between 49.0 and 60.0 tonnes. Converted when used outside of China. By default, classified as an `ARTICULATED` vehicle for all cargo categories, except building materials, where it is classified as a `DUMP` truck. `60000_TO_64000_KG` 60,000 to 64,000kg Vehicles with a gross vehicle weight between 60.0 and 64.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `64000_TO_72000_KG` 64,000 to 72,000kg Vehicles with a gross vehicle weight between 64.0 and 72.0 tonnes. Converted when used in China, India and North America. By default, classified as an `ARTICULATED` vehicle. `BELOW_8500_LB` Below 8,500lb Vehicles with a gross vehicle weight below 8,500 pounds. Converted when used outside of North America. `8500_TO_14000_LB` 8,500 to 14,000lb Vehicles with a gross vehicle weight between 8,500 and 14,000 pounds. Converted when used outside of North America. `14000_TO_19500_LB` 14,000 to 19,500lb Vehicles with a gross vehicle weight between 14,000 and 19,500 pounds. Converted when used outside of North America. `19500_TO_33000_LB` 19,500 to 33,000lb Vehicles with a gross vehicle weight between 19,500 and 33,000 pounds. Converted when used outside of North America. `OVER_33000_LB` Over 33,000lb Vehicles with a gross vehicle weight that exceeds 33,000 pounds. Converted when used outside of North America. enum: - BELOW_1890_KG - 1890_TO_2725_KG - 2725_TO_3500_KG - 3500_TO_4500_KG - 3500_TO_5000_KG - 3500_TO_7500_KG - 4500_TO_5500_KG - 5000_TO_12000_KG - 5500_TO_7000_KG - 7000_TO_8500_KG - 7500_TO_12000_KG - 8500_TO_10500_KG - 10500_TO_12500_KG - 12000_TO_14000_KG - 12000_TO_20000_KG - 12500_TO_14000_KG - 14000_TO_16000_KG - 14000_TO_18000_KG - 14000_TO_20000_KG - 16000_TO_20000_KG - 18000_TO_24000_KG - 20000_TO_25000_KG - 20000_TO_26000_KG - 20000_TO_30000_KG - 24000_TO_27000_KG - 25000_TO_29000_KG - 26000_TO_28000_KG - 27000_TO_29000_KG - 28000_TO_32000_KG - 29000_TO_31000_KG - 30000_TO_50000_KG - 30000_TO_60000_KG - 31000_TO_35000_KG - 31000_TO_60000_KG - 32000_TO_34000_KG - 34000_TO_40000_KG - 35000_TO_40000_KG - 40000_TO_43000_KG - 40000_TO_50000_KG - 43000_TO_46000_KG - 46000_TO_49000_KG - 49000_TO_60000_KG - 50000_TO_60000_KG - 60000_TO_64000_KG - 64000_TO_72000_KG - BELOW_8500_LB - 8500_TO_14000_LB - 14000_TO_19500_LB - 19500_TO_33000_LB - OVER_33000_LB RoadTransportGrossWeight: type: object description: > The total weight of the vehicle at the time of measurement, including the vehicle itself, its load, and any additional equipment. This value is used, together with the structure property (if supplied, otherwise defaulted), to derive the appropriate vehicle classification. required: - value - unit properties: value: type: number format: double description: Numeric value representing the vehicle's gross weight. unit: type: string description: > Unit of measurement for the vehicle's gross weight, in either metric or U.S. customary units. `KILOGRAM` Kilogram Measure in kilograms. `POUND` Pound Measure in U.S. customary / imperial pounds. `METRIC_TONNE` Metric tonne Measure in metric tonnes (1000 kg). `US_SHORT_TON` US short ton Measure in U.S. customary short tons (two thousand pounds). enum: - KILOGRAM - POUND - METRIC_TONNE - US_SHORT_TON RoadTransportEmptyWeight: type: object description: > The empty weight of the vehicle (also called the unladen weight or tare weight) is the weight of a vehicle by itself, without any cargo, passengers, or additional load. This value is converted into an estimated gross vehicle weight using a lookup table of empty-to-gross relationships derived from typical vehicle classes and their associated load factors. This inferred gross weight is then combined with the structure property (if supplied, otherwise defaulted) to derive a vehicle classification. required: - value - unit properties: value: type: number format: double description: Numeric value representing the vehicle's empty weight. unit: type: string description: > Unit of measurement for the vehicle's empty weight, in either metric or U.S. customary units. `KILOGRAM` Kilogram Measure in kilograms. `POUND` Pound Measure in U.S. customary / imperial pounds. `METRIC_TONNE` Metric tonne Measure in metric tonnes (1000 kg). `US_SHORT_TON` US short ton Measure in U.S. customary short tons (two thousand pounds). enum: - KILOGRAM - POUND - METRIC_TONNE - US_SHORT_TON RoadTransportMaximumWeight: type: object description: > The maximum vehicle weight (also called the maximum permitted or gross allowable weight) is the highest total weight a vehicle is allowed to operate at, including the vehicle itself, its load, and any additional equipment. This value is converted into an estimated gross vehicle weight using a lookup table of maximum-to-gross relationships derived from typical vehicle classes and their associated load factors. This inferred gross weight is then combined with the structure property (if supplied, otherwise defaulted) to derive a vehicle classification. required: - value - unit properties: value: type: number format: double description: Numeric value representing the vehicle's maximum weight. unit: type: string description: > Unit of measurement for the vehicle's maximum weight, in either metric or U.S. customary units. `KILOGRAM` Kilogram Measure in kilograms. `POUND` Pound Measure in U.S. customary / imperial pounds. `METRIC_TONNE` Metric tonne Measure in metric tonnes (1000 kg). `US_SHORT_TON` US short ton Measure in U.S. customary short tons (two thousand pounds). enum: - KILOGRAM - POUND - METRIC_TONNE - US_SHORT_TON RoadTransportYearOfManufacture: type: number format: integer description: > Year the vehicle was manufactured. If the specified year is not supported, then the system falls back to a country level weighted aggregation of vehicle years based on a national age distribution. If a year is not provided, them system falls back to the weighted aggregation. RoadTransportEmissionsStandard: type: string description: > The vehicle’s emissions class. If the specified class is unsupported for the vehicle type, energy type, and year of manufacture, then the closest supported class is used instead. If no value is provided, the class is defaulted based on the country where the trip originates, the type of vehicle, and the type of energy used. `EURO_1` Euro I Emissions class corresponding to Euro I `EURO_2` Euro II Emissions class corresponding to Euro II `EURO_3` Euro III Emissions class corresponding to Euro III `EURO_4` Euro IV Emissions class corresponding to Euro IV `EURO_5` Euro V Emissions class corresponding to Euro V `EURO_6` Euro VI Emissions class corresponding to Euro VI `EURO_6AB` Euro VI step A / step B Emissions class corresponding to Euro VI step A or step B `EURO_6AC` Euro VI step A / step C Emissions class corresponding to Euro VI step A or step C `EURO_6C` Euro VI step C Emissions class corresponding to Euro VI step C `EURO_6D_TEMP` Euro VI step D-TEMP Emissions class corresponding to Euro VI step D-TEMP `EURO_6DE` Euro VI step D / step E Emissions class corresponding to Euro VI step D or step E `EURO_7` Euro VII Emissions class corresponding to Euro VII enum: - EURO_1 - EURO_2 - EURO_3 - EURO_4 - EURO_5 - EURO_6 - EURO_6AB - EURO_6AC - EURO_6C - EURO_6D_TEMP - EURO_6DE - EURO_7 RoadTransportLoadFactor: type: number format: double description: > Percentage utilisation of vehicle capacity. Must be greater than 0. If not provided, it is defaulted based on the vehicle classification and energy type. RoadTransportEmptyRunning: type: number format: double description: > Percentage of the trip completed without carrying a load. A value of 0 means no empty running occurred. Values between 0 and 100 indicate a mix of loaded and empty distance. Must be greater than or equal to 0 and less than 100, as 100 would imply the entire trip was empty. RoadTransportPackaging: type: string description: > The packaging format used for the cargo. This value is used, together with the structure property (if supplied, otherwise defaulted), to help determine the appropriate vehicle classification. `CONTAINER` Container Cargo is packed in a standard (e.g., TEU, FEU) shipping container. `PALLET` Pallet Cargo is packed on a standard (e.g., GMA, EUR, ISO) pallet. enum: - CONTAINER - PALLET RoadTransportEnergyType: type: string description: > Specifies the type of energy that provides propulsion for the vehicle. This value plays a significant role in determining the vehicle’s emissions profile. If not specified, `DIESEL` is used by default. `DIESEL` Diesel Petroleum (fossil-derived) diesel used in road transport, with biofuel content, if any, determined by the country of operation. `GASOLINE` Gasoline Petrol (fossil-derived) diesel used in road transport, with biofuel content, if any, determined by the country of operation. `ELECTRICITY` Electricity Electrical energy `LNG` LNG Liquefied natural gas (fossil-derived) diesel used in road transport, with biofuel content, if any, determined by the country of operation. `LPG` LPG Liquefied petroleum gas (fossil-derived) diesel used in road transport, with biofuel content, if any, determined by the country of operation. `CNG` CNG Compressed natural gas (fossil-derived) diesel used in road transport, with biofuel content, if any, determined by the country of operation. `HVO100` HVO100 Pure hydrotreated vegetable oil with no fossil derived content enum: - DIESEL - GASOLINE - ELECTRICITY - LNG - LPG - CNG - HVO100 RoadTransportLoadDistribution: type: string description: > The cargo's share of vehicle load. If not specified, `LTL` is used by default. `FTL` Full truck load The shipment is allocated exclusive use of the vehicle. If the cargo exceeds the vehicle’s capacity, multiple fully loaded trips are assumed. `LTL` Less than truckload The shipment uses only part of the vehicle’s capacity, and the remaining space is shared with other loads up to a provided or defaulted load factor. enum: - FTL - LTL RoadTransportEnergyConsumption: type: object description: > The energy consumption of the vehicle. Values may represent absolute quantities (volumetric, gravimetric, or electrical values) or consumption rates (fuel or electricity used per unit distance, or distance achieved per unit of fuel or electricity). #### Electrical energy unit (watts / watt-hours / kilowatt-hours) energy type compatibility #### - `ELECTRICITY` #### Gravimetric unit (kilograms / pounds) energy type compatibility #### - `DIESEL` - `GASOLINE` - `LPG` - `CNG` - `LNG` - `HVO100` #### Volumetric unit (liters / gallons) energy type compatibility #### - `DIESEL` - `GASOLINE` - `LPG` - `HVO100` required: - value - unit properties: value: type: number format: double description: >- The numeric fuel or electrical energy consumption value in the specified `unit`. unit: type: string description: > Specifies the unit of fuel or electrical energy consumption. `LITER` Liter The absolute consumed fuel quantity measured in liters. `US_GALLON` US gallon The absolute consumed fuel quantity measured in U.S. gallons. `UK_GALLON` UK gallon The absolute consumed fuel quantity measured in U.K. gallons. `KILOGRAM` Kilogram The absolute consumed fuel quantity measured in kilograms. `POUND` Pound The absolute consumed fuel quantity measured in pounds. `LITERS_PER_KILOMETER` Liters per kilometer Fuel consumption rate in liters per kilometer. `LITERS_PER_100_KILOMETER` Liters per 100 kilometer Fuel consumption rate in liters per 100 kilometers. `KILOMETERS_PER_LITER` Kilometers per liter Kilometers travelled per liter of fuel consumption rate. `MILES_PER_US_GALLON` Miles per US gallon Miles (~1.6km) travelled per U.S. gallon of fuel consumption rate. `MILES_PER_UK_GALLON` Miles per UK gallon Miles (~1.6km) travelled per U.K. gallon of fuel consumption rate. `US_GALLONS_PER_100_MILE` US gallons per 100 mile Fuel consumption rate in U.S. gallons per 100 miles (~161km). `UK_GALLONS_PER_100_MILE` UK gallons per 100 mile Fuel consumption rate in U.K. gallons per 100 miles (~161km). `KILOGRAMS_PER_KILOMETER` Kilograms per kilometer Fuel consumption rate in kilograms per kilometer. `KILOGRAMS_PER_100_KILOMETER` Kilograms per 100 kilometer Fuel consumption rate in kilograms per 100 kilometers. `KILOMETERS_PER_KILOGRAM` Kilometers per kilogram Kilometers travelled per kilogram of fuel consumption rate. `POUNDS_PER_MILE` Pounds per mile Fuel consumption rate in pounds per mile (~1.6km). `POUNDS_PER_100_MILE` Pounds per 100 mile Fuel consumption rate in pounds per 100 miles (~161km). `MILES_PER_POUND` Miles per pound Miles (~1.6km) travelled per pound of fuel consumption rate. `KILOWATT_HOURS` Kilowatt hours The absolute consumed electrical energy measured in kilowatt-hours. `KILOWATT_HOURS_PER_KILOMETER` Kilowatt hours per kilometer Electrical energy consumption rate in kilowatt-hours per kilometer. `KILOWATT_HOURS_PER_100_KILOMETER` Kilowatt hours per 100 kilometer Electrical energy consumption rate in kilowatt-hours per 100 kilometers. `WATT_HOURS_PER_KILOMETER` Watt hours per kilometer Electrical energy consumption rate in watt-hours per kilometer. `KILOMETERS_PER_KILOWATT_HOUR` Kilometers per kilowatt hour Kilometers travelled per kilowatt hour of electrical energy consumption rate. `KILOWATT_HOURS_PER_MILE` Kilowatt hours per mile Electrical energy consumption rate in kilowatt-hours per mile (~1.6km). `KILOWATT_HOURS_PER_100_MILE` Kilowatt hours per 100 mile Electrical energy consumption rate in kilowatt-hours per 100 miles (~161km). `WATT_HOURS_PER_MILE` Watt hours per mile Electrical energy consumption rate in watt-hours per mile (~1.6km). `MILES_PER_KILOWATT_HOUR` Miles per kilowatt hour Miles (~1.6km) travelled per kilowatt-hour of electrical energy consumption rate. enum: - LITER - US_GALLON - UK_GALLON - KILOGRAM - POUND - LITERS_PER_KILOMETER - LITERS_PER_100_KILOMETER - KILOMETERS_PER_LITER - MILES_PER_US_GALLON - MILES_PER_UK_GALLON - US_GALLONS_PER_100_MILE - UK_GALLONS_PER_100_MILE - KILOGRAMS_PER_KILOMETER - KILOGRAMS_PER_100_KILOMETER - KILOMETERS_PER_KILOGRAM - POUNDS_PER_MILE - POUNDS_PER_100_MILE - MILES_PER_POUND - KILOWATT_HOURS - KILOWATT_HOURS_PER_100_KILOMETER - KILOWATT_HOURS_PER_KILOMETER - WATT_HOURS_PER_KILOMETER - KILOMETERS_PER_KILOWATT_HOUR - KILOWATT_HOURS_PER_MILE - KILOWATT_HOURS_PER_100_MILE - WATT_HOURS_PER_MILE - MILES_PER_KILOWATT_HOUR WaterTransportDepartureDateTime: type: string format: date-time description: > When the vessel departed its start location. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the start location's timezone. Example (origin Shanghai): `2025-03-28T09:00` → `2025-03-28T09:00+08:00` - UTC times are automatically converted to offset times based on the start location's timezone. Example (origin Shanghai): `2025-03-28T01:00Z` → `2025-03-28T09:00+08:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` WaterTransportArrivalDateTime: type: string format: date-time description: > When the vessel arrived at its end location. #### Format #### ISO 8601 extended format date/time string in one of the following formats. - Local date/time (no offset), e.g. `2024-11-17T14:32` - UTC (Zulu) time, e.g. `2024-11-17T14:32` - Offset time, e.g. `2024-11-17T14:32+01:00` #### Offset management #### - Local times are automatically converted to offset times based on the destination location's timezone. Example (destination Rotterdam): `2025-03-28T09:00` → `2025-03-28T09:00+01:00` - UTC times are automatically converted to offset times based on the destination location's timezone. Example (destination Rotterdam): `2025-03-28T08:00Z` → `2025-03-28T09:00+01:00` #### Supported precision #### - Milliseconds: `2025-04-17T14:32:45.123+01:00` - Seconds: `2025-04-17T14:32:45+01:00` - Minutes: `2025-04-17T14:32+01:00` - Hours: `2025-04-17T14+01:00` - Date only: `2025-04-17` WaterTransportVehicle: type: string description: | The type of vessel used. `CONTAINER` Container Transports standardized shipping containers. The default for `GENERAL` and `MANUFACTURED_PRODUCTS` cargo. `BULKER` Bulker Transports unpackaged bulk goods. The default for `BUILDING_MATERIALS`, `CEREALS`, `COAL_AND_STEEL` and `SOLID_CHEMICALS` cargo. `GENERAL_CARGO` General cargo Transports varied packaged or breakbulk goods. The fallback when candidate ports show no historical AIS activity for the requested type. `LIQUEFIED_GAS_TANKER` Liquefied gas tanker Specialized tanker for transporting liquefied gases like LNG or LPG at very low temperatures or under pressure within insulated tanks. The default for `LIQUEFIED_GAS` cargo. `OIL_TANKER` Oil tanker Tanker that taransports crude oil or refined petroleum products in segregated liquid cargo tanks. The default for `OIL` cargo. `CHEMICAL_TANKER` Chemical tanker Tanker equipped with segregated tanks to transport liquid chemicals. The default for `LIQUID_CHEMICALS` cargo. `OTHER_LIQUIDS_TANKER` Other liquids tanker Tanker that transports liquids outside the oil, gas, and regulated chemical categories such as wine, or fruit juices. `REFRIGERATED_BULKER` Refrigerated bulker Bulk carrier with cooling systems for perishable goods. The default for `REFRIGERATED_BULK` cargo. `AUTOMOBILE_CARRIER` Automobile carrier A roll-on/roll-off vessel that transports cars and other wheeled vehicles. The default for `AUTOMOBILES` cargo. enum: - CONTAINER - BULKER - GENERAL_CARGO - LIQUEFIED_GAS_TANKER - OIL_TANKER - CHEMICAL_TANKER - OTHER_LIQUIDS_TANKER - REFRIGERATED_BULKER - AUTOMOBILE_CARRIER WaterTransportCapacity: type: object description: > Capacity of the vessel. If the supplied unit matches the vessel type’s native capacity unit, the value is assigned to a capacity band through a straightforward numeric comparison. If the unit differs, the value is first converted to the native capacity unit using regression-based formulas developed from the global shipping fleet. The converted value is then classified into the appropriate capacity band. For example, if a `GENERAL_CARGO` vessel’s capacity is provided in `GROSS_TONNE`, the value is transformed into an equivalent `DEAD_WEIGHT_TONNE` estimate using a regression-derived conversion function specific to `GENERAL_CARGO` vessels. required: - value - unit properties: value: type: number format: double description: Vessel's numeric capacity value, interpreted according to the unit. unit: type: string description: | The measurement unit for the vessel’s capacity. `DEAD_WEIGHT_TONNE` Dead weight tonne Total weight a vessel can safely carry, including cargo, fuel, provisions, and crew. This is the native unit used to classify capacity on `BULKER`, `GENERAL_CARGO`, `OIL_TANKER`, `CHEMICAL_TANKER`, `OTHER_LIQUIDS_TANKER`, and `REFRIGERATED_BULKER` vessels. `GROSS_TONNE` Gross tonne A measure of the vessel’s total internal volume. This is the native unit used to classify capacity on `AUTOMOBILE_CARRIER` vessels. `CONTAINER` Container The number of standard twenty-foot (TEU) shipping containers the vessel can carry. `CUBIC_METER` Cubic meter The volume capacity available for liquid or bulk cargo, measured in cubic meters. This is the native unit used to classify capacity on `LIQUEFIED_GAS_TANKER` vessels. enum: - DEAD_WEIGHT_TONNE - GROSS_TONNE - CONTAINER - CUBIC_METER WaterTransportSize: type: string description: > The vessel’s size classification. A size class is converted to the vessel type's native capacity band. The size classes listed below are grouped by the vessel types they are most commonly associated with, though some classes overlap across types. If a size class is used with a different vessel type, for example, using the `VLCC` class on a `BULKER` vessel, the system will still perform a valid conversion to a `DEAD_WEIGHT_TONNE` capacity band using regression-based formulas developed from the global shipping fleet. #### Dry bulk size classes #### | Class Name | Description | |---------------|-------------------------------| | `MINI_BULKER` | Very small bulk carrier | | `SMALL_HANDY` | Small regional carrier | | `HANDY` | Versatile mid-size carrier | | `HANDYMAX` | Larger handy-size carrier | | `SUPRAMAX` | Medium bulk carrier | | `ULTRAMAX` | Large capacity bulk carrier | | `CAPESIZE` | Large deep sea carrier | | `CHINAMAX` | Very large deep draft carrier | | `VALEMAX` | Ultra large ore carrier | #### Tanker size classes #### | Class Name | Description | |-------------------|-------------------------------------------| | `GENERAL_PURPOSE` | Small product tanker | | `MEDIUM_RANGE` | Medium product tanker | | `LR1` | Long range product tanker | | `LR2` | Large long range tanker | | `AFRAMAX` | Large global reach petroleum tanker | | `SUEZMAX` | Large Suez Canal capable petroleum tanker | | `VLCC` | Very large crude tanker | | `ULCC` | Ultra large crude tanker | #### LNG carrier size classes #### | Class Name | Description | |------------|------------------------| | `Q_FLEX` | Large LNG carrier | | `Q_MAX` | Very large LNG carrier | #### Container vessel size classes #### | Class Name | Description | |----------------|-------------------------------------------------| | `SMALL_FEEDER` | Very small regional ship | | `FEEDER` | Regional connector ship | | `FEEDERMAX` | Large regional feeder ship | | `PANAMAX` | Built to fit the original Panama Canal | | `POST_PANAMAX` | Larger than original Panama Canal limits | | `NEO_PANAMAX` | Built to fit the expanded Panama Canal locks | | `ULTRA_LARGE` | Ultra high capacity ships for major trade lanes | enum: - MINI_BULKER - SMALL_HANDY - HANDY - HANDYMAX - SUPRAMAX - ULTRAMAX - CAPESIZE - CHINAMAX - VALEMAX - GENERAL_PURPOSE - MEDIUM_RANGE - LR1 - LR2 - AFRAMAX - SUEZMAX - VLCC - ULCC - Q_FLEX - Q_MAX - SMALL_FEEDER - FEEDER - FEEDERMAX - PANAMAX - POST_PANAMAX - NEO_PANAMAX - ULTRA_LARGE WaterTransportContainerTypeCode: type: string minLength: 3 maxLength: 4 description: > ISO 6346 (https://en.wikipedia.org/wiki/ISO_6346) container size/type code. The code is mapped to one of three different container categories which each have different emissions intensities when transported on container vessels: - 20 foot containers. For example, *22G1* and *22G* map to this category. - 40 foot containers. For example, *42R1* maps to this category. - ISO tank containers. For example, *22T1* maps to this category. WaterTransportEnergyType: type: string description: > Specifies the type of energy that provides propulsion for the vessel. `MDO` Marine diesel oil Used by smaller commercial vessels, ferries, offshore ships, and most inland waterway vessels. `HFO` Heavy fuel oil Used mainly by large ocean going ships like container vessels, bulk carriers, and tankers on long routes. `VLSFO` Very low sulfur fuel oil Used by most modern deep sea vessels to meet IMO 2020 sulfur limits. If not provided, it is automatically defaulted based on: 1. The type of vessel. 2. The capacity of the vessel. 3. The region in which the voyage occurs. Different areas impose different sulfur-emission limits, which restrict which marine fuels can be legally used. enum: - HFO - VLSFO - MDO WaterTransportNavigationConstraints: type: array description: > List of navigation constraints specifying canals and passages to avoid when routing the voyage. Routes through any waterways listed here will never be used. Independently of these constraints, physical limits such as vessel size or draft may still prevent transit through certain waterways (e.g., ULCC supertankers cannot traverse the Suez Canal even if `AVOID_SUEZ_CANAL` is not specified). Default: [`AVOID_NORTHEAST_PASSAGE`, `AVOID_NORTHWEST_PASSAGE`] items: type: string description: >- `AVOID_SUEZ_CANAL` Avoid Suez canal Do not use the Suez Canal in the voyage. `AVOID_PANAMA_CANAL` Avoid Panama canal Do not use the Panama Canal in the voyage. `AVOID_KIEL_CANAL` Avoid Kiel canal Do not use the Kiel Canal in the voyage. `AVOID_CORINTH_CANAL` Avoid Corinth canal Do not use the Corinth Canal in the voyage. `AVOID_NORTHEAST_PASSAGE` Avoid Northeast Passage Do not route through the Arctic Ocean, along the northern coast of Russia to connect Europe and Asia. `AVOID_NORTHWEST_PASSAGE` Avoid Northwest Passage Do not route through the Arctic Ocean, along the northern coasts of Canada and Alaska to connect the Pacific with the Atlantic. enum: - AVOID_SUEZ_CANAL - AVOID_PANAMA_CANAL - AVOID_KIEL_CANAL - AVOID_CORINTH_CANAL - AVOID_NORTHEAST_PASSAGE - AVOID_NORTHWEST_PASSAGE RouteAirOperationResult: type: object title: Air operation required: - type - start - end - distanceKm properties: type: type: string enum: - AIR description: A flight between two airports. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: The distance of the flight in kilometers. vehicle: type: string description: > The system identifier of the aircraft used. Only included when a specific aircraft was requested; omitted when a generic aircraft class is used. icaoTypeDesignator: $ref: '#/components/schemas/FlightIcaoTypeDesignator' iataTypeDesignator: $ref: '#/components/schemas/FlightIataTypeDesignator' RouteRailOperationResult: type: object title: Rail operation required: - type - start - end - distanceKm properties: type: type: string enum: - RAIL description: >- A rail journey between two rail yards, or a roll-on/roll-off train crossing within a road operation. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: The distance of the rail journey in kilometers. route: type: string description: > An encoded polyline (Google Polyline Algorithm format) representing the full train route. It is only included when the request’s `options.includeRoutePolylines` is `TRUE`. RouteRoadOperationResult: type: object title: Road operation required: - type - start - end - distanceKm properties: type: type: string enum: - ROAD description: A road journey. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: >- The distance of the road journey in kilometers, including any sub-operations. route: type: string description: > An encoded polyline (Google Polyline Algorithm format) representing the full route, including any sub-operation segments. It is only included when the request’s `options.includeRoutePolylines` is `TRUE`. subOperations: type: array description: > The roll-on/roll-off ferry (`WATER`) and train (`RAIL`) crossings the vehicle takes on its journey, in order. Only included when the journey has such crossings. items: oneOf: - $ref: '#/components/schemas/RouteRailOperationResult' - $ref: '#/components/schemas/RouteSubWaterOperationResult' RouteWaterOperationResult: type: object title: Water operation required: - type - start - end - distanceKm - vehicle - capacityBand properties: type: type: string enum: - WATER description: A voyage between two harbors. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: The distance of the voyage in kilometers. vehicle: $ref: '#/components/schemas/WaterTransportResultVehicle' capacityBand: $ref: '#/components/schemas/WaterTransportResultCapacityBand' route: type: string description: > An encoded polyline (Google Polyline Algorithm format) representing the full route between harbors. It is only included when the request’s `options.includeRoutePolylines` is `TRUE`. LocationBase: title: Location type: object description: > Locations resolve either to a transport facility (airport, harbor, or rail yard) or to a general geographic area such as a building, street, postcode, or city. For larger areas, centroids are used to represent the approximate position. #### Identification and geocoding #### - Airports and harbors can be identified directly by code (`iataCode` for airports, `unLoCode` for harbors). - Otherwise, the location is geocoded based on the available address components, and if the `type` is not `PLACE`, the closest transport facility of the indicated type is selected. #### Geocoding priority #### When multiple data sources are provided, they are evaluated in the following order of preference: 1. Geographic coordinates (latitude and longitude) 2. IATA code (for non-airport locations) 3. Structured address components 4. UN/LOCODE (for non-harbor locations) 5. Unstructured address text Geocoding accuracy depends on the quality and completeness of the input. Structured addresses almost always yield better results and are tolerant of minor data-entry errors, such as postcodes appearing in street fields. For both structured and unstructured inputs, the most probable match is selected based on lexicographical similarity to known locations. #### Operational behavior #### When a transport facility is specified directly, it will be used regardless of any transport vehicle specified. The system does not enforce suitability constraints. For example, a large aircraft such as a Boeing 747-8F may be routed to Gibraltar International (LXGB) despite its short runways. If the airport were not explicitly chosen, the system would instead select a nearby suitable airport such as Málaga-Costa del Sol (AGP). Similarly, a container vessel may be routed to Plymouth (GBPLY) even though the port lacks container handling facilities. If the port were not specified explicitly, a capable alternative such as Southampton (GBSOU) would be selected automatically. required: - type properties: type: type: string description: > Defines the category of the location, distinguishing between transport facilities such as airports, harbors, and rail yards, and general places such as buildings, streets, postcodes, or cities. `PLACE` General place The location is resolved to a general geographic point such as a building, street, postcode area, or city, rather than to a transport facility. For transport modes other than road, first and last-mile routing will typically occur between this place and an automatically selected airport, harbor, or rail yard. `AIRPORT` Airport If an IATA code (`iataCode`) is provided, the corresponding airport is looked up directly. If a UN/LOCODE (`unLoCode`) is provided, it is resolved to its published coordinates, and the nearest eligible airport to that point is selected. Otherwise, the location is geocoded and matched to the nearest eligible airport - typically a commercial or regional airport of reasonable size, not a small private airstrip. For locations set to this type, there is no first or last-mile routing to or from the airport. Aircraft selection is unrestricted, even if the system deems the airport's runways unsuitable for the selected aircraft. This enables the explicit override of built-in runway suitability assessments, typically for cases where the aircraft is operating below its maximum payload or fuel capacity. `RAIL_YARD` Rail yard The location is geocoded and matched to the nearest rail facility or network connection point. If a UN/LOCODE (`unLoCode`) or IATA airport code (`iataCode`) is provided, it is resolved to coordinates, and the nearest rail facility or network connection to that point is selected. For locations set to this type, there is no first or last-mile routing to or from the rail yard. Rail yards are not identified by a specific code; to reference one directly, provide a structured address or geographic coordinates. `HARBOR` Harbor If a UN/LOCODE (`unLoCode`) is provided, the harbor is looked up directly. If an IATA airport code (`iataCode`) is provided, it is resolved to coordinates, and the nearest harbor to that point is selected. Otherwise, the location is geocoded and matched to the nearest harbor in the system. For locations set to this type, there is no first or last-mile routing to or from the harbor. Vessel selection is unrestricted, even if the system determines that the harbor cannot accommodate the vessel’s class or size. This enables the explicit override of built-in harbor capability constraints, typically for special operational circumstances such as partial-load, repositioning, or coastal operations. enum: - PLACE - AIRPORT - RAIL_YARD - HARBOR latitude: type: number format: double description: Latitude in decimal degrees (WGS 84 - EPSG:4326), range -90 to 90. longitude: type: number format: double description: >- Longitude in decimal degrees (WGS 84 - EPSG:4326), range -180 to 180. iataCode: type: string description: > Three-letter IATA airport code. Case-insensitive; normalized to uppercase, e.g., - `LAX` - `LHR` unLoCode: type: string description: > UN/LOCODE for the location. Accepts either a 3-letter (will be prefixed with the country code) or a full 5-letter code. Case-insensitive; normalized to uppercase. oneOf: - type: string description: | The full 5-character code, e.g., - `USNYC` - `FRPAR` minLength: 5 maxLength: 5 - type: string description: > 3-letter location code. Prefixed with the ISO 3166-1 alpha-2 country code derived from the `country` to build the full 5-character code, e.g., - `NYC` (paired with `US` to give `USNYC`) - `PAR` (paired with `FR` to give `FRPAR`) minLength: 3 maxLength: 3 street: type: string description: > Street name and number (if available), or the name of a recognized landmark for the location, e.g., - `1600 Pennsylvania Ave NW` - `Château de Versailles` - `Platz der Republik 1` postcode: type: string description: > Postal or ZIP code identifying the area of the location. Format varies by country, e.g., - `90210` *(Beverly Hills)* - `WC2N 5DU` *(Trafalgar Square)* city: type: string description: | City, town, or municipality where the location is situated, e.g., - `Berlin` - `Paris` - `New York` region: type: string description: > Administrative area (state/province/county/territory); optional, but can improve geocoding accuracy, e.g., - `Bretagne` - `Ontario` - `Bavaria` country: type: string description: > Country identifier. Accepts any of the following: - Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code, e.g.: - `US` *(United States)* - `FR` *(France)* - `DE` *(Germany)* - Three-letter [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code, e.g.: - `USA` *(United States)* - `FRA` *(France)* - `DEU` *(Germany)* - Three-digit [ISO 3166-1 numeric](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) country code, e.g.: - `840` *(United States)* - `250` *(France)* - `276` *(Germany)* - Full country name, including localized or alternative names in different languages and scripts. The examples below are only a small sample of the names that may be recognized for a country: - `Germany` *(English)* - `Deutschland` *(German)* - `Allemagne` *(French)* - `德国` or `德國` *(Chinese, simplified or traditional)* - `ألمانيا` *(Arabic)* address: type: string description: > Full unstructured address string containing the complete location as written (street/number, postcode, city, region). Commonly derived from shipping documents, customer records, or other unstructured data sources where the address was not captured in separate fields. Country need not be included - it will be appended automatically, e.g., - `1600 Pennsylvania Avenue NW Washington DC 20500` - `Platz der Republik 1 11011 Berlin` - `Calle de Bailén, s/n, 28071 Madrid` FlightIcaoTypeDesignator: type: string description: > ICAO type designator for the aircraft when available. This property is omitted if no ICAO code applies. | ICAO code | |-----------| | `A124` | | `A140` | | `A148` | | `A19N` | | `A20N` | | `A21N` | | `A306` | | `A30B` | | `A310` | | `A318` | | `A319` | | `A320` | | `A321` | | `A332` | | `A333` | | `A338` | | `A339` | | `A342` | | `A343` | | `A345` | | `A346` | | `A359` | | `A35K` | | `A388` | | `A748` | | `AEST` | | `AN24` | | `AN26` | | `AN28` | | `AN32` | | `AN72` | | `AT43` | | `AT44` | | `AT45` | | `AT46` | | `AT72` | | `AT73` | | `AT75` | | `AT76` | | `ATP` | | `B190` | | `B38M` | | `B39M` | | `B461` | | `B462` | | `B463` | | `B712` | | `B722` | | `B731` | | `B732` | | `B733` | | `B734` | | `B735` | | `B736` | | `B737` | | `B738` | | `B739` | | `B741` | | `B742` | | `B743` | | `B744` | | `B748` | | `B752` | | `B753` | | `B762` | | `B763` | | `B764` | | `B772` | | `B773` | | `B77L` | | `B77W` | | `B788` | | `B789` | | `B78X` | | `BCS1` | | `BCS3` | | `BELF` | | `BN2P` | | `C130` | | `C208` | | `C212` | | `C408` | | `CN35` | | `CRJ1` | | `CRJ2` | | `CRJ7` | | `CRJ9` | | `CRJX` | | `CVLT` | | `D228` | | `D328` | | `DC10` | | `DC3` | | `DC85` | | `DC86` | | `DC87` | | `DC91` | | `DC92` | | `DC93` | | `DC94` | | `DC95` | | `DH2T` | | `DH3T` | | `DH8A` | | `DH8B` | | `DH8C` | | `DH8D` | | `DHC2` | | `DHC3` | | `DHC6` | | `DHC7` | | `E110` | | `E120` | | `E135` | | `E145` | | `E170` | | `E190` | | `E195` | | `E290` | | `E295` | | `E75L` | | `F100` | | `F27` | | `F50` | | `F70` | | `FA20` | | `I114` | | `IL18` | | `IL76` | | `IL96` | | `J328` | | `JS31` | | `JS32` | | `JS41` | | `L188` | | `L410` | | `MA60` | | `MD11` | | `MD81` | | `MD82` | | `MD83` | | `MD87` | | `MD88` | | `MU2` | | `PA31` | | `PA32` | | `PA34` | | `PC12` | | `PC6T` | | `RJ1H` | | `RJ70` | | `RJ85` | | `SB20` | | `SC7` | | `SF34` | | `SH33` | | `SH36` | | `SU95` | | `SW2` | | `SW3` | | `SW4` | | `T204` | | `TRIS` | | `Y12` | | `YK40` | | `YK42` | FlightIataTypeDesignator: type: string description: > IATA aircraft type code when available. This property is omitted if no IATA code applies. | IATA code | |-----------| | `100` | | `141` | | `142` | | `143` | | `14X` | | `14Y` | | `14Z` | | `221` | | `223` | | `290` | | `295` | | `312` | | `313` | | `318` | | `319` | | `31N` | | `31X` | | `31Y` | | `320` | | `321` | | `32A` | | `32B` | | `32N` | | `32Q` | | `332` | | `333` | | `338` | | `339` | | `33X` | | `33Y` | | `342` | | `343` | | `345` | | `346` | | `351` | | `359` | | `380` | | `717` | | `72Y` | | `731` | | `732` | | `733` | | `734` | | `735` | | `736` | | `738` | | `739` | | `73C` | | `73E` | | `73G` | | `73H` | | `73J` | | `73K` | | `73P` | | `73R` | | `73W` | | `73X` | | `73Y` | | `742` | | `743` | | `744` | | `74H` | | `74N` | | `74T` | | `74U` | | `74X` | | `74Y` | | `752` | | `753` | | `75F` | | `75T` | | `75W` | | `762` | | `763` | | `764` | | `76T` | | `76W` | | `76X` | | `76Y` | | `772` | | `773` | | `77L` | | `77W` | | `77X` | | `781` | | `788` | | `789` | | `7F8` | | `7M8` | | `7M9` | | `A26` | | `A28` | | `A32` | | `A40` | | `A4F` | | `A81` | | `AB4` | | `AB6` | | `ABX` | | `ABY` | | `AN4` | | `AN7` | | `AR1` | | `AR7` | | `AR8` | | `AT4` | | `AT5` | | `AT7` | | `ATD` | | `ATF` | | `ATP` | | `ATR` | | `BEH` | | `BES` | | `BNI` | | `BNT` | | `CNC` | | `CNT` | | `CR1` | | `CR2` | | `CR7` | | `CR9` | | `CRA` | | `CRF` | | `CRK` | | `CS2` | | `CS5` | | `CVF` | | `D1Y` | | `D28` | | `D38` | | `D3F` | | `D8T` | | `D8X` | | `D8Y` | | `D91` | | `D92` | | `D93` | | `D94` | | `D95` | | `D9C` | | `D9X` | | `DF2` | | `DH1` | | `DH2` | | `DH3` | | `DH4` | | `DH7` | | `DHL` | | `DHP` | | `DHR` | | `DHS` | | `DHT` | | `E70` | | `E75` | | `E90` | | `E95` | | `EM2` | | `EMB` | | `ER3` | | `ER4` | | `ERD` | | `F27` | | `F50` | | `F5F` | | `F70` | | `FRJ` | | `HS7` | | `I14` | | `I93` | | `I9F` | | `I9M` | | `I9Y` | | `IL7` | | `IL8` | | `J31` | | `J32` | | `J41` | | `L4T` | | `LOF` | | `LOH` | | `M1F` | | `M81` | | `M82` | | `M83` | | `M87` | | `M88` | | `MA6` | | `MU2` | | `PA1` | | `PA2` | | `PL2` | | `PL6` | | `S20` | | `SF3` | | `SFF` | | `SH3` | | `SH6` | | `SHB` | | `SHS` | | `SU9` | | `SWM` | | `T20` | | `YK2` | | `YK4` | | `YN2` | RouteSubWaterOperationResult: type: object title: Ferry operation required: - type - start - end - distanceKm - vehicle - capacityBand properties: type: type: string enum: - WATER description: A roll-on/roll-off ferry crossing within a road operation. start: $ref: '#/components/schemas/ResponseLocation' end: $ref: '#/components/schemas/ResponseLocation' distanceKm: type: number format: double description: The distance of the ferry crossing in kilometers. vehicle: $ref: '#/components/schemas/SubWaterTransportResultVehicle' capacityBand: $ref: '#/components/schemas/SubWaterTransportResultCapacityBand' WaterTransportResultVehicle: type: string description: | The type of vessel used in the water transport operation. `CONTAINER` Container Transports standardized shipping containers. The default for `GENERAL` and `MANUFACTURED_PRODUCTS` cargo. `BULKER` Bulker Transports unpackaged bulk goods. The default for `BUILDING_MATERIALS`, `CEREALS`, `COAL_AND_STEEL` and `SOLID_CHEMICALS` cargo. `GENERAL_CARGO` General cargo Transports varied packaged or breakbulk goods. The fallback when candidate ports show no historical AIS activity for the requested type. `LIQUEFIED_GAS_TANKER` Liquefied gas tanker Specialized tanker for transporting liquefied gases like LNG or LPG at very low temperatures or under pressure within insulated tanks. The default for `LIQUEFIED_GAS` cargo. `OIL_TANKER` Oil tanker Tanker that taransport crude oil or refined petroleum products in segregated liquid cargo tanks. The default for `OIL` cargo. `CHEMICAL_TANKER` Chemical tanker Tanker equipped with segregated tanks to transport liquid chemicals. The default for `LIQUID_CHEMICALS` cargo. `OTHER_LIQUIDS_TANKER` Other liquids tanker Tanker that transports liquids outside the oil, gas, and regulated chemical categories such as wine, or fruit juices. `REFRIGERATED_BULKER` Refrigerated bulker Bulk carrier with cooling systems for perishable goods. The default for `REFRIGERATED_BULK` cargo. `AUTOMOBILE_CARRIER` Automobile carrier A roll-on/roll-off vessel that transports cars and other wheeled vehicles. The default for `AUTOMOBILES` cargo. enum: - CONTAINER - BULKER - GENERAL_CARGO - LIQUEFIED_GAS_TANKER - OIL_TANKER - CHEMICAL_TANKER - OTHER_LIQUIDS_TANKER - REFRIGERATED_BULKER - AUTOMOBILE_CARRIER WaterTransportResultCapacityBand: type: string description: > The vessel’s carrying-capacity category in bands measured by deadweight tonnage (DWT), cargo volume (CBM), gross tonnage (GT), or container vessel class. The measurement unit depends on the vessel type (`vehicle` property). `DWT_0_TO_999` 0 ≤ DWT < 1,000 Vessel with carrying capacity below 1,000 DWT. `DWT_0_TO_1999` 0 ≤ DWT < 2,000 Vessel with carrying capacity below 2,000 DWT. `DWT_0_TO_4999` 0 ≤ DWT < 5,000 Vessel with carrying capacity below 5,000 DWT. `DWT_0_TO_9999` 0 ≤ DWT < 10,000 Vessel with carrying capacity below 10,000 DWT. `DWT_2000_TO_4999` 2,000 ≤ DWT < 5,000 Vessel with carrying capacity between 2,000 and 4,999 DWT. `DWT_2000_TO_5999` 2,000 ≤ DWT < 6,000 Vessel with carrying capacity between 2,000 and 5,999 DWT. `DWT_5000_TO_9999` 5,000 ≤ DWT < 10,000 Vessel with carrying capacity between 5,000 and 9,999 DWT. `DWT_6000_TO_9999` 6,000 ≤ DWT < 10,000 Vessel with carrying capacity between 6,000 and 9,999 DWT. `DWT_10000_TO_14999` 10,000 ≤ DWT < 15,000 Vessel with carrying capacity between 10,000 and 14,999 DWT. `DWT_10000_TO_19999` 10,000 ≤ DWT < 20,000 Vessel with carrying capacity between 10,000 and 19,999 DWT. `DWT_10000_TO_34999` 10,000 ≤ DWT < 35,000 Vessel with carrying capacity between 10,000 and 34,999 DWT. `DWT_20000_TO_39999` 20,000 ≤ DWT < 40,000 Vessel with carrying capacity between 20,000 and 39,999 DWT. `DWT_20000_TO_59999` 20,000 ≤ DWT < 60,000 Vessel with carrying capacity between 20,000 and 59,999 DWT. `DWT_35000_TO_59999` 35,000 ≤ DWT < 60,000 Vessel with carrying capacity between 35,000 and 59,999 DWT. `DWT_60000_TO_79999` 60,000 ≤ DWT < 80,000 Vessel with carrying capacity between 60,000 and 79,999 DWT. `DWT_60000_TO_99999` 60,000 ≤ DWT < 100,000 Vessel with carrying capacity between 60,000 and 99,999 DWT. `DWT_80000_TO_119999` 80,000 ≤ DWT < 120,000 Vessel with carrying capacity between 80,000 and 119,999 DWT. `DWT_100000_TO_119999` 100,000 ≤ DWT < 120,000 Vessel with carrying capacity between 100,000 and 119,999 DWT. `DWT_120000_TO_199999` 120,000 ≤ DWT < 200,000 Vessel with carrying capacity between 120,000 and 199,999 DWT. `DWT_200000_TO_319999` 200,000 ≤ DWT < 320,000 Vessel with carrying capacity between 200,000 and 319,999 DWT. `DWT_1000_AND_ABOVE` DWT ≥ 1,000 Vessel with carrying capacity of 1,000 DWT or more. `DWT_10000_AND_ABOVE` DWT ≥ 10,000 Vessel with carrying capacity of 10,000 DWT or more. `DWT_15000_AND_ABOVE` DWT ≥ 15,000 Vessel with carrying capacity of 15,000 DWT or more. `DWT_20000_AND_ABOVE` DWT ≥ 20,000 Vessel with carrying capacity of 20,000 DWT or more. `DWT_40000_AND_ABOVE` DWT ≥ 40,000 Vessel with carrying capacity of 40,000 DWT or more. `DWT_200000_AND_ABOVE` DWT ≥ 200,000 Vessel with carrying capacity of 200,000 DWT or more. `DWT_320000_AND_ABOVE` DWT ≥ 320,000 Vessel with carrying capacity of 320,000 DWT or more. `CBM_0_TO_9999` 0 ≤ CBM < 10,000 Vessel with cargo volume capacity below 10,000 m³. `CBM_10000_TO_49999` 10,000 ≤ CBM < 50,000 Vessel with cargo volume capacity between 10,000 and 49,999 m³. `CBM_50000_TO_99999` 50,000 ≤ CBM < 100,000 Vessel with cargo volume capacity between 50,000 and 99,999 m³. `CBM_100000_TO_199999` 100,000 ≤ CBM < 200,000 Vessel with cargo volume capacity between 100,000 and 199,999 m³. `CBM_200000_AND_ABOVE` CBM ≥ 200,000 Vessel with cargo volume capacity of 200,000 m³ or more. `GT_0_TO_29999` 0 ≤ GT < 30,000 Vessel with gross tonnage below 30,000 GT. `GT_30000_TO_49999` 30,000 ≤ GT < 50,000 Vessel with gross tonnage between 30,000 and 49,999 GT. `GT_50000_AND_ABOVE` GT ≥ 50,000 Vessel with gross tonnage of 50,000 GT or more. `SMALL_FEEDER` Small feeder Small feeder container vessel with capacity up to 1,000 TEU. `FEEDER` Feeder Feeder container vessel typically carrying 1,001 to 2,000 TEU. `FEEDERMAX` Feedermax Upper-end feeder container vessel usually around 2,001 to 3,000 TEU. `PANAMAX` Panamax Container vessel sized to fit the original Panama Canal locks (3,001 to 5,100 TEU). `POST_PANAMAX` Poast panamax Larger container vessel exceeding original Panama Canal dimensions (5,101 to 10,000 TEU). `NEO_PANAMAX` Neopanamax Container vessel sized for the expanded Panama Canal (10,000 to 14,500 TEU). `ULTRA_LARGE` Ultra large Ultra large container vessel (ULCV), typically 14,501+ TEU. enum: - DWT_0_TO_999 - DWT_0_TO_1999 - DWT_0_TO_4999 - DWT_0_TO_9999 - DWT_2000_TO_4999 - DWT_2000_TO_5999 - DWT_5000_TO_9999 - DWT_6000_TO_9999 - DWT_10000_TO_14999 - DWT_10000_TO_19999 - DWT_10000_TO_34999 - DWT_20000_TO_39999 - DWT_20000_TO_59999 - DWT_35000_TO_59999 - DWT_60000_TO_79999 - DWT_60000_TO_99999 - DWT_80000_TO_119999 - DWT_100000_TO_119999 - DWT_120000_TO_199999 - DWT_200000_TO_319999 - DWT_1000_AND_ABOVE - DWT_10000_AND_ABOVE - DWT_15000_AND_ABOVE - DWT_20000_AND_ABOVE - DWT_40000_AND_ABOVE - DWT_200000_AND_ABOVE - DWT_320000_AND_ABOVE - CBM_0_TO_9999 - CBM_10000_TO_49999 - CBM_50000_TO_99999 - CBM_100000_TO_199999 - CBM_200000_AND_ABOVE - GT_0_TO_29999 - GT_30000_TO_49999 - GT_50000_AND_ABOVE - SMALL_FEEDER - FEEDER - FEEDERMAX - PANAMAX - POST_PANAMAX - NEO_PANAMAX - ULTRA_LARGE SubWaterTransportResultVehicle: type: string description: > The type of Roll-on/Roll-off ferry used in the sub-transport operation. `ROLL_ON_ROLL_OFF` Roll on/roll off A RO-RO freight ferry used within a parent road operation. `ROLL_ON_ROLL_OFF_PASSENGERS` Roll on/roll off passengers A RO-RO passenger ferry used within a parent road operation. enum: - ROLL_ON_ROLL_OFF - ROLL_ON_ROLL_OFF_PASSENGERS SubWaterTransportResultCapacityBand: type: string description: > The vessel’s carrying-capacity category in bands measured by deadweight tonnage (DWT), or gross tonnage (GT). The measurement unit depends on the vessel type (`vehicle` property). `DWT_0_TO_4999` 0 ≤ DWT < 5,000 Vessel with carrying capacity below 5,000 DWT. `DWT_5000_TO_9999` 5,000 ≤ DWT < 10,000 Vessel with carrying capacity between 5,000 and 9,999 DWT. `DWT_10000_TO_14999` 10,000 ≤ DWT < 15,000 Vessel with carrying capacity between 10,000 and 14,999 DWT. `DWT_15000_AND_ABOVE` DWT ≥ 15,000 Vessel with carrying capacity of 15,000 DWT or more. `GT_0_TO_1999` 0 ≤ GT < 2,000 Vessel with gross tonnage below 2,000 GT. `GT_5000_TO_9999` 5,000 ≤ GT < 10,000 Vessel with gross tonnage between 5,000 and 9,999 GT. `GT_10000_TO_19999` 10,000 ≤ GT < 20,000 Vessel with gross tonnage between 10,000 and 19,999 GT. `GT_20000_AND_ABOVE` GT ≥ 20,000 Vessel with gross tonnage of 20,000 GT or more. enum: - DWT_0_TO_4999 - DWT_5000_TO_9999 - DWT_10000_TO_14999 - DWT_15000_AND_ABOVE - GT_0_TO_1999 - GT_2000_TO_4999 - GT_5000_TO_9999 - GT_10000_TO_19999 - GT_20000_AND_ABOVE securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key for authenticating requests. Include this header in all calls. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.