EcoTransIT World REST-API Documentation
Document writing
| Version | Date | Writer | Modification |
|---|---|---|---|
| 1.0 | ---- | J. Büchter J. Grönig S. Nguyen | Document creation |
Foreword
This documentation contains the functional and technical description of the REST web service of the EcoTransIT World Business Solutions. The methodology is described in the general methodology report of EcoTransIT World and the methodology report appendix for the Business Solution.
Especially the methodology appendix should be read together with this manual.
You can get the methodology report and the appendix from the download portal of the EcoTransIT World Website
The REST-API uses the OpenApi specification. The OpenApi.yaml describing the specification can be downloaded from this website, or if you are already a customer from your swagger-ui instance.
To try out the REST-API or get further information about how to send a request and authenticate yourself see your instance of the swagger-ui located at:
https://your_url.ecotransit.org/swagger-ui/
(whereby “your_url” needs to be replaced by the customer server name)
Try out
If you want to test our REST-API please contact us to get access to our test servers!
1 Request Types
1.1 calculateTransport
This is the standard request for emission calculations. It covers most functionalities of EcoTransIT World. It supports the calculation of any kind of transport chain including configurable pre- and post-carriage. Every transport leg is defined within a transport chain element (tce) tag and a request can contain multiple tces. The calculateTransport request is the base for the calculation done by the CSV File Mass Calculation
1.2 calculateDistributionRequest (in Development - available soon)
This request enables the calculation of a round trip (milk run), the sections represent each leg of the round trip. The response includes the emissions per loaded or unloaded package at the respective location.
1.3 Informational requests
1.3.1 getVersion
This response of the getVersion request gives information about the modules and interfaces. It includes:
- EcoTransIT World Server (Calculation module) Version, Creation data
- Database (e.g. GIS-Data) Version, Creation data, Last update date
- Web service (Interface), Version, Build Timestamp
- Interface:
- Clean Cargo, year, customer type
- Logging service
- OAG flight data lookup
2 Detailed Request Description
2.1 Freight description
The freight description contains the amount and unit of the freight. Depending on the unit selection, additional t/TEU, t/FEU and container empty weight can be selected.
| Attribute | Values | Discription |
|---|---|---|
| amount | Number | Amount of the freight weight |
| unit | TONS (default) KILOGRAMS POUNDS TEU FEU PALLETS CUSTOM_UNIT | It defines the unit of the freight weight. |
| tonsPerTeu | 10 t/TEU default | Only applied if the freight unit is “TEU”. Used to calculate the freight weight within the containers. |
| tonsPerFeu | 20 t/FEU default | Only applied if the freight unit is “FEU”. Used to calculate the freight weight within the containers. |
| containerEmptyWeightInTons | 1,95 t for TEU default 3,9 t for FEU default | Applied to include the container empty weight into the calculation. |
| tonsPerPallet | 0,4 t for pallet | Only applied if the freight unit is “pallet”. Used to calculate the freight weight of a pallet |
{
"cargo": {
"unit": "TEU",
"amount": "1",
"tonsPerTeu":"10",
"containerEmptyWeightInTons":"5"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {}
}2.2 Selection of timetable period via transport date (transportDate)
The transport date can be specified with the attribute’s day, month and year.
Only applied for transport modes air or sea:
Highly recommended in air and sea transports to precise the time frame (routing variant ais-based, satellite-based and scheduled). The transport date defines the last date of the defined aggregation time period.
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
],
"settings": {}
}2.3 Location description
2.3.1 Location types
| Key | Value |
|---|---|
| ZIP_CODE | Postal code including country and postal code, e.g. DE 30161 |
| IATA_CODE | Airport code, e.g. CDG |
| UN_LOCODE | Location/ port code, e.g. NLRTM |
| UIC_CODE | Station code including country and station code e.g. 80 123456 |
| WGS84_COORDINATE | WGS84 coordinate as longitude and latitude, e.g. latitude: 59.123; longitude: 38.123 |
| NAME | Can be a city or district name for example. Use NAME with caution! (City) names are very ambiguous. It is strongly recommended to set country in addition to city name! Also prefer using ZipCodes for more reliable results. Avoid adding address and/or additional information to the city name, as that will cause an error. |
The user has the option to specify several locations in one request. EcoTransIT World verifies the entries one by one and selects the first valid entry for the calculation. The following example describes a list of origin locations with a iata code and a city name. If the iata code is invalid, the city name will be used for the calculation.
"origin": [
{
"locationType": "IATA_CODE",
"value": "ZZZ"
},
{
"locationType": "NAME",
"country": "DE",
"value": "Hannover"
}
]Examples are given for each location type.
{
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
]
}{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"carrierCode": "LH"
}
}
],
"settings": {}
}
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
]
}{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL"
}
}
],
"settings": {}
}
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "WGS84_COORDINATE",
"latitude": "52.38744103284499",
"longitude": "9.742968212295743"
}
],
"destination": [
{
"locationType": "WGS84_COORDINATE",
"latitude": "53.55011128252362",
"longitude": "10.004581042600458"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {}
}
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "NAME",
"country": "DE",
"value": "Hamburg"
}
],
"destination": [
{
"locationType": "NAME",
"country": "DE",
"value": "Berlin"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
]
}2.3.2 Locations with direct connections (directConnection)
| Key | Value |
|---|---|
| true | Disables the transfer point determination and the transport starts directly from the selected location. |
| false | Depending on the transport mode the location will be validated and perhaps changed via the EcoTransIT World internal transfer point determination (default) |
{
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539",
"directConnection": "true"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167",
"directConnection": "true"
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
]
}2.3.3 Maximum Distance for Road Feeder Service (maxRoadFeederServiceDistance)
The maximum road feeder distance defines a circle distance around the respective location. Within this circle all airports will be included as possible transfer points. If no airport is found, the closest suitable airport will be selected by EcoTransIT World.
| Key | Valid Values |
|---|---|
| maxRoadFeederServiceDistance | The maximum road feeder distance defines a circle distance around the respective location. Within this circle all airports will be included as possible transfer points. If no airport is found, the closest suitable airport will be selected by EcoTransIT World. |
{
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539",
"maxRoadFeederServiceDistance": {
"unit": "KILOMETER",
"value": "1000"
}
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167",
"maxRoadFeederServiceDistance": {
"unit": "KILOMETER",
"value": "1000"
}
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
]
}2.4 Energy composition (input)
ETW offers the possibility to define shares of different energy and production types. Energy compositions can be applied for road, rail, air and inland waterway shipments. Sea shipments are still under development. Logistic hubs have their own principle of energy composition and are excluded, too. Furthermore, energy composition cannot be combined with user specific calculations.
More details about the possible combinations can be found in the Methodology Appendix.
| Attribute | Possible values |
|---|---|
| transportMode | ROAD, RAIL, AIR, INLANDWATERS, not yet supported: SEA, LOGISTIC_HUB |
| type | eca, noneca (not yet supported; Allows the definition of the energy composition to be used in the ECA) |
| energyType | GASOLINE, BIO_ETHANOL, DIESEL, BIO_DIESEL, HVO, CNG, BIO_CNG , LNG, BIO_LNG, KEROSENE, BEV, ELECTRICITY, HYDROGEN, not yet supported: phev, HFO, MDO, ULSFO, BLENDS, LPG |
| productionType | FOSSIL, COUNTRY_MIX , MIX, RAPESEED_OIL, SOY_OIL, UCO , MAIZE, MANURE, BIO_WASTE , GREY_HYDROGEN, GREEN_HYDROGEN, YELLOW_HYDROGEN |
| share | Allowed values are 0 to 100 (The sum of all shares must be 100) |
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"energyComposition":
{
"shares": [
{
"energyType": "BIO_CNG",
"productionType": "MIX",
"share": {
"unit": "PERCENTAGE",
"value": 20
}
}
]
}
}
}
]
}2.5 Energy carriers (output)
ETW provides the total consumption per energy carrier and per section. Currently, the total consumption is only output for the ETW standard calculation. This means that neither country splits nor the user Specific calculations currently contain a customised output. In addition, the share of the respective energy carrier in the CO2e emissions is provided.
| energyType | productionType | unit |
|---|---|---|
| GASOLINE | FOSSIL | LITER |
| BIO_ETHANOL | MIX | LITER |
| DIESEL | FOSSIL | LITER |
| BIO_DIESEL | MIX, RAPESEED_OIL, SOY_OIL, UCO | LITER |
| HVO | MIX, RAPESEED_OIL, UCO | LITER |
| CNG | FOSSIL | KG |
| BIO_CNG | MIX, MAIZE, MANURE, BIOWASTE | KG |
| LNG | FOSSIL | KG |
| BIO_LNG | EUMIX, MAIZE, MANURE, BIO_WASTE | KG |
| HYDROGEN | GREY_HYDROGEN,GREEN_HYDROGEN,YELLOW_HYDROGEN | KWH |
| ELECTRICITY | COUNTRY_MIX | KWH |
| KEROSENE | FOSSIL | KG |
| HFO (FERRY) | FOSSIL | KG |
2.6 User-specific fuel consumption-, emission- and reduction factors
ETW enables the specification of individual fuel consumption, individual emissions, as well as the consideration of certificate-related emission reductions. All user specific values produce results that do not comply with the ETW standard methodology; therefore, these results are reported separately under the tag userSpecificEmissions.
In general, the user-specific values can be applied with all transport modes and via additional entries in different countries.
| Attribute | Possible values |
|---|---|
| transportMode | ROAD, RAIL, SEA, AIR, INLANDWATERS |
| COUNTRY | Country code (2 characters) An empty entry applies a global scope |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"userSpecificEmissions": {
"provisionPlusOperational":[
{
"country": "DE",
"emissionType": "CO2_EQUIVALENTS",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "100000"
}
]
}
}
}
],
"settings": {}2.6.1 Total emission factor (Well-to-Wheel)
ETW includes the possibility to specify individual emission values. The input values can only be specified as well-to-wheel (WTW) and are available for all transport modes. The following combinations of emission types and units are available for this purpose.
| emissionType | Unit |
|---|---|
| CO2_EQUIVALENTS | GRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE |
| NITROGEN_OXIDES | GRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE |
| NON_METHAN_HYDRO_CARBONS | GRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE |
| SULFUR_DIOXIDES | GRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE |
| PARTICLES | GRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"userSpecificEmissions": {
"provisionPlusOperational":[
{
"country": "DE",
"emissionType": "CO2_EQUIVALENTS",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "100000"
},
{
"country": "DE",
"emissionType": "NITROGEN_OXIDES",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "200000"
},
{
"country": "DE",
"emissionType": "NON_METHAN_HYDRO_CARBONS",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "300000"
},
{
"country": "DE",
"emissionType": "SULFUR_DIOXIDES",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "400000"
},
{
"country": "DE",
"emissionType": "PARTICLES",
"unit": "GRAMS_PER_MEGAJOULE",
"value": "500000"
}
]
}
}
}
],
"settings": {}
}2.6.2 Operational fuel consumption (Tank-to-Wheel)
ETW includes the possibility to specify individual fuel consumptions. The input values can only be specified as tank-to-wheel (TTW) and are only available for the transport modes truck and train. The user can specify the fuel consumption as follows:
| fuelType | unit |
|---|---|
| DIESEL | LITER_PER_100_KILOMETER LITER_PER_KILOMETER KILOGRAMS_PER_100_KILOMETER KILOGRAMS_PER_KILOMETER MEGAJOULE_PER_100_KILOMETER MEGAJOULE_PER_KILOMETER |
| CNG | KILOGRAMS_PER_100_KILOMETER KILOGRAMS_PER_KILOMETER MEGAJOULE_PER_100_KILOMETER MEGAJOULE_PER_KILOMETER |
| LNG | KILOGRAMS_PER_100_KILOMETER KILOGRAMS_PER_KILOMETER MEGAJOULE_PER_100_KILOMETER MEGAJOULE_PER_KILOMETER |
| ELECTRICITY | MEGAJOULE_PER_100_KILOMETER MEGAJOULE_PER_KILOMETER KILOWATT_HOURS_PER_100_KILOMETER KILOWATT_HOURS_PER_KILOMETER |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "135475"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "83",
"station": "083238"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"userSpecificEmissions": {
"operational":[
{
"country": "DE",
"fuelType": "ELECTRICITY",
"unit": "MEGAJOULE_PER_100_KILOMETER",
"value": "100"
}
]
}
}
}
],
"settings": {}
}2.6.3 Total emission reduction factor (Well-to-Wheel)
ETW offers the possibility to consider reduction factors (e.g. through certificates), through the totalEmissionReduction tag.
| emissionType | unit | value |
|---|---|---|
| CO2_EQUIVALENTS | PERCENTAGE | 0-100 (Percentage value by which the selected emissionType is to be reduced.) |
| NITROGEN_OXIDES | PERCENTAGE | 0-100 (Percentage value by which the selected emissionType is to be reduced.) |
| NON_METHAN_HYDRO_CARBONS | PERCENTAGE | 0-100 (Percentage value by which the selected emissionType is to be reduced.) |
| SULFUR_DIOXIDES | PERCENTAGE | 0-100 (Percentage value by which the selected emissionType is to be reduced.) |
| PARTICLES | PERCENTAGE | 0-100 (Percentage value by which the selected emissionType is to be reduced.) |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"userSpecificEmissions": {
"totalEmissionReduction":[
{
"country": "DE",
"emissionType": "CO2_EQUIVALENTS",
"unit": "PERCENTAGE",
"value": "50"
}
]
}
}
}
]
}2.7 Carriage description
It can be applied for preCarriage, mainCarriage and postCarriage.
{
"transportID": "testid",
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"virtualDistance": {
"unit": "KILOMETER",
"value": "250"
}
}
}
],
"settings": {}
}2.7.1 Virtual distance
It disables the routing and applies the given distance in meter. For truck transports the emission calculation for a motorway is assumed.
{
"transportID": "testid",
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"virtualDistance": {
"unit": "KILOMETER",
"value": "250"
}
}
}
],
"settings": {}
}
2.8 Cooled carriage
It activates the calculation considering that the freight needs to be cooled while the transport. It currently works for trucks, trains and seaship only. The tag has to be set in accounting.
| Key | Value |
|---|---|
| true | The transport carriage will be calculated with cooled freight as long as it is possible (only for trucks, container trains and Clean Cargo container ships). |
| False | The carriage is calculated without cooling (default). |
{
"transportID": "testid",
"accounting":{
"cooledTransport": "true"
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {}
}2.9 Optional user-specific information
The request can include additional optional information, which has no influence on the emission calculation.
The transportID attribute can contain any text string and will be stored in the LogViewer as shipment ID.
For additional Info via the customDescription tag any desired information can be defined and will be shown as given information in the response.
The user has the option to define an information attribute for defined sections. The content of the attribute will be given back at the respective section tag in the response.
{
"transportID": "testID123",
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"customDescription":{
"info1": "some info",
"info2": "another info"
}
}3 Transport Mode Description
3.1 Truck (Road)
{
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
]
}
3.1.1 Distance Adjustment Factor (distanceAdjustmentFactor)
The attribute can be used to increase the distance of a route percentual. The example would increase the distance of 10 percent.
| Key | Valid Values |
|---|---|
| distanceAdjustmentFactor | 0 – 100 |
Consider that the DAF increases the distance of all route details in the same (e.g. street types). The calculated CO2e intensity in the output includes enlarged distances by the DAF.
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"distanceAdjustmentFactor": {
"unit": "PERCENTAGE",
"value": "10"
}
}
}
],
"settings": {}
}
3.1.2 Truck types (truckType)
| Key | Value |
|---|---|
| CLASS_CAR | <3.5 t |
| CLASS_N1_I | Light commercial vehicle (LCV) N1 Class I <3.5 t |
| CLASS_N1_II | LCV N1 Class II <3.5 t |
| CLASS_N1_III | LCV N1 Class II <3.5 t |
| CLASS_7_5 | 3.5 - 7.5 t |
| CLASS_12 | 7.5 – 12 t |
| CLASS_20 | 12 – 20 t |
| CLASS_26 | 20 – 26 t |
| CLASS_40 | 26 – 40 t |
| CLASS_44 | 40 – 44 t |
| CLASS_50 | 44 – 50 t |
| CLASS_60 | 50 – 60 t |
| CLASS_GT_60 | > 60 t |
| CLASS_14KLBS_RIGID | <14 klbs, single unit |
| CLASS_19_5KLBS_RIGID | 14 klbs – 19.5 klbs, single unit |
| CLASS_33KLBS_RIGID | 19.5 klbs – 33 klbs, single unit |
| CLASS_33KLBS_ARTICULATED | 19.5 klbs – 33 klbs, articulated |
| CLASS_80KLBS_RIGID | 33 klbs –80 klbs, single unit |
| CLASS_80KLBS_ARTICULATED | 33 klbs – 80 klbs, articulated |
| CLASS_80KLBS_ARTICULATED_GLIDER | 33 klbs – 80 klbs, articulated (glider) |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckType": "CLASS_7_5"
}
}
],
"settings": {}
}
3.1.3 Utilisation (loadFactor and emptyTripFactor)
| Key | Valid Values |
|---|---|
| loadFactor | 0 – 100% |
| emptyTripFactor | > 0% |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"loadFactor": {
"unit": "PERCENTAGE",
"value": "35"
},
"emptyTripFactor": {
"unit": "PERCENTAGE",
"value": 80
}
}
}
],
"settings": {}
}
3.1.4 Emission classes (emissionClass)
For more information regarding data compatibility please also refer the methodology report and Business Solution methodology appendix.
| Key | Value |
|---|---|
| EU_EURO_1 | Emission class Euro 1 |
| EU_EURO_2 | Emission class Euro 2 |
| EU_EURO_3 | Emission class Euro 3 |
| EU_EURO_4 | Emission class Euro 4 |
| EU_EURO_5 | Emission class Euro 5 |
| EU_EURO_6 | Identical to Euro6ac |
| EU_EURO_6AC | Emission class Euro 6 A to C |
| EU_EURO_6DE | Emission class Euro 6 D to E |
| US_MOVES_1999 | Model years pre-1999 |
| US_MOVES_2000 | model years 1999-2000 |
| US_MOVES_2002 | model years 2001-2002 |
| US_MOVES_2006 | model years 2003-2006 |
| US_MOVES_2009 | model years 2007-2009 |
| US_MOVES_2013 | model years 2010-2013 |
| US_MOVES_2016 | model years 2014-2016 |
| US_MOVES_2020 | Model years 2017 and younger |
| US_MOVES_2023 | Model years 2021-2023 |
| JP_1994 | Emission class Japan 1994 |
| JP_1997 | Emission class Japan 1997 |
| JP_2003 | Emission class Japan 2003 |
| JP_2005 | Emission class Japan 2005 |
| JP_2009 | Emission class Japan 2009 |
| JP_2016 | Emission class Japan 2016 |
| UsEpa1994* | Emission class Epa 1994 |
| UsEpa1998* | Emission class Epa 1998 |
| UsEpa2004* | Emission class Epa 2004 |
| UsEpa2007* | Emission class Epa 2007 |
| UsEpa2010* | Emission class Epa 2010 |
*These emission classes will only be available until the release in January 2026. In case of BEV or FCEV as fuel type, the emission class will be ignored.
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"emissionClass": "EU_EURO_2"
}
}
],
"settings": {}
}
3.1.5 Vehicle empty weight (vehicleEmptyWeight)
It is defined in tonne [t] and cannot be higher than the maximum truck weight. The default values depend on the vehicle type.
| Key | Values |
|---|---|
| vehicleEmptyWeight | >0[t] |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DKCPH"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckWeight": {
"vehicleEmptyWeight":{
"unit": "TONS",
"value": 18
}
}
}
}
],
"settings": {}
}
3.1.6 Vehicle truck body (truckBodyType)
If the vehicle empty weight is not selected, the user can specify a truck body type. Depending on the vehicle type (truck size) a respective empty weight is selected automatically. The following truck body types can be selected:
| Key | Description |
|---|---|
| CURTAINSIDER | Curtain Sider Trailer |
| CARGO_BOX | Trailer with a fixed body (e.g. wood or metal) |
| COOLED_BOX | Cargo box with integrated cooling entity |
| TANK | Tanker truck (only class26 and class40) |
| CAR | Car transporter truck (only class20) |
| CONTAINER | Container chassis truck for a single TEU |
| CONTAINER_2TEU | Container chassis truck for two TEU or one FEU |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DKCPH"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckWeight": {
"truckBodyType": {
"value": "TANK"
}
}
}
}
],
"settings": {}
}
3.1.7 Ferry Routing (ferryRouting)
| Key | Value |
|---|---|
| PREFERRED | Ferry lines will be preferred to roads |
| NORMAL | Normal ferry consideration (default) |
| OBSTRUCT | Ferry lines will be avoided, roads are preferred |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DKCPH"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"ferryRouting": "OBSTRUCT"
}
}
],
"settings": {}
}
3.1.8 Engine type (fuelType)
The engine type of a truck is defined in ETW via the energy type of the respective engine. It can be defined within the energyComposition tag (see chapter 2.4 )
| Key | Value |
|---|---|
| DIESEL | Diesel engine fuel type (default) |
| CNG | CNG (Compressed Natural Gas) |
| LNG | LNG (Liquefied Natural Gas) |
| ELECTRICITY | BEV (Battery Electric Vehicle) |
| FCEV | FCEV (Fuel Cell Electric Vehicle) |
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"energyComposition":
{
"shares": [
{
"energyType": "BEV",
"productionType": "COUNTRY_MIX",
"share": {
"unit": "PERCENTAGE",
"value": 20
}
}
]
}
}
}
]
}3.1.9 Truck load (truckLoad)
| Key | Value |
|---|---|
| FTL | Full truck load |
| LTL | Less than truck load |
| FCL | Full container load |
| Auto | Automatic determination of FTL or LTL truck load |
To calculate LCL please calculate a part container on the base of the t/TEU or t/FEU (e.g. 50% of the container are 0.5 TEU).
FTL: shipment fills complete truck. LoadFactor is calculated as freight weight / Maximum Payload. If LoadFactor is greater than 100% LTL is assumed. LTL: combining multiple shipments from different customers into a single truck. loadFactorLTL is assumed as loadFactor.
{
"cargo": {
"unit": "TONS",
"amount": "15.6"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "22113"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckLoad":{
"value": "FTL"
}
}
}
],
"settings": {}
}
3.1.10 Default LTL load factor (loadFactorLTL)
Applied load factor for LTL truck load
| Key | Valid Values |
|---|---|
| loadFactorLTL | 0 – 100% (default 45%) |
{
"cargo": {
"unit": "TONS",
"amount": "15.6"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "22113"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckLoad":{
"value": "AUTO",
"parameters": {
"loadFactorLTL": 60
}
}
}
}
],
"settings": {}
}
3.1.11 Automatic truckload threshold (autoTresholdLoadFactor)
If the FTL calculation would determine a load factor below the threshold or above 100 percent, a LTL truck load will be applied with the corresponding load factor.
| Key | Valid Values |
|---|---|
| autoTresholdLoadFactor | 0 – 100% (default 50%) |
{
"cargo": {
"unit": "TONS",
"amount": "15.6"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "22113"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD",
"truckLoad":{
"value": "AUTO",
"parameters": {
"autoThresholdLoadFactor": 50,
"loadFactorLTL": 60
}
}
}
}
],
"settings": {}
}
3.1.12 Cooling type
Optional selection of the cooling type for truck transports. The following options are available:
| Key | Value |
|---|---|
| COOLED_BOX | CLASS_N1_III, CLASS_7_5, CLASS_12, CLASS_20, CLASS_26, CLASS_40, CLASS_44, CLASS_14KLBS_RIGID, CLASS_19_5KLBS_RIGID, CLASS_33KLBS_RIGID, CLASS_33KLBS_ARTICULATED, CLASS_80KLBS_RIGID, CLASS_80KLBS_ARTICULATED, CLASS_80KLBS_ARTICULATED_GLIDER |
| REEFER_UNREGULATED | CLASS_44, CLASS_50, CLASS_60, CLASS_GT_60 |
| REEFER_REGULATED | CLASS_44, CLASS_50, CLASS_60, CLASS_GT_60 |
| AUTO | Automatically selection (Default) |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting": {
"cooledTransport": true
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20539"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {}
}
3.2 Train (Rail)
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL"
}
}
],
"settings": {}
}
3.2.1 Distance Adjustment Factor (distanceAdjustmentFactor)
The attribute can be used to increase the distance of a route percentual. The example would increase the distance of 10 percent.
| Key | Valid Values |
|---|---|
| distanceAdjustmentFactor | 0 – 100 |
Consider that the DAF increases the distance of all route details in the same (e.g. street types). The calculated CO2e intensity in the output includes enlarged distances by the DAF.
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"distanceAdjustmentFactor": {
"unit": "PERCENTAGE",
"value": "10"
}
}
}
],
"settings": {}
}
3.2.2 Train weight (trainWeight)
| Key | Value |
|---|---|
| trainWeight | > 0 t |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"trainWeight": {
"unit": "TONS",
"value": "1"
}
}
}
],
"settings": {}
}
3.2.3 Utilisation (loadFactor and emptyTripFactor)
| Key | Valid Values |
|---|---|
| loadFactor | 0 – 100% |
| emptyTripFactor | > 0% |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"loadFactor": {
"unit": "PERCENTAGE",
"value": 50
},
"emptyTripFactor": {
"unit": "PERCENTAGE",
"value": 70
}
}
}
],
"settings": {}
}
3.2.4 Train types (trainType)
| Key | Value |
|---|---|
| none | Default train (1000t, LF 60%, ETF 50%) |
| LIGHT | Light train (500t, LF 60%, ETF 50%) |
| AVERAGE | (default) Average train (1000t, LF 60%, ETF 50%) |
| LARGE | Large train (1500t, LF 60%, ETF 50%) |
| EXTRA_LARGE | Extra-large train (2000t, LF 60%, ETF 50%) |
| HEAVY | Heavy train (5000t, LF 60%, ETF 50%) |
| CAR | Car train (700t, LF 85%, ETF 50%) |
| CHEMISTRY | Chemistry train (1200t, LF 100%, ETF 100%) |
| CONTAINER | Container train (1000t, LF 50%, ETF 20%) |
| CONTAINER_COOLED | Container train cooled (1000t, LF 50%, ETF 20%) |
| COAL_AND_STEEL | Coal and steel train (1700t, LF 100%, ETF 100%) |
| BUILDING_MATERIALS | Building materials train (1200t, LF 75%, ETF 60%) |
| MANUFACTURED_PRODUCTS | Manufactured products train (1200t, LF 75%, ETF 60%) |
| CEREALS | Cereals train (1300t, LF 100%, ETF 50%) |
| HIGHSPEED | Freight on a highspeed train (500t, LF 60%) |
| DOUBLE_STACK_CONTAINER | Double stack container train (1000t, LF 50%, ETF 20%) |
| ROLLING_ROAD | Rolling Road Train (1000t, LF 60%, ETF 50%) |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"trainType": "CONTAINER"
}
}
],
"settings": {}
}3.2.5 Drive Classes (tractionType)
| Key | Value |
|---|---|
| DIESEL | Train with diesel traction |
| ELECTRICAL | (default) Electrified train (electrified routes are preferred) |
| DIESEL_AS_ELECTRIC | Routing like diesel traction but calculated as electrified |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"tractionType": "DIESEL"
}
}
],
"settings": {}
}3.2.6 Particle filter (particleFilterType)
| Key | Value |
|---|---|
| STANDARD_FILTER | Diesel train with particle filter |
| NONE | (default) Diesel train without particle filter |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"particleFilterType": "STANDARD_FILTER"
}
}
],
"settings": {}
}3.2.7 Emission Classes (emissionClassRail)
The emission class of a train is applied if diesel as drive class is activated. This could also happen within automatically identified non-electrified tracks.
| Key | Value |
|---|---|
| EU_UIC_1 | UIC <= 2002 |
| EU_UIC_2 | UIC 2003-2008 |
| EU_STAGE_3A | EU 2009-20011 |
| EU_STAGE_3BV | EU >= 2012 |
| DB_2016 | Germany specific 2016 |
| EPA_NR | Non-regulated < 1973 |
| EPA_TIER_0 | US-EPA 1973-1992 |
| EPA_TIER_1 | US-EPA 1993-2004 |
| EPA_TIER_2 | US-EPA 2005-2011 |
| EPA_TIER_3 | US-EPA 2011-2014 |
| EPA_TIER_4 | US-EPA >= 2015 |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"tractionType": "DIESEL",
"emissionClass": "EU_UIC_1"
}
}
],
"settings": {}
}
3.2.8 Ferry Routing (ferryRouting)
| Key | Value |
|---|---|
| PREFERRED | Ferry lines will be preferred to roads |
| NORMAL | Normal ferry consideration |
| OBSTRUCT | Ferry lines will be avoided, roads are preferred |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"ferryRouting": "OBSTRUCT"
}
}
],
"settings": {}
}3.2.9 Rolling Road Parameter (rollingRoad)
The train type rolling road can have an additional parameter in a respective tag rollingRoad and additional attributes.
The following attributes can be applied:
| Key | Value |
|---|---|
| vehicleClass | Defines the type of vehicle which is carried on the rolling road. |
| loadFactor | Load factor of the applied vehicleClass (default 60%) |
Types of vehicles, which are placed on the train wagon:
| Key | Value |
|---|---|
| TRUCK | Complete truck incl. engine (default) |
| SEMI_TRAILER | Regular semi-trailer without engine |
| SWAP_BODY | Swap Body without engine |
| NIKRASA_SEMI_TRAILER | Nikrasa and comparable system |
{
"cargo": {
"unit": "TONS",
"amount": "100"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "10934"
}
],
"destination": [
{
"locationType": "UIC_CODE",
"country": "80",
"station": "145292"
}
]
},
"mainCarriage": {
"transportMode": "RAIL",
"rollingRoad":{
"vehicleClass": "SEMI_TRAILER",
"loadFactor":{
"unit": "PERCENTAGE",
"value": 35
}
}
}
}
],
"settings": {}
}3.3 Inland waterway vessel
{
"cargo": {
"unit": "TONS",
"amount": "20"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "ROCND"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DECGN"
}
]
},
"mainCarriage": {
"transportMode": "INLANDWATERS"
}
}
],
"settings": {}
}
3.3.1 Distance Adjustment Factor (distanceAdjustmentFactor)
The attribute can be used to increase the distance of a route percentual. The example would increase the distance of 10 percent.
| Key | Valid Values |
|---|---|
| distanceAdjustmentFactor | 0 – 100 |
Consider that the DAF increases the distance of all route details in the same (e.g. street types). The calculated CO2e intensity in the output includes enlarged distances by the DAF.
{
"cargo": {
"unit": "TONS",
"amount": "20"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "ROCND"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DECGN"
}
]
},
"mainCarriage": {
"transportMode": "INLANDWATERS",
"distanceAdjustmentFactor": {
"unit": "PERCENTAGE",
"value": "10"
}
}
}
],
"settings": {}
}3.3.2 Utilisation (loadFactor)
| Key | Value |
|---|---|
| loadFactor | 0 - 100% |
{
"cargo": {
"unit": "TONS",
"amount": "20"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "ROCND"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DECGN"
}
]
},
"mainCarriage": {
"transportMode": "INLANDWATERS",
"loadFactor":{
"unit": "PERCENTAGE",
"value": 50
}
}
}
],
"settings": {}
}3.3.3 Inland waterway vessel types (inlandVessel)
Following inland waterways vessel types are avaiable in the API
| Key | Value |
|---|---|
| IB_EU_BU | Euro ship bulk I-IV (0-1500t capacity) |
| IB_GR_BU | Large inland freight vessel bulk V (1500-3000t capacity) |
| IB_JO_BU | Jowi class bulk VI+ (>3000t capacity) |
| IB_EU_CT | Euro ship container I-IV (0-1500t capacity) |
| IB_GR_CT | Large inland freight vessel container V (1500-3000t capacity) |
| IB_JO_CT | Jowi class container VI+ (>3000t capacity) |
| IB_PC_2X2_BU | PushConvoi 2x2 bulk (approx. 11200t capacity) |
| IB_PC_2X2_CT | PushConvoi 2x2 container (approx. 11200t capacity) |
Class
The class is used to limit the selection of vessels to the respective category.
| Key | Value |
|---|---|
| CONTAINER | Container based inland waterway vessel |
| NON_CONTAINER | Bulk based inland waterway vessel |
{
"cargo": {
"unit": "TONS",
"amount": "20"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "ROCND"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DECGN"
}
]
},
"mainCarriage": {
"transportMode": "INLANDWATERS",
"inlandVessel":{
"type": "IB_GR_CT",
"class": "NON_CONTAINER"
}
}
}
],
"settings": {}
}3.3.4 Emission class (inlandWaterwaysEmissionStandard)
| Key | Value |
|---|---|
| CONV_1970_2002_US_TIER1 | Conventional (1970-2002) / US Tier 1 |
| CCNR1_2002_2006 | CCNR I (2002-2006) |
| CCNR2_EU3A_US_TIER2_2006 | CCNR II/ EU IIIA / US Tier 2 (>2006) |
| EPA_TIER3 | US Tier 3 |
| EPA_TIER4 | US Tier 4 |
| EU_V_GT2019 | EU V (>2019) |
{
"cargo": {
"unit": "TONS",
"amount": "20"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "ROCND"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DECGN"
}
]
},
"mainCarriage": {
"transportMode": "INLANDWATERS",
"inlandwatersEmissionStandard": "EU_V_GT2019"
}
}
],
"settings": {}
}3.4 Sea ship (Sea)
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
]
}3.4.1 Distance Adjustment Factor (distanceAdjustmentFactor)
The attribute can be used to increase the distance of a route percentual. The example would increase the distance of 10 percent.
| Key | Valid Values |
|---|---|
| distanceAdjustmentFactor | 0 – 100 |
Consider that the DAF increases the distance of all route details in the same (e.g. street types). The calculated CO2e intensity in the output includes enlarged distances by the DAF.
Please note: the distance adjustment factor overwrites the operational surcharge if this was specified within the Clean Cargo calculation.
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"distanceAdjustmentFactor": {
"unit": "PERCENTAGE",
"value": "10"
}
}
}
]
}3.4.2 Routing Variant (routingVariant)
The routing variant defines if the routing or the transfer point determination (port identification) shall be done based on ais-data, which reflects real vessel trips purchased from Alphaliner.
Since January 2025 the default routing variant is ais-based.
| Key | Value |
|---|---|
| AIS_BASED (default) | Routing and transfer point determination will be based on the ais-data of real vessel trips (see chapter 3.4.12 |
| NONE | Only the transfer point determination will be based on ais-data and the routing don’t use ais-based data |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "AIS_BASED"
}
}
]
}3.4.3 Direct Sailed routing (directSailed)
By activating the directSailed attribute the routing will be done direct (without any transhipment or port-call) from the origin to the destination.
| Key | Value |
|---|---|
| true | Disables the port-calls and transhipments. So the routing is done straight from and to the selected ports (origin and destination have to be a sea ports). |
| false | The routing can include port-calls or transhipments (default). |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"directSailed": "true"
}
}
]
}3.4.4 Utilisation (loadFactor)
| Key | Value |
|---|---|
| loadFactor | 0 - 100% |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"loadFactor":{
"unit": "PERCENTAGE",
"value": 50
}
}
}
]
}3.4.5 Speed Utilisation (speedUtilisation)
The speed utilisation reduces the usage of the ship engine which simulates a reduction of the ship speed. If the clean cargo methodology is activated, this value only affects the calculation of the exhaust emissions (NOx, SOx, NMHC, PM).
| Key | Value |
|---|---|
| speedUtilisation | 30 – 100% (default depends on sea ship type and trade lane) |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"speedUtilization":{
"unit": "PERCENTAGE",
"value": 50
}
}
}
]
}3.4.6 Sea vessel types (seaVessel)
| Key | Value | Cargo Type | Corresponding aggregation method |
|---|---|---|---|
| bc-gl-30 | BC Great Lakes Ship (<30k dwt) | BulkCarrier | tradelane |
| bc-ic-a-35 | BC Intra-continental (<35k dwt) | BulkCarrier | tradelane |
| bc-pa-a-80 | BC Panama trade (35-80k dwt) | BulkCarrier | tradelane |
| bc-ta-a-80 | BC Transatlantic trade (35-80k dwt) | BulkCarrier | tradelane |
| bc-tp-a-200 | BC Transpacific trade (35-200k dwt) | BulkCarrier | tradelane |
| bc-sz-200 | BC Suez trade (80-200k dwt) | BulkCarrier | tradelane |
| bc-og-a-120 | BC Other global trade (35-120k dwt) | BulkCarrier | tradelane |
| bc-world-avg | BC Global Average World | BulkCarrier | tradelane |
| roro-lt-5k | Roro small < 5k dwt | RoRoShip | tradelane |
| roro-gt-5k | Roro large >= 5k dwt | RoRoShip | tradelane |
| gc-co-d-5 | GC Coastal (<5k dwt) | BulkCarrier | tradelane |
| bc-fe-d-15 | GC/BC Feeder (5-15k dwt) | BulkCarrier | tradelane |
| bc-hs-d-35 | GC/BC Handysize (15-35k dwt) | BulkCarrier | tradelane |
| bc-hm-d-60 | BC Handymax (35-60k dwt) | BulkCarrier | tradelane |
| bc-pm-d-80 | BC Panamax (60-80k dwt) | BulkCarrier | tradelane |
| bc-am-d-120 | BC Adramax (80-120k dwt) | BulkCarrier | tradelane |
| bc-sm-d-200 | BC Suezmax (120-200k dwt) | BulkCarrier | tradelane |
| bc-fe-l-15 | T Feeder (5-15k dwt) | Liquid | tradelane |
| bc-hs-l-35 | T Handysize (15-35k dwt) | Liquid | tradelane |
| bc-hm-l-60 | T Handymax (35-60k dwt) | Liquid | tradelane |
| bc-pm-l-80 | T Panamax (60-80k dwt) | Liquid | tradelane |
| bc-am-l-120 | T Adramax (80-120k dwt) | Liquid | tradelane |
| bc-sm-l-200 | T Suezmax (120-200k dwt) | Liquid | tradelane |
| bc-vl-l-200 | T VLCC (>200k dwt) | Liquid | tradelane |
| cc-ic-eu-a-20 | CC Intra-continental EU (0,5-2k TEU) | Container | tradelane |
| cc-ic-a-35 | CC Intra-continental non EU (0,5-3,5k TEU) | Container | tradelane |
| cc-pa-a-47 | CC Panama Trade (2-4,7k TEU) | Container | tradelane |
| cc-ta-a-47 | CC Transatlantic trade (2-4,7k TEU) | Container | tradelane |
| cc-tp-a-70 | CC Transpacific trade (1-7k TEU) | Container | tradelane |
| cc-sz-a-70 | CC Suez trade (4,7-7k TEU) | Container | tradelane |
| cc-og-a-47 | CC Other global trade (1-4,7k TEU) | Container | tradelane |
| cc-fe-10 | CC Feeder (<1k TEU) | Container | tradelane |
| cc-hs-20 | CC Handysize (1-2k TEU) | Container | tradelane |
| cc-hm-35 | CC Handymax (2-3,5k TEU) | Container | tradelane |
| cc-pm-47 | CC Panamax (3,5-4,7k TEU) | Container | tradelane |
| cc-am-70 | CC Aframax (4,7-7k TEU) | Container | tradelane |
| cc-sm-145 | CC Suezmax (>7k TEU) | Container | tradelane |
| cc-sm-ulcv-145 | CC Ultra Large Vehicle Container (ULVC)(>14,5k TEU) | Container | tradelane |
| cc-world-avg | CC Global Average World | Container | tradelane |
| bc-0-10000 | Bulk carrier (0 – 10k dwt) | BulkCarrier | vessel size |
| bc-10000-35000 | Bulk carrier (10 – 35k dwt) | BulkCarrier | vessel size |
| bc-35000-60000 | Bulk carrier (35 – 60k dwt) | BulkCarrier | vessel size |
| bc-60000-100000 | Bulk carrier (60 – 100k dwt) | BulkCarrier | vessel size |
| bc-100000-200000 | Bulk carrier (100 – 200k dwt) | BulkCarrier | vessel size |
| bc-200000 | Bulk carrier (> 200k dwt) | BulkCarrier | vessel size |
| tc-0-5000 | Chemical tanker (0 – 5k dwt) | ChemicalTanker | vessel size |
| tc-5000-10000 | Chemical tanker (5 – 10k dwt) | ChemicalTanker | vessel size |
| tc-10000-20000 | Chemical tanker (10 – 20k dwt) | ChemicalTanker | vessel size |
| tc-20000-40000 | Chemical tanker (20 – 40k dwt) | ChemicalTanker | vessel size |
| tc-40000 | Chemical tanker (> 40k dwt) | ChemicalTanker | vessel size |
| cc-0-1000 | Container (0 – 1k TEU) | Container | vessel size |
| cc-1000-2000 | Container (1 – 2k TEU) | Container | vessel size |
| cc-2000-3000 | Container (2 – 3k TEU) | Container | vessel size |
| cc-3000-5000 | Container (3 – 5k TEU) | Container | vessel size |
| cc-5000-8000 | Container (5 – 8k TEU) | Container | vessel size |
| cc-8000-12000 | Container (8 – 12k TEU) | Container | vessel size |
| cc-12000-14500 | Container (12 – 14,5k TEU) | Container | vessel size |
| cc-14500-20000 | Container (14,5 – 20k TEU) | Container | vessel size |
| cc-20000 | Container (>20k TEU) | Container | vessel size |
| gc-0-5000 | General cargo (0 – 5k dwt) | GeneralCargo | vessel size |
| gc-5000-10000 | General cargo (5 - 10000 dwt) | GeneralCargo | vessel size |
| gc-10000-20000 | General cargo (10000 - 20000 dwt) | GeneralCargo | vessel size |
| gc-20000 | General cargo (20000+ dwt) | GeneralCargo | vessel size |
| tg-0-50000 | Liquefied gas tanker (0 – 50k cbm) | Liquid | vessel size |
| tg-50000-100000 | Liquefied gas tanker (50 – 100k cbm) | Liquid | vessel size |
| tg-100000-200000 | Liquefied gas tanker (100 – 200k cbm) | Liquid | vessel size |
| tg-200000 | Liquefied gas tanker (>200k cbm) | Liquid | vessel size |
| to-0-5000 | Oil tanker (0 – 5k dwt) | OilTanker | vessel size |
| to-5000-10000 | Oil tanker (5 – 10k dwt) | OilTanker | vessel size |
| to-10000-20000 | Oil tanker (10 – 20k dwt) | OilTanker | vessel size |
| to-20000-60000 | Oil tanker (20 – 60k dwt) | OilTanker | vessel size |
| to-60000-80000 | Oil tanker (60 – 80k dwt) | OilTanker | vessel size |
| to-80000-120000 | Oil tanker (80 – 120k dwt) | OilTanker | vessel size |
| to-120000-200000 | Oil tanker (120 – 200k dwt) | OilTanker | vessel size |
| to-200000 | Oil tanker (>200k dwt) | OilTanker | vessel size |
| tl-0-1000 | Other liquids tankers (0 – 1k dwt) | Liquid | vessel size |
| tl-1000 | Other liquids tankers (>1k dwt) | Liquid | vessel size |
| rp-0-2000 | Ferry-RoPax (0 – 2k gt) | Ferry | vessel size |
| rp-2000-5000 | Ferry-RoPax (2 – 5k gt) | Ferry | vessel size |
| rp-5000-10000 | Ferry-RoPax (5 – 10k gt) | Ferry | vessel size |
| rp-10000-20000 | Ferry-RoPax (10 – 20k gt) | Ferry | vessel size |
| rp-20000 | Ferry-RoPax (>20k gt) | Ferry | vessel size |
| br-0-2000 | Refrigerated bulk (0 – 2k dwt) | BulkCarrier | vessel size |
| br-2000-6000 | Refrigerated bulk (2 – 6k dwt) | BulkCarrier | vessel size |
| br-6000-10000 | Refrigerated bulk (6 – 10k dwt) | BulkCarrier | vessel size |
| br-10000 | Refrigerated bulk (>10k dwt) | BulkCarrier | vessel size |
| rr-0-5000 | Ro-Ro (0 – 5k dwt) | RoRo | vessel size |
| rr-5000-10000 | Ro-Ro (5 – 10k dwt) | RoRo | vessel size |
| rr-10000-15000 | Ro-Ro (10 – 15k dwt) | RoRo | vessel size |
| rr-15000 | Ro-Ro (>15k dwt) | RoRo | vessel size |
| rv-0-30000 | Vehicle (0 – 30k gt) | Vehicle | vessel size |
| rv-30000-50000 | Vehicle (30 – 50k gt) | Vehicle | vessel size |
| rv-50000 | Vehicle (>50k gt) | Vehicle | vessel size |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "NONE"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "NONE",
"seaVessel":{
"type": "bc-sz-200"
}
}
}
]
}3.4.7 Sea Vessel Class (seaVesselClass)
The SeaVessekClass is used to limit the selection of ships to the respective category. Please note that not all combinations are available depending on the aggregationMethodeSea. The categorisation can be found in section 3.4.7.
| Key | Description |
|---|---|
| BULK_CARRIER | Bulk carrier vessels |
| CHEMICAL_TANKER | Chemical tanker vessels |
| CONTAINER_VESSEL | Container vessels |
| GENERAL_CARGO_VESSEL | General Cargo vessels |
| LIQUID_TANKER | Liquid gas vessels |
| OIL_TANKER | Oil tanker vessels |
| FERRY | Ferry vessels |
| RORO_VESSEL | Roll-on Roll-off vessels |
| VEHICLE_CARRIER | Vehicle carrying vessels |
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "NONE"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "NONE",
"seaVessel":{
"class": {
"value": "CHEMICAL_TANKER"
}
}
}
}
]
}3.4.8 RoRo Vessel Class (vehicleClass)
The following vehicles can be applied for small and large RoRo ships.
| Key | Value |
|---|---|
| NONE | Only the gross weight of the freight is on the RoRo ship. |
| CLASS_3_5 | Gross weight is located on a 3.5t truck. |
| CLASS_7_5 | Gross weight is located on a 7.5t truck. |
| CLASS_12 | Gross weight is located on a 12t truck. |
| CLASS_20 | Gross weight is located on a 20t truck. |
| CLASS_26 | Gross weight is located on a 26t truck. |
| CLASS_40 | Gross weight is located on a 40t truck. (default) |
| CLASS_60 | Gross weight is located on a 60t truck. |
| TRAIN_STANDARD_WAGON | Gross weight is located on a standard train wagon. |
| TRAILER_ONLY | Gross weight is located on a truck trailer only (without machine). |
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "NONE"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "NONE",
"seaVessel":{
"class": {
"value": "RORO_VESSEL",
"vehicleClass": "CLASS_7_5"
}
}
}
}
]
}3.4.9 RoRo Vehicle Load Factor (sea ship)
Load factor in percentage of the respective transport mode. Allowed values are 0 to 100 (default is 60%).
{
"cargo": {
"unit": "TONS",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "NONE"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "NONE",
"seaVessel":{
"class": {
"value": "RORO_VESSEL",
"vehicleClass": "CLASS_7_5",
"loadFactor":{
"unit": "PERCENTAGE",
"value": 50
}
}
}
}
}
]
}3.4.10 Accounting variant (cleanCargoParameters)
The accounting variant defines whether the emissions are calculated based on the Clean Cargo methodology or the energy-based bottom-up approach.
The Clean Cargo methodology is recommended as default methodology for container vessels, and therefore activated by default (more specifically the Clean Cargo tradelane methodology). To select another clean cargo methodology (port pair, reefer, specific year) or to switch to the energy-based bottom-up approach the user must apply the accounting variant (for example "CLEAN_CARGO_PORTPAIR"). If this is not set in the request, the calculation will be done on the base of the Clean Cargo Methodology (Clean Cargo tradelane with the latest default year). To calculate using the ETW methododolgy, the accountingVariant tag needs to be set to “None”.
| Key | Value |
|---|---|
| NONE | Sea ship calculation on the base of the ETW methodology (comparable to the calculation at www.ecotransit.org and default) |
| CLEAN_CARGO_TRADELANE | Sea ship calculation on the base of the Clean Cargo tradelane emission intensities |
| CLEAN_CARGO_TRADELANE_REEFER | Sea ship calculation on the base of the Clean Cargo tradelane emission intensities as reefer container |
| CLEAN_CARGO_PORTPAIR | Sea ship calculation on the base of the Clean Cargo port-pair emission intensities (only available for Clean Cargo members) |
| CLEAN_CARGO_PORTPAIR_REEFER | Sea ship calculation on the base of the Clean Cargo port-pair emission intensities as reefer container (only available for Clean Cargo members) |
| cleanCargoTimeFrame | The attribute year is optional and defines the applied year of the Clean Cargo emission factors. If the year is not given by the user, the last available year is set as default value. If the requested year does not exist in the database, the calculation cannot be applied, and an error message is displayed in the response. |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2023"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
],
"settings": {}
}EcoTransIT World selects the Clean Cargo default values automatically, but it is also possible to define the carriage parameter user specific.
The following trade lane areas can be combined:
| Key | Emission Area |
|---|---|
| af | Africa |
| as | Asia South |
| an | Asia North |
| ci | Caribbean |
| eu | Europe |
| md | Mediterranean |
| ue | North America East Coast |
| uw | North America West Coast |
| mi | Middle East |
| oz | Oceania |
| other | Global Average |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"cleanCargoParameters": {
"tradeLane": "AF-OTHER"
}
}
}
],
"settings": {}
}In general, EcoTransIT World calculates on the base of the average trade lane values published by SFC/ Clean Cargo (gCO2e/TEUKMWTW). In addition, if individual trade lane emissions are available, these values can be adapted to the users' values or to the respective carriers which are defined by the standard carrier alpha code (SCAC).
The emission factors for a particular SCAC or company own tradelane or service lane have to be provided by the user itself. The following SCAC are available:
| Key | Value |
|---|---|
| xAVG | CCWG Average values (default) |
| APLU | APL |
| ARKU | Arkas Container Transport S.A. |
| CMDU DVRU CNCU | CMA CGM |
| COSU COEU | COSCO SHIPPING Lines Co., Ltd. |
| CMCU | Crowley |
| EGLV | Evergreen Marine Corp. Ltd. |
| HLCU UASU | Hapag-Lloyd |
| HDMU | Hyundai Merchant Marine Co., Ltd. |
| MAEU SUDU | Maersk |
| MATS | Matson Navigation Company, Inc |
| MCCQ | MCC Transport Pte. Ltd. |
| MSCU | Mediterranean Shipping Company (MSC) |
| ONEY KKLU NYKS MOLU | Ocean Network Express (ONE Line) |
| OOLU | OOCL USA Inc |
| UFEE | Unifeeder A/S |
| WHLU | Wan Hai Lines |
| YMLU | Yang Ming Marine Transport Corporation |
| ZIMU | Zim Integrated Shipping Services Ltd. (Zim Line) |
| 22AA | Wan Hai Lines |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"cleanCargoParameters": {
"scac": "xAVG"
}
}
}
],
"settings": {}
}Please consider that the Clean Cargo values are stated on the base of 100% container utilisation. However, for external publication Clean Cargo recommends using an average load factor of 70%, which is implemented in EcoTransIT World as default parameter for container ships.
Moreover, the Clean Cargo methodology suggests including an additional distance factor for operational derivations by increasing the distance of the sea leg by 15 percent. In EcoTransIT World, the default routing variant "ais-based" does not consider theadditional distance factor - the distance correction factor/ operational surcharge is therefore 0 percent. If the routing method “none” is activated, the distance factor is activated by default but can be deactivated by the respective attribute.
A more detailed description of the Clean Cargo Methodology is available in the Methodology Report Appendix for the Business Solutions.
3.4.11 Aggregation method (aggregationMethod)
The aggregationMethod parameter can be used to select whether the sea ship should be calculated using the aggregated trade lane classes or the vessel size.
| Key | Value |
|---|---|
| TRADELANE (default) | Emission calculation based on aggregated tradelane vessel classes |
| VESSEL_SIZE | Emission calculation based on the vessel size |
| VESSEL_PRECISE* | *This feature is not supported yet |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2023",
"aggregationMethod": "VESSEL_SIZE"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "NONE"
}
}
],
"settings": {}
}3.4.12 Sea ship calculation with AIS-based data (routingVariant)
This section describes how the new methodology for containerized sea ships can be activated. The background of the methodology is described in the Methodology Report Appendix for the Business Solutions.
The AIS-based calculation is activated by setting the attribute routingVariant to ais-based in the sea tag within the carriage description (see chapter 3.4.2).
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"routingVariant": "AIS_BASED"
}
}
],
"settings": {}
}3.4.13 Shipment parameter list (shipmentParamterList)
The shipment description can be defined within the carriageDescription (mainCarriage) through the primaryDataSettings. Please note that it is currently not possible to specify more than on shipment parameter per section with the routing variant ais-based. It defines the parameters per shipment (shipmentParameter).
The shipment parameter be aggregated to different filter types and can consist of these values:
| Key | Value |
|---|---|
| VESSEL | The trips of the routing are aggregate only to the given vessel. |
| SERVICE (default) | Based on a given IMO number or vessel name all trips of all vessels of the respective service are considered in the routing |
| CARRIER | Based on a given IMO number, vessel name or service id all trips of all vessels of the respective carrier are considered in the routing (can include also vessels from other services). |
| ALLIANCE | Based on a given IMO number, vessel name, service id or carrier all trips of all vessels of the respective alliance are considered in the routing (can include also vessels from other services and other carriers). |
The following example defines a sea leg which consists of all vessels sailing within the same container liner service (enabled via the attribute aggregateTo=”service”) of the defined vessel id (IMO vessel number).
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"primaryDataSettings":{
"timeFrame":{
"direction": "PAST",
"days": 30
},
"shipmentParameterList":[
{
"parameterType": "VESSEL",
"aggregateTo": "SERVICE",
"parameterList": [
{
"imo": "9811000"
},
{
"imo": "9321483"
}
]
},
{
"parameterType": "SERVICE",
"aggregateTo": "SERVICE",
"parameterList": [
{
"id": "1962"
}
]
}
]
}
}
}
],
"settings":{
"output":{
"infoLevel": "DETAILED"
}
}
}Realistic Route filter
The realistic route filter can be defined within the carriageDescription which is a sub-tag of the sea tag. Via the routeFilterParameter and sub-tags it is possible to filter additionally unrealistic trips out of the sailed vessel list between two seaports. A change of these parameters should be done carefully and only by experienced users. The attribute active in the realisticRouteFilter tag can be defined as:
| Key | Value |
|---|---|
| SHARE_BASED (default) | Enables the realistic rout filter in the ais-based routing. |
| NONE | Disables the filter and includes all possible vessel trips in the ais-based routing |
| Key | Value |
|---|---|
| minVesselTeu | minimum dead weight in TEU of the vessel |
| minVesselDwt | minimum dead weight in tons of the vessel |
| onlyServiceVessels | use only vessels that are part of a service |
A detailed description for all parameters is provided in the Methodology Report Appendix for the Business Solutions.
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "ZACPT"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"primaryDataSettings":{
"routeFilterParameter": {
"realisticRoutesFilter":{
"type": "SHARE_BASED"
},
"minVesselTeu": 2000
}
}
}
}
],
"settings":{
"output":{
"infoLevel": "DETAILED"
}
}
}3.5 Airplane (Air)
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
],
"settings": {}
}3.5.1 Distance Adjustment Factor (distanceAdjustmentFactor)
The attribute can be used to increase the distance of a route percentual. The example would increase the distance of 10 percent.
| Key | Valid Values |
|---|---|
| distanceAdjustmentFactor | 0 – 100 |
Consider that the DAF increases the distance of all route details in the same (e.g. street types). The calculated CO2e intensity in the output includes enlarged distances by the DAF.
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"distanceAdjustmentFactor": {
"unit": "PERCENTAGE",
"value": "10"
}
}
}
],
"settings": {}
}3.5.2 Routing Variant Air (routingVariant)
The routing variant defines if the routing or the transfer point determination (airport identification) shall be done based on satellite-data, which reflects real aircraft trips purchased from Skailark, or on scheduled data from the OAG.
Since January 2025 the default routing variant is satellite-based.
Please note that with the routing variants satellite-based and satellite-based-all-flights it is not possible to specify a flight number and an aircrafttype at the same time, currently.
| Key | Value |
|---|---|
| SATELLITE_BASED (default) | Routing and transfer point determination will be based on the satellite-data of real aircraft trips excluding those that have not transported any freight according to the Skailark model. |
| SATELLITE_BASED_ALL_FLIGHTS | Routing and transfer point determination will be based on the satellite-data of real aircraft trips |
| SCHEDULED | Routing and transfer point determination will be based on the scheduled flight plans of the OAG. |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"routingVariant": "SATELLITE_BASED"
}
}
],
"settings": {}
}3.5.3 Utilisation (loadFactor and passageUtilisation)
| Key | Value |
|---|---|
| freight | 0 – 100% (only applicable if a single aircraft is specified) |
| passenger | 0-100% (depends on flight distance class and plane type), only active for belly planes |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"routingVariant": "SCHEDULED",
"loadFactor":{
"freight":{
"unit": "PERCENTAGE",
"value": 53
},
"passenger":{
"unit": "PERCENTAGE",
"value": 56
}
}
}
}
],
"settings": {}
}3.5.4 Flight parameter
| Key | Value |
|---|---|
| carrierCode | Carrier code (e.g. LH or AF) |
| flightNumber | Flight number without leading zero (e.g. LH123) |
| directFlight | true or false (default), disables the air network routing and calculates a direct flight from the origin to the destination airport |
| considerRfiFactor | consider Radiative Forcing Index? default is false |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"carrierCode": "LH",
"considerRfiFactor": "true",
"directFlight": "false"
}
}
],
"settings": {}
}3.5.5 Aircraft Class (aircraft class)
This tab enables the restriction of the aircraft share to a certain type of aircrafts. By default, all types (belly freight and freighter) are considered together.
| Key | Value |
|---|---|
| BELLY_FREIGHT | Belly freighter aircraft type |
| FREIGHTER | Freighter aircraft type incl. Hybrid planes |
| ALL_CLASSES | ALL_CLASSES is equivalent to not specifying aircraftClass at all meaning that both FREIGHTER and BELLY_FREIGHT planes are taken into account. |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "FRA"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"routingVariant": "SATELLITE_BASED",
"aircraft": {
"class": "FREIGHTER"
}
}
}
],
"settings":{}
}3.5.6 Accounting Variant (accountingVariant)
Please note that the parameters are no longer defined within the air tag of the respective carriage, but globally as "airVariant" within the accountingVariant tag.
| Key | Value |
|---|---|
| NONE | Based on aggregated fuel consumptions from Small Emitters Tool |
| ICAO | Belly plane allocation on the base of ICAO/IATA methodology |
| SKAILARK | Based on detailed fuel consumptions from Skailark |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"accounting":{
"air":{
"variant": "ICAO"
}
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
],
"settings": {}
}3.5.7 Aircraft type (aircraft type)
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "FRA"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "LAX"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"routingVariant": "SATELLITE_BASED",
"aircraft": {
"type": "320",
"class": "FREIGHTER"
}
}
}
],
"settings":{
"output":{
"infoLevel": "DETAILED"
}
}
}| Key | Value | Type | Default for Hybrid |
|---|---|---|---|
| HybSH | Hybrid short haul | Hybrid | |
| HybMH | Hybrid medium haul | Hybrid | |
| HybLH | Hybrid long haul | Hybrid | |
| 100 | Fokker 100 | Belly-Freight | |
| 141 | BAe 146-100 Passenger | Belly-Freight | |
| 142 | BAe 146-200 Passenger | Belly-Freight | |
| 143 | BAe 146-300 Passenger | Belly-Freight | |
| 146 | BAe 146 Passenger | Belly-Freight | |
| 220 | Airbus A220 Passenger | Belly-Freight | |
| 221 | Airbus A220-100 | Belly-Freight | |
| 223 | Airbus A220-300 | Belly-Freight | |
| 290 | Embraer 190 E2 | Belly-Freight | |
| 295 | Embraer E195-E2 | Belly-Freight | |
| 310 | Airbus A310 Passenger | Belly-Freight | |
| 313 | Airbus A310-300 Passenger | Belly-Freight | |
| 318 | Airbus A318 | Belly-Freight | |
| 319 | Airbus A319 | Belly-Freight | |
| 320 | Airbus A320 | Belly-Freight | Medium Haul |
| 321 | Airbus A321 | Belly-Freight | |
| 330 | Airbus A330 | Belly-Freight | |
| 332 | Airbus A330-200 | Belly-Freight | |
| 333 | Airbus A330-300 | Belly-Freight | |
| 338 | Airbus A330-800neo | Belly-Freight | |
| 339 | Airbus A330-900neo | Belly-Freight | |
| 340 | Airbus A340 | Belly-Freight | |
| 342 | Airbus A340-200 | Belly-Freight | |
| 343 | Airbus A340-300 | Belly-Freight | |
| 345 | Airbus A340-500 | Belly-Freight | |
| 346 | Airbus A340-600 | Belly-Freight | |
| 350 | Airbus Industrie A350 | Belly-Freight | |
| 351 | Airbus A350-1000 | Belly-Freight | |
| 359 | Airbus Industrie A350-900 | Belly-Freight | |
| 380 | Airbus Industrie A380 Passenger | Belly-Freight | |
| 388 | Airbus A380-800 Passenger | Belly-Freight | |
| 717 | Boeing 717-200 | Belly-Freight | |
| 722 | Boeing 727-200 Passenger | Belly-Freight | |
| 727 | Boeing 727 | Belly-Freight | |
| 731 | Boeing 737-100 Passenger | Belly-Freight | |
| 732 | Boeing 737-200 Passenger | Belly-Freight | |
| 733 | Boeing 737-300 Passenger | Belly-Freight | |
| 734 | Boeing 737-400 Passenger | Belly-Freight | |
| 735 | Boeing 737-500 Passenger | Belly-Freight | |
| 736 | Boeing 737-600 Passenger | Belly-Freight | |
| 737 | Boeing 737 Passenger | Belly-Freight | |
| 738 | Boeing 737-800 Passenger | Belly-Freight | |
| 739 | Boeing 737-900 Passenger | Belly-Freight | |
| 742 | Boeing 747-200 (Passenger) | Belly-Freight | |
| 743 | Boeing 747-300/100/200 Sud | Belly-Freight | |
| 744 | Boeing 747-400 (Passenger) | Belly-Freight | Long haul |
| 747 | Boeing 747 (Passenger) | Belly-Freight | |
| 752 | Boeing 757-200 Passenger | Belly-Freight | |
| 753 | Boeing 757-300 Passenger | Belly-Freight | |
| 757 | Boeing 757 (Passenger) | Belly-Freight | |
| 762 | Boeing 767-200 Passenger | Belly-Freight | |
| 763 | Boeing 767-300 Passenger | Belly-Freight | |
| 764 | Boeing 767-400 Passenger | Belly-Freight | |
| 767 | Boeing 767 Passenger | Belly-Freight | |
| 772 | Boeing 777-200/200ER Passenger | Belly-Freight | |
| 773 | Boeing 777-300 Passenger | Belly-Freight | |
| 777 | Boeing 777 Passenger | Belly-Freight | |
| 781 | Boeing 787-10 | Belly-Freight | |
| 787 | Boeing 787 | Belly-Freight | |
| 788 | Boeing 787-8 | Belly-Freight | |
| 789 | Boeing 787-9 | Belly-Freight | |
| 919 | COMAC C919 | Belly-Freight | |
| 14F | BAe 146 (Freighter) | Freighter | |
| 14Y | BAE Systems 146-200 (Freighter) | Freighter | |
| 14Z | BAE Systems 146-300 (Freighter) | Freighter | |
| 31B | Airbus A319 (sharklets) | Belly-Freight | |
| 31F | Airbus A310F | Freighter | |
| 31N | Airbus A319neo | Belly-Freight | |
| 31Y | Airbus A310-300 Freighter | Freighter | |
| 32A | Airbus A320 (sharklets) | Belly-Freight | |
| 32B | Airbus Industrie A321 (Sharklets) | Belly-Freight | |
| 32N | Airbus A320neo | Belly-Freight | |
| 32Q | Airbus A321neo | Belly-Freight | |
| 32S | Airbus A318 /319 /320 /321 | Belly-Freight | |
| 32X | Airbus A321 (Freighter) | Freighter | |
| 33B | A330-700ST | Freighter | |
| 33F | Airbus A330 Freighter | Freighter | |
| 33X | Airbus A330-200 Freighter | Freighter | |
| 33Y | Airbus A330-300 Freighter | Freighter | |
| 3XL | A330-700L | Freighter | |
| 72F | Boeing 727 (Freighter) | Freighter | |
| 72S | Boeing 727-200 (Pax) | Belly-Freight | |
| 72Y | Boeing 727-200 (Freighter) | Freighter | |
| 73C | Boeing 737-300 (winglets) Passenger | Belly-Freight | |
| 73E | Boeing 737-500 (winglets) Passenger | Belly-Freight | |
| 73F | Boeing 737 (Freighter) | Freighter | |
| 73G | Boeing 737-700 Passenger | Belly-Freight | |
| 73H | Boeing 737-800 (winglets) Passenger | Belly-Freight | |
| 73J | Boeing 737-900 (winglets) Passenger | Belly-Freight | |
| 73K | Boeing 737-800 (wl) Freighter | Freighter | |
| 73L | Boeing 737-200 (Mixed Configuration) | Belly-Freight | |
| 73M | Boeing 737 (Mixed Configuration) | Belly-Freight | |
| 73N | Boeing 737-300 (Mixed Configuration) | Belly-Freight | |
| 73P | Boeing 737-400 (Freighter) | Freighter | |
| 73Q | Boeing 737-400 (Mixed Configuration) | Belly-Freight | |
| 73R | Boeing 737-700 (Mixed Configuration) | Belly-Freight | |
| 73S | Boeing 737 Advanced all Series | Belly-Freight | |
| 73T | B737-700(BDSF) | Freighter | Short haul |
| 73U | B737-800(BCF) Boeing 737-800 Freighter | Freighter | |
| 73W | Boeing 737-700 (winglets) Passenger | Belly-Freight | |
| 73X | Boeing 737-200 (Freighter) | Freighter | |
| 73Y | Boeing 737-300 (Freighter) | Freighter | |
| 74B | 747-400F | Freighter | |
| 74C | Boeing 747-200 Kombi | Belly-Freight | |
| 74E | Boeing 747-400 (Mixed Configuration) | Belly-Freight | |
| 74F | Boeing 747 (Freighter) | Freighter | |
| 74H | Boeing 747-8i Passenger | Belly-Freight | |
| 74L | Boeing 747SP Passenger | Belly-Freight | Long haul |
| 74M | Boeing 747 | Belly-Freight | |
| 74N | Boeing 747-8F (Freighter) | Freighter | |
| 74U | B747-300(SF) | Freighter | |
| 74X | Boeing 747-200 (Freighter) | Freighter | |
| 74Y | Boeing 747-400F (Freighter) | Freighter | |
| 75C | Boeing 757-200 Freighter | Freighter | |
| 75F | Boeing 757-200PF (Freighter) | Freighter | |
| 75M | 757-200PF -SF -PCF | Freighter | |
| 75T | Boeing 757-300 (winglets) Passenger | Belly-Freight | |
| 75V | Boeing 757-200 Freighter (winglets) | Freighter | Medium Haul |
| 75W | Boeing 757-200 (winglets) Passenger | Belly-Freight | |
| 76F | Boeing 767 Freighter | Freighter | |
| 76V | Boeing 767-300 (winglets) Freighter | Freighter | |
| 76W | Boeing 767-300 (winglets) Passenger | Belly-Freight | |
| 76X | Boeing 767-200 Freighter | Freighter | |
| 76Y | Boeing 767-300 Freighter | Freighter | |
| 77F | Boeing 777 Freighter | Freighter | |
| 77L | Boeing 777-200LR | Belly-Freight | |
| 77W | Boeing 777-300ER Passenger | Belly-Freight | |
| 77X | Boeing 777-200F Freighter | Freighter | |
| 7F8 | B737-800(BCF) | Freighter | |
| 7M7 | Boeing 737MAX 7 Passenger | Belly-Freight | |
| 7M8 | Boeing 737MAX 8 Passenger | Belly-Freight | |
| 7M9 | Boeing 737MAX 9 Passenger | Belly-Freight | |
| 7S8 | Boeing 737-800 (Scimitar Winglets) Pax | Belly-Freight | |
| A26 | Antonov An-26 | Belly-Freight | |
| A32 | Antonov An-32 | Belly-Freight | |
| A38 | Antonov AN-38 | Belly-Freight | |
| A40 | Antonov AN-140 | Belly-Freight | |
| A4F | Antonov AN-124 Ruslan | Freighter | |
| A58 | Antonov An-158 | Belly-Freight | |
| A81 | Antonov An148-100 | Belly-Freight | |
| AB3 | Airbus A300 Passenger | Belly-Freight | |
| AB4 | Airbus A300B2/B4/C4 | Belly-Freight | |
| AB6 | Airbus A300-600 Passenger | Belly-Freight | |
| ABB | A300-600ST | Freighter | |
| ABF | Airbus A300 (Freighter) | Freighter | |
| ABX | Airbus A300B4 /A300C4 /A300F4 | Belly-Freight | |
| ABY | Airbus A300-600 Freighter | Freighter | |
| AGH | Agusta A109 | Belly-Freight | |
| AN4 | Antonov AN-24 | Belly-Freight | |
| AN6 | Antonov AN-26 /30 /32 | Belly-Freight | |
| ANF | Antonov AN-12 | Freighter | |
| APF | BAe ATP(F) | Freighter | |
| AR1 | Avro RJ100 | Belly-Freight | |
| AR7 | ARJ70 | Belly-Freight | |
| AR8 | Avro RJ85 | Belly-Freight | |
| ARJ | Avro RJ70 /rj85 /rj100 | Belly-Freight | |
| AT4 | ATR 42-300 /320 | Belly-Freight | |
| AT5 | ATR 42-500 | Belly-Freight | |
| AT7 | ATR 72 | Belly-Freight | |
| ATF | ATR 72 (Freighter) | Freighter | |
| ATP | BAe ATP | Belly-Freight | |
| ATR | ATR42 /ATR72 | Belly-Freight | |
| ATX | ATR 42-300F (Freighter) | Freighter | |
| ATY | ATR 72-200F (Freighter) | Freighter | |
| ATZ | ATR 42 Freighter | Freighter | |
| AWH | AgustaWestland AW139 | Belly-Freight | |
| BE1 | Beechcraft 1900 Airliner | Belly-Freight | |
| BE2 | Beechcraft-Lght Acft-Twin Piston Engine | Belly-Freight | |
| BE4 | Hawker 400 Beechjet/400A/400XP/400T | Belly-Freight | |
| BE9 | Beechcraft C99 Airliner | Belly-Freight | |
| BEC | Beechcraft (Light Aircraft) | Belly-Freight | |
| BEF | Hawker Beechcraft 1900 (Freighter) | Freighter | |
| BEH | Beechcraft 1900D Airliner | Belly-Freight | |
| BES | Beechcraft 1900C Airliner | Belly-Freight | |
| BET | Beechcraft (Lght Acft - Twin Turboprop) | Belly-Freight | |
| BH2 | Bell (Helicopters) | Belly-Freight | |
| BNI | BN BN-2a/BN-2b Islander | Belly-Freight | |
| BNT | BN BN-2a Mk,iii Trislander | Belly-Freight | |
| C27 | COMAC ARJ21 | Belly-Freight | |
| CCJ | Canadair Challenger | Belly-Freight | |
| CJ8 | Cessna 680 Citation | Belly-Freight | |
| CN1 | Cessna Light Acft(single Piston Engine) | Belly-Freight | |
| CN2 | Cessna Light Acft (Twin piston engines) | Belly-Freight | |
| CNA | Cessna (Light Aircraft) | Belly-Freight | |
| CNC | Cessna Light Aircraft(Single Turboprop) | Belly-Freight | |
| CNF | Cessna 208b Freighter | Freighter | |
| CNJ | Cessna Citation | Belly-Freight | |
| CNT | Cessna Light Aircraft (Twin Turboprop | Belly-Freight | |
| CR1 | Canadair Regional Jet 100 | Belly-Freight | |
| CR2 | Canadair Regional Jet 200 | Belly-Freight | |
| CR5 | Canadair Regional Jet 550 | Belly-Freight | |
| CR7 | Canadair Regional Jet 700 | Belly-Freight | |
| CR9 | Canadair Regional Jet 900 | Belly-Freight | |
| CRA | Canadair CRJ Series 705 | Belly-Freight | |
| CRF | Canadair Regional Jet Freighter | Freighter | |
| CRJ | Canadair Regional Jet | Belly-Freight | |
| CRK | Canadair (Bombardier) Regional Jet 1000 | Belly-Freight | |
| CS1 | Bombardier CS100 | Belly-Freight | |
| CS2 | CASA C212 /Nusantara NC-212 Aviocar | Freighter | |
| CS3 | Bombardier CS300 | Belly-Freight | |
| CSF | SkyCourier 408F | Freighter | |
| CV5 | Convair 580 Passenger | Belly-Freight | |
| CVF | Convair 440 /580 /600 /640 (Freighter) | Freighter | |
| CVR | Convair 240 /440 /580 (Passenger) | Belly-Freight | |
| CVY | Convair 580/5800/600/640 (freighter) | Freighter | |
| CWC | Curtiss C-46 Commando | Freighter | |
| D10 | Boeing (Douglas) DC10 Passenger | Belly-Freight | |
| D1C | Boeing (douglas) DC10-30 /40 (Pax) | Belly-Freight | |
| D1F | Boeing (douglas) DC10 (Freighter) | Freighter | |
| D1X | MD-10-10(F) | Freighter | |
| D1Y | DC-10-30(F)/DC-10-40(F)/DC-10-30(F) | Freighter | |
| D28v | Fairchild Dornier 228 | Belly-Freight | |
| D38 | Fairchild Dornier 328-100 | Belly-Freight | |
| D3X | DHC-8-300(F) | Freighter | |
| D6F | Boeing (douglas) DC6A /B /C Freighter | Freighter | |
| D8F | Boeing (douglas) DC8 Freighter | Freighter | |
| D8X | Boeing (douglas) DC-8-61 /62 /63 Frtr | Freighter | |
| D93 | Boeing (Douglas) DC9-30 Passenger | Belly-Freight | |
| D95 | Boeing (Douglas) DC9-50 Passenger | Belly-Freight | |
| D9C | Boeing (Douglas) DC-9-30 Freighter | Freighter | |
| D9F | Boeing (Douglas) DC9 Freighter | Freighter | |
| D9X | Douglas DC-9-10 Frachter | Freighter | |
| DC3 | Boeing (Douglas) DC-3 | Belly-Freight | |
| DC8 | Boeing (Douglas) DC-8 Passenger | Belly-Freight | |
| DC9 | Boeing (douglas) DC-9 Passenger | Belly-Freight | |
| DH1 | De Havilland DHC-8-100 Dash 8 /8q | Belly-Freight | |
| DH2 | De Havilland DHC-8-200 Dash 8 /8q | Belly-Freight | |
| DH3 | De Havilland DHC-8-300 Dash 8 /8q | Belly-Freight | |
| DH4 | De Havilland DHC-8 Dash 8-400 Dash 8q | Belly-Freight | |
| DH7 | De Havilland DHC-7 Dash 7 | Belly-Freight | Short haul |
| DH8 | DHvilld-Bombardier DHC8 Dsh 8 | Belly-Freight | |
| DHB | DHvilld-Bombardier DHC2 Bvr/Tb Bvr | Belly-Freight | |
| DHC | DHvilld-Bombardier DHC4 Caribou | Belly-Freight | |
| DHL | De Havilland DHC-3 Turbo Otter | Belly-Freight | |
| DHP | DHvilld-Bombardier DHC2 Bvr | Belly-Freight | |
| DHS | DHvilld-Bombardier DHC3 Otter | Belly-Freight | |
| DHT | De Havilland DHC-6 Twin Otter | Belly-Freight | |
| E70 | Embraer 170 | Belly-Freight | |
| E75 | Embraer 175 | Belly-Freight | |
| E7W | Embraer 175 (Enhanced Winglets) | Belly-Freight | |
| E90 | Embraer 190 | Belly-Freight | |
| E95 | Embraer 195 | Belly-Freight | |
| EC3 | Eurocopter EC130/EC130T2 | Belly-Freight | |
| EM2 | Embraer 120 Brasilia | Belly-Freight | |
| EMB | Embraer 110 Bandeirante | Belly-Freight | |
| EMJ | Embraer 170/195 | Belly-Freight | |
| EP1 | Embraer EMB-500 Phenom 100 | Belly-Freight | |
| EP3 | Embraer EMB-505 Phenom 300 | Belly-Freight | |
| ER3 | Embraer RJ135 | Belly-Freight | |
| ER4 | Embraer RJ145 | Belly-Freight | |
| ERD | Embraer RJ140 | Belly-Freight | |
| ERJ | Embraer RJ 135/140/145 | Belly-Freight | |
| F27 | Fokker 27 | Belly-Freight | |
| F28 | Fokker F28 Fellowship | Belly-Freight | |
| F50 | Fokker 50 | Belly-Freight | |
| F5F | F50(F) | Freighter | |
| F70 | Fokker 70 | Belly-Freight | |
| FRJ | Fairchild Dornier 328jet | Belly-Freight | |
| GRJ | Gulfstream Aerospace G/stream 2/3/4/5/6 | Belly-Freight | |
| HS7 | BAe (HS) 748 | Belly-Freight | |
| I14 | Ilyushin IL114 | Belly-Freight | |
| I9F | Ilyushin IL96 Freighter | Freighter | |
| I9X | Ilyushin IL96-300 Freighter | Freighter | |
| I9Y | Ilyushin IL96T Freighter | Freighter | |
| IL6 | Il-62M | Belly-Freight | |
| IL7 | Ilyushin IL-76 | Freighter | |
| IL8 | Ilyushin IL-18 | Belly-Freight | |
| IL9 | Ilyushin Il-96 Passenger | Belly-Freight | |
| J31 | BAe Jetstream 31 | Belly-Freight | |
| J32 | BAe Jetstream 32 | Belly-Freight | |
| J41 | BAe Jetstream 41 | Belly-Freight | |
| L4T | Let 410 | Belly-Freight | |
| LOH | Lockheed L182 /l282 /l382 (L100) Hercul | Freighter | |
| M11 | Boeing (Douglas) MD-11 Passenger | Belly-Freight | |
| M1F | Boeing (douglas) MD-11 (Freighter) | Freighter | |
| M2F | MD-82(SF) | Freighter | |
| M3F | MD-83(SF) | Freighter | |
| M80 | Boeing (douglas) MD-80 | Belly-Freight | |
| M81 | Boeing (douglas) MD-81 | Belly-Freight | |
| M82 | Boeing (Douglas) MD-82 | Belly-Freight | |
| M83 | Boeing (Douglas) MD-83 | Belly-Freight | |
| M87 Boeing (Douglas) MD-87 | Belly-Freight | ||
| M88 Boeing (Douglas) MD-88 | Belly-Freight | ||
| M8F MD-88(SF) | Freighter | ||
| M90 Boeing (Douglas) MD-90 | Belly-Freight | ||
| MA6 Xian Yunshuji Ma-60 | Belly-Freight | ||
| MIH Mil MI-8 /MI-17 /MI-171 /MI-172 | Freighter | ||
| NDE Eurocopter Ecureuil AS350/As355 2 | Belly-Freight | ||
| NDH Aerospatiale SA365 Dauphin 2 | Belly-Freight | ||
| PA1 Piper (Light Aircraft - Single Piston) | Belly-Freight | ||
| PA2 Piper (Light Aircraft - Twin Piston) | Belly-Freight | ||
| PAG Piper (Light Aircraft) | Belly-Freight | ||
| PAT Piper (Light Aircraft - Twin Turboprop) | Belly-Freight | ||
| PL2 Pilatus PC-12 | Belly-Freight | ||
| PN6 Partenavia P.68 | Belly-Freight | ||
| S20 Saab 2000 | Belly-Freight | ||
| S76 Sikorsky S-76 | Belly-Freight | ||
| S9S SSJ 100/95SBJ | Belly-Freight | ||
| SF3 Saab 340 | Belly-Freight | ||
| SFB Saab 340B | Belly-Freight | ||
| SFF Saab 340 Freighter | Freighter | ||
| SH3 Shorts 330 (sd3-30) | Belly-Freight | ||
| SH6 Shorts 360 (sd3-60) | Belly-Freight | ||
| SU9 Sukhoi Superjet 100-95 | Belly-Freight | ||
| SWM Fairchild Sa26 /Sa226 /Sa227 Merlin /Me | Belly-Freight | ||
| T12 Tecnam P2012 Traveller | Belly-Freight | ||
| T20 Tupolev TU-204 /tu-214 | Belly-Freight | ||
| T2F TU-204-100CE | Freighter | ||
| TU3 Tupolev TU134 | Belly-Freight | ||
| TU5 Tupolev TU154 | Belly-Freight | ||
| YK2 Yakovlev Yak-42 /142 | Belly-Freight | ||
| YK4 Yakovlev Yak-40 | Belly-Freight | ||
| YN2 Harbin Yunshuji Y12 | Belly-Freight | ||
| YN7 Xian Yunshuji Y7/Ma60 | Belly-Freight |
3.6 Logistic Hubs
Logistic hubs can be warehouses, terminals, transhipment centres or similar.
A logistic hub can be included in the calculationComplexTransportRequest within a regular section. The user specific logistic hubs can be defined in the REff-Tool from Fraunhofer IML, see https://reff.iml.fraunhofer.de, and exported in an EcoTransIT World compatible format.
Figure 1: Export of the logistic sites data from the REff Tool developed by Fraunhofer IML.
EcoTransIT World offers to store this data on the customer’s server (data should be sent to support@ecotransit.org). You can then specify the id to use this data.
{
"cargo": {
"unit": "TONS",
"amount": "1000"
},
"transportChainElements": [
{
"elementType": "LOGISTIC_HUB",
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEDUI"
}
],
"energyConsumptions": [
{
"name": "Natural gas (heating)",
"valuePerTonne": 750,
"unit": "kWh"
},
{
"name": "Biodiesel",
"valuePerTonne": 1,
"unit": "l"
}
]
}
]
}Moreover, EcoTransIT World has default transportChainElements ids that can be requested by the user explicitly.
| id | Logistic Hub |
|---|---|
| 1 | Transhipment site, ambient |
| 2 | Transhipment site, mixed |
| 3 | Container terminal, dry |
| 4 | Container terminal, cooled |
| 5 | Bulk terminal, mixed |
A logistic hub can use the id-related values or directly defined values. The following attributes can be applied:
| Key | Value |
|---|---|
| id | Id of the logistic hubs as defined in the REff-Tool from Fraunhofer IML. This needs to be exported and sent to IVE. |
| LogisticHubParameters | List of parameters containing consumption parameters of the logistic sites |
As an alternative to specifying the id you can provide all parameters directly via this energyConsumptions List. When specifying the parameters directyl, the ID is not taken into account!
{
"cargo": {
"unit": "TONS",
"amount": "1000"
},
"transportChainElements": [
{
"elementType": "LOGISTIC_HUB",
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEDUI"
}
],
"id": 5,
"energyConsumptions": [
{
"name": "Natural gas (heating)",
"valuePerTonne": 750,
"unit": "kWh"
},
{
"name": "Diesel, 5% biodiesel blend",
"valuePerTonne": 1,
"unit": "l"
}
]
}
]
}3.7 Primary data settings
The primary data settings define how the third-party data for aviation and containerized sea vessels should be used for the calculation. Based on the identified trips different aggregation types with the flexible aggregation time frames can be defined.
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA",
"primaryDataSettings": {
"timeFrame":{
"direction": "PAST",
"days": 30
},
"aggregation": "SINGLE_TRIP"
}
}
}
],
"settings": {}
}3.7.1 Aggregation types
It is possible to select whether a share from all matching trips should be used or whether a single trip should be used for the calculation.
| Key | Describtion |
|---|---|
| SHARE (default) | The routing and emission calculations are based on all acceptable trips within the timeframe. Should be used by default if the aggregation of trips creates more robust calculation results. |
| SINGLE_TRIP | The routing and emission calculations are based on the closest in time single trip to the transport date. Should be used if a single vessel / aircraft shall on a single trip shall be calculated. |
3.7.2 Aggregation time frame
The aggregation time frame is the base of the consideration of trips into the calculation. The appliance of the trip aggregation is based on the specified transport data. Please consider that the arrival date (not departure!) of a trip is used for the inclusion within the aggregation time frame. This is particularly important for sea transports (ais-based), because the trips take much more time compared to aviation trips. The following timeframes can be selected:
| Value |
|---|
| 30days |
| 90days |
| 180days (default for satellite-based calculations) |
| 365days (default for ais-based calculations) |
Furthermore, it is possible to select whether the aggregation period should be before or after the provided transport date, or whether the transport date should be in the middle (balanced) of the period.
The attribute direction can have the following content:
| Key | Description |
|---|---|
| past | The specified timeframe is before the transport date (default) |
| balanced | The timeframe is evenly distributed around the transport date |
| future | The specified timeframe is after the transport date |
The aggregation direction “future” integrates also trips which were in the past. For this reason, the transport date must be at least half of the defined timeframe before the end of the last trip data.
{
"transportDate":{
"year": 2023,
"month": 12,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "IATA_CODE",
"value": "CDG"
}
]
},
"mainCarriage": {
"transportMode": "AIR",
"primaryDataSettings": {
"timeFrame":{
"direction": "PAST",
"days": 30
},
"aggregation": "SINGLE_TRIP"
}
}
}
],
"settings": {}
}4 Settings
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DETRV"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
],
"settings":{
"blockingList": {
"canals": ["KIEL"]
},
"output":{
"infoLevel": "DETAILED"
}
}
}4.1 Blocking canals (blockingList)
Individual canals can be excluded from routing for sea transports. This is possible for Suez canal, Panama canal and Kiel canal. This feature can be applied independently of the routing variant selected.
| Key | Description |
|---|---|
| SUEZ | Exclude Suez canal from routing. |
| PANAMA | Exclude Panama canal from routing. |
| KIEL | Exclude Kiel canal from routing. |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DETRV"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
],
"settings":{
"blockingList": {
"canals": ["KIEL"]
},
"output":{
"infoLevel": "DETAILED"
}
}
}4.2 Error Handling (errorHandling)
This block allows the user to set criteria regarding the assumptions done by the tool in case of wrong inputs. Several parameter lines can be provided.
| Key | Options |
|---|---|
| ERROR | Throw an Error and terminate calculation. |
| IGNORE | Ignores inconsistent or bad input and let EcoTransIT World make the most reasonable assumption to resolve the conflict and give a response with proper emissions |
| CUSTOM | Further define how EcoTransIT World should handle the problem by setting the "customValue" |
customValue
An example using the “Custom” option can be found below.
{
"cargo": {
"unit": "TONS",
"amount": "2"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "20500"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "DE",
"code": "30167"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings":{
"errorHandling":{
"PostalCodeNotFound": {
"option": "CUSTOM",
"customValue": "FindNumericalSimilar"
}
}
}
}4.3 Automatic transhipment detection
It is possible to activate the automatic detection and calculation of the emissions associated to transhipment activities. Although this is mandatory as per the ISO 14083, it is not calculated by default on the EcoTransIT World and has to be activated explicitly by the user.
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"accounting":{
"sea":{
"variant": "CLEAN_CARGO_TRADELANE",
"cleanCargoTimeFrame": "2022"
}
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DETRV"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
],
"settings": {
"automaticTranshipmentDetection":{
"handlingType": "CONTAINER",
"mode": "ALWAYS"
}
}
}The attributes mode can have the following content:
| Key | Describtion |
|---|---|
| DISABLED | Transhipments are not considered (default) |
| ALWAYS | All potential transhipments are considered |
| INTERMODALCHANGE | Only intermodal transhipments are considered |
handlingType
The attribute handlingType defines the freight type and is mandatory.
| Key | Describtion |
|---|---|
| DRY | Dry Bulk |
| LIQUID | Liquid Bulk |
| PIECE | Piece goods / Break Bulk |
| PALLET | Freight on pallets |
| CONTAINER | Freight in containers |
| RORO Vehicle | based Roll-On Roll-Off |
4.4 Disable usage of the alias table
Customers may create an alias table for locations via the location editor tool. To ignore the entries from the location editor set useLocationAliasTable to false.
| Key | Value |
|---|---|
| true | Enables the appliance of the alias table (default). |
| false | Disables the appliance of the alias table. |
{
"transportDate":{
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "IATA_CODE",
"value": "HAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "LAXYZ12"
}
]
},
"mainCarriage": {
"transportMode": "AIR"
}
}
],
"settings": {
"useLocationAliasTable": "false"
}
}4.5 Additional output
4.5.1 Export of the route as KML file
The service allows to create kml files for the defined transport services. If true, the response will include a Url to a KML file. The KML file will contain the route of the transport chain elements. The route can then be displayed for example in google earth. The shown routing is simplified, while for the calculation the proper routing has been used.
This feature can be activated by the output tag:
{
"transportDate": {
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "ES",
"code": "28001"
}
],
"destination": [
{
"locationType": "ZIP_CODE",
"country": "RU",
"code": "690000"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {
"output": {
"infoLevel": "DETAILED",
"createKml": true
}
}
}4.5.2 Country, rail traction and ECA area split (splitCarriage)
The split functionality enables the user to generate a more detailed output. Here, the emissions can be shown separately for each
• crossed country, e.g. if the border of a country is crossed or if the transport mode switches to ferry, ocean or aviation (country split) and/or • rail traction type, e.g. if the traction type switches from electrified to diesel traction (traction split) and/or • ECA area, e.g. if the leg is within an ECA area (ECA split).
| Key | Value | Description |
|---|---|---|
| frontiers | true or false | Splits the carriage when crossing country borders. |
| rail | true or false | Splits the carriage on railTraction change. For example if part of the track is not electrified. It is recommended to set this to true |
| sea | true or false | Splits the carriage when entering or leaving an ECA (Emission Control Area) |
Every change within one of the criteria creates an additional mainhaul leg in the XML response.
{
"transportDate": {
"year": 2022,
"month": 2,
"day": 20
},
"cargo": {
"unit": "TONS",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "ZIP_CODE",
"country": "ES",
"code": "28001"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "DKCPH"
}
]
},
"mainCarriage": {
"transportMode": "ROAD"
}
}
],
"settings": {
"output": {
"infoLevel": "DETAILED",
"splitCarriage": {
"frontiers": true,
"rail":false,
"sea": false
}
}
}
}4.5.3 Info (infoLevel)
In ETW it is possible to define the amount of additional information in the output.
| Key | Value |
|---|---|
| STANDARD | Minimal amount of information (default) |
| DETAILED | Output includes more details of the shipment descriptions and notifications of the level “INFO”. |
{
"cargo": {
"unit": "TEU",
"amount": "1"
},
"transportChainElements": [
{
"elementType": "TRANSPORT",
"route": {
"origin": [
{
"locationType": "UN_LOCODE",
"value": "DEHAM"
}
],
"destination": [
{
"locationType": "UN_LOCODE",
"value": "NLRTM"
}
]
},
"mainCarriage": {
"transportMode": "SEA"
}
}
],
"settings":{
"output":{
"infoLevel": "DETAILED"
}
}
}5 Output
The response of a calculation includes the following elements per section/transport chain element:
- Parameter information
- Optional: information tags like adapted zip code
- Output parameters always as provision (WTT), operational (TTW) and summarized value for
- Energy [MJ]
- CO2 [t]
- GHG-emissions as CO2eq [t]
- NOx [kg]
- NMHC [kg]
- SO2 [kg]
- PM [kg]
- Distance [km]
- Diesel Fuel Consumption (only for trucks) [l/100 km]
- Energy carriers (see chapter 2.5)
- TTW consumption per energy/production type
- Proportion of total CO2e WTW emissions
- Specific parameters
- Carbon Dioxide Equivalent [gCO2e/tkm]
- Carbon Dioxide [gCO2/tkm]
- Transport Performance [tkm]
- External Cost for
- NOx [Euro]
- NMHC [Euro]
- SO2 [Euro]
- PM [Euro]
- CO2eq [Euro]
- Accidents [Euro]
- Noise [Euro]
Note that the energy carriers are only given for the whole transport chain and are not applied to the user specific calculations or if the country split is activated.
For the whole transport chain:
- Cargo information
- Container Empty Weight
- Tonnes per TEU and FEU
- Freight Unit
- Freight Weight
- Additional general information (not needed for the calculation)