Last updated

EcoTransIT World REST-API Documentation

Document writing

VersionDateWriterModification
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)

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.

AttributeValuesDiscription
amountNumberAmount of the freight weight
unitTONS (default)
KILOGRAMS
POUNDS
TEU
FEU
PALLETS
CUSTOM_UNIT
It defines the unit of the freight weight.
tonsPerTeu10 t/TEU defaultOnly applied if the freight unit is “TEU”. Used to calculate the freight weight within the containers.
tonsPerFeu20 t/FEU defaultOnly applied if the freight unit is “FEU”. Used to calculate the freight weight within the containers.
containerEmptyWeightInTons1,95 t for TEU default
3,9 t for FEU default
Applied to include the container empty weight into the calculation.
tonsPerPallet0,4 t for palletOnly 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

KeyValue
ZIP_CODEPostal code including country and postal code, e.g. DE 30161
IATA_CODEAirport code, e.g. CDG
UN_LOCODELocation/ port code, e.g. NLRTM
UIC_CODEStation code including country and station code e.g. 80 123456
WGS84_COORDINATEWGS84 coordinate as longitude and latitude, e.g. latitude: 59.123; longitude: 38.123
NAMECan 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)

KeyValue
trueDisables the transfer point determination and the transport starts directly from the selected location.
falseDepending 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.

KeyValid Values
maxRoadFeederServiceDistanceThe 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.

AttributePossible values
transportModeROAD, RAIL, AIR, INLANDWATERS, not yet supported: SEA, LOGISTIC_HUB
typeeca, noneca (not yet supported; Allows the definition of the energy composition to be used in the ECA)
energyTypeGASOLINE, 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
productionTypeFOSSIL, COUNTRY_MIX , MIX, RAPESEED_OIL, SOY_OIL, UCO , MAIZE, MANURE, BIO_WASTE , GREY_HYDROGEN, GREEN_HYDROGEN, YELLOW_HYDROGEN
shareAllowed 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.

energyTypeproductionTypeunit
GASOLINEFOSSILLITER
BIO_ETHANOLMIXLITER
DIESELFOSSILLITER
BIO_DIESELMIX, RAPESEED_OIL, SOY_OIL, UCOLITER
HVOMIX, RAPESEED_OIL, UCOLITER
CNGFOSSILKG
BIO_CNGMIX, MAIZE, MANURE, BIOWASTEKG
LNGFOSSILKG
BIO_LNGEUMIX, MAIZE, MANURE, BIO_WASTEKG
HYDROGENGREY_HYDROGEN,GREEN_HYDROGEN,YELLOW_HYDROGENKWH
ELECTRICITYCOUNTRY_MIXKWH
KEROSENEFOSSILKG
HFO (FERRY)FOSSILKG

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.

AttributePossible values
transportModeROAD, RAIL, SEA, AIR, INLANDWATERS
COUNTRYCountry 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.

emissionTypeUnit
CO2_EQUIVALENTSGRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE
NITROGEN_OXIDESGRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE
NON_METHAN_HYDRO_CARBONSGRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE
SULFUR_DIOXIDESGRAMS_PER_MEGAJOULE, GRAMS_PER_TONNE_KILOMETERS, PERCENTAGE
PARTICLESGRAMS_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:

fuelTypeunit
DIESELLITER_PER_100_KILOMETER
LITER_PER_KILOMETER
KILOGRAMS_PER_100_KILOMETER
KILOGRAMS_PER_KILOMETER
MEGAJOULE_PER_100_KILOMETER
MEGAJOULE_PER_KILOMETER
CNGKILOGRAMS_PER_100_KILOMETER
KILOGRAMS_PER_KILOMETER
MEGAJOULE_PER_100_KILOMETER
MEGAJOULE_PER_KILOMETER
LNGKILOGRAMS_PER_100_KILOMETER
KILOGRAMS_PER_KILOMETER
MEGAJOULE_PER_100_KILOMETER
MEGAJOULE_PER_KILOMETER
ELECTRICITYMEGAJOULE_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.

emissionTypeunitvalue
CO2_EQUIVALENTSPERCENTAGE0-100 (Percentage value by which the selected emissionType is to be reduced.)
NITROGEN_OXIDESPERCENTAGE0-100 (Percentage value by which the selected emissionType is to be reduced.)
NON_METHAN_HYDRO_CARBONSPERCENTAGE0-100 (Percentage value by which the selected emissionType is to be reduced.)
SULFUR_DIOXIDESPERCENTAGE0-100 (Percentage value by which the selected emissionType is to be reduced.)
PARTICLESPERCENTAGE0-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.

KeyValue
trueThe transport carriage will be calculated with cooled freight as long as it is possible (only for trucks, container trains and Clean Cargo container ships).
FalseThe 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.

KeyValid Values
distanceAdjustmentFactor0 – 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)

KeyValue
CLASS_CAR<3.5 t
CLASS_N1_ILight commercial vehicle (LCV) N1 Class I <3.5 t
CLASS_N1_IILCV N1 Class II <3.5 t
CLASS_N1_IIILCV N1 Class II <3.5 t
CLASS_7_53.5 - 7.5 t
CLASS_127.5 – 12 t
CLASS_2012 – 20 t
CLASS_2620 – 26 t
CLASS_4026 – 40 t
CLASS_4440 – 44 t
CLASS_5044 – 50 t
CLASS_6050 – 60 t
CLASS_GT_60> 60 t
CLASS_14KLBS_RIGID<14 klbs, single unit
CLASS_19_5KLBS_RIGID14 klbs – 19.5 klbs, single unit
CLASS_33KLBS_RIGID19.5 klbs – 33 klbs, single unit
CLASS_33KLBS_ARTICULATED19.5 klbs – 33 klbs, articulated
CLASS_80KLBS_RIGID33 klbs –80 klbs, single unit
CLASS_80KLBS_ARTICULATED33 klbs – 80 klbs, articulated
CLASS_80KLBS_ARTICULATED_GLIDER33 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)

KeyValid Values
loadFactor0 – 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.

KeyValue
EU_EURO_1Emission class Euro 1
EU_EURO_2Emission class Euro 2
EU_EURO_3Emission class Euro 3
EU_EURO_4Emission class Euro 4
EU_EURO_5Emission class Euro 5
EU_EURO_6Identical to Euro6ac
EU_EURO_6ACEmission class Euro 6 A to C
EU_EURO_6DEEmission class Euro 6 D to E
US_MOVES_1999Model years pre-1999
US_MOVES_2000model years 1999-2000
US_MOVES_2002model years 2001-2002
US_MOVES_2006model years 2003-2006
US_MOVES_2009model years 2007-2009
US_MOVES_2013model years 2010-2013
US_MOVES_2016model years 2014-2016
US_MOVES_2020Model years 2017 and younger
US_MOVES_2023Model years 2021-2023
JP_1994Emission class Japan 1994
JP_1997Emission class Japan 1997
JP_2003Emission class Japan 2003
JP_2005Emission class Japan 2005
JP_2009Emission class Japan 2009
JP_2016Emission 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.

KeyValues
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:

KeyDescription
CURTAINSIDERCurtain Sider Trailer
CARGO_BOXTrailer with a fixed body (e.g. wood or metal)
COOLED_BOXCargo box with integrated cooling entity
TANKTanker truck (only class26 and class40)
CARCar transporter truck (only class20)
CONTAINERContainer chassis truck for a single TEU
CONTAINER_2TEUContainer chassis truck for two TEU or one FEU
*not avaiable for the moment
{
    "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)

KeyValue
PREFERREDFerry lines will be preferred to roads
NORMALNormal ferry consideration (default)
OBSTRUCTFerry 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 )

KeyValue
DIESELDiesel engine fuel type (default)
CNGCNG (Compressed Natural Gas)
LNGLNG (Liquefied Natural Gas)
ELECTRICITYBEV (Battery Electric Vehicle)
FCEVFCEV (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)

KeyValue
FTLFull truck load
LTLLess than truck load
FCLFull container load
AutoAutomatic 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

KeyValid Values
loadFactorLTL0 – 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.

KeyValid Values
autoTresholdLoadFactor0 – 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:

KeyValue
COOLED_BOXCLASS_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_UNREGULATEDCLASS_44, CLASS_50, CLASS_60, CLASS_GT_60
REEFER_REGULATEDCLASS_44, CLASS_50, CLASS_60, CLASS_GT_60
AUTOAutomatically 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.

KeyValid Values
distanceAdjustmentFactor0 – 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)

KeyValue
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)

KeyValid Values
loadFactor0 – 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)

KeyValue
noneDefault train (1000t, LF 60%, ETF 50%)
LIGHTLight train (500t, LF 60%, ETF 50%)
AVERAGE(default) Average train (1000t, LF 60%, ETF 50%)
LARGELarge train (1500t, LF 60%, ETF 50%)
EXTRA_LARGEExtra-large train (2000t, LF 60%, ETF 50%)
HEAVYHeavy train (5000t, LF 60%, ETF 50%)
CARCar train (700t, LF 85%, ETF 50%)
CHEMISTRYChemistry train (1200t, LF 100%, ETF 100%)
CONTAINERContainer train (1000t, LF 50%, ETF 20%)
CONTAINER_COOLEDContainer train cooled (1000t, LF 50%, ETF 20%)
COAL_AND_STEELCoal and steel train (1700t, LF 100%, ETF 100%)
BUILDING_MATERIALSBuilding materials train (1200t, LF 75%, ETF 60%)
MANUFACTURED_PRODUCTSManufactured products train (1200t, LF 75%, ETF 60%)
CEREALSCereals train (1300t, LF 100%, ETF 50%)
HIGHSPEEDFreight on a highspeed train (500t, LF 60%)
DOUBLE_STACK_CONTAINERDouble stack container train (1000t, LF 50%, ETF 20%)
ROLLING_ROADRolling 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)

KeyValue
DIESELTrain with diesel traction
ELECTRICAL(default) Electrified train (electrified routes are preferred)
DIESEL_AS_ELECTRICRouting 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)

KeyValue
STANDARD_FILTERDiesel 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.

KeyValue
EU_UIC_1UIC <= 2002
EU_UIC_2UIC 2003-2008
EU_STAGE_3AEU 2009-20011
EU_STAGE_3BVEU >= 2012
DB_2016Germany specific 2016
EPA_NRNon-regulated < 1973
EPA_TIER_0US-EPA 1973-1992
EPA_TIER_1US-EPA 1993-2004
EPA_TIER_2US-EPA 2005-2011
EPA_TIER_3US-EPA 2011-2014
EPA_TIER_4US-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)

KeyValue
PREFERREDFerry lines will be preferred to roads
NORMALNormal ferry consideration
OBSTRUCTFerry 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:

KeyValue
vehicleClassDefines the type of vehicle which is carried on the rolling road.
loadFactorLoad factor of the applied vehicleClass (default 60%)

Types of vehicles, which are placed on the train wagon:

KeyValue
TRUCKComplete truck incl. engine (default)
SEMI_TRAILERRegular semi-trailer without engine
SWAP_BODYSwap Body without engine
NIKRASA_SEMI_TRAILERNikrasa 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.

KeyValid Values
distanceAdjustmentFactor0 – 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)

KeyValue
loadFactor0 - 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

KeyValue
IB_EU_BUEuro ship bulk I-IV (0-1500t capacity)
IB_GR_BULarge inland freight vessel bulk V (1500-3000t capacity)
IB_JO_BUJowi class bulk VI+ (>3000t capacity)
IB_EU_CTEuro ship container I-IV (0-1500t capacity)
IB_GR_CTLarge inland freight vessel container V (1500-3000t capacity)
IB_JO_CTJowi class container VI+ (>3000t capacity)
IB_PC_2X2_BUPushConvoi 2x2 bulk (approx. 11200t capacity)
IB_PC_2X2_CTPushConvoi 2x2 container (approx. 11200t capacity)

Class

The class is used to limit the selection of vessels to the respective category.

KeyValue
CONTAINERContainer based inland waterway vessel
NON_CONTAINERBulk 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)

KeyValue
CONV_1970_2002_US_TIER1Conventional (1970-2002) / US Tier 1
CCNR1_2002_2006CCNR I (2002-2006)
CCNR2_EU3A_US_TIER2_2006CCNR II/ EU IIIA / US Tier 2 (>2006)
EPA_TIER3US Tier 3
EPA_TIER4US Tier 4
EU_V_GT2019EU 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.

KeyValid Values
distanceAdjustmentFactor0 – 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.

KeyValue
AIS_BASED (default)Routing and transfer point determination will be based on the ais-data of real vessel trips (see chapter 3.4.12
NONEOnly 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.

KeyValue
trueDisables 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).
falseThe 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)

KeyValue
loadFactor0 - 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).

KeyValue
speedUtilisation30 – 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)

KeyValueCargo TypeCorresponding aggregation method
bc-gl-30BC Great Lakes Ship (<30k dwt)BulkCarriertradelane
bc-ic-a-35BC Intra-continental (<35k dwt)BulkCarriertradelane
bc-pa-a-80BC Panama trade (35-80k dwt)BulkCarriertradelane
bc-ta-a-80BC Transatlantic trade (35-80k dwt)BulkCarriertradelane
bc-tp-a-200BC Transpacific trade (35-200k dwt)BulkCarriertradelane
bc-sz-200BC Suez trade (80-200k dwt)BulkCarriertradelane
bc-og-a-120BC Other global trade (35-120k dwt)BulkCarriertradelane
bc-world-avgBC Global Average WorldBulkCarriertradelane
roro-lt-5kRoro small < 5k dwtRoRoShiptradelane
roro-gt-5kRoro large >= 5k dwtRoRoShiptradelane
gc-co-d-5GC Coastal (<5k dwt)BulkCarriertradelane
bc-fe-d-15GC/BC Feeder (5-15k dwt)BulkCarriertradelane
bc-hs-d-35GC/BC Handysize (15-35k dwt)BulkCarriertradelane
bc-hm-d-60BC Handymax (35-60k dwt)BulkCarriertradelane
bc-pm-d-80BC Panamax (60-80k dwt)BulkCarriertradelane
bc-am-d-120BC Adramax (80-120k dwt)BulkCarriertradelane
bc-sm-d-200BC Suezmax (120-200k dwt)BulkCarriertradelane
bc-fe-l-15T Feeder (5-15k dwt)Liquidtradelane
bc-hs-l-35T Handysize (15-35k dwt)Liquidtradelane
bc-hm-l-60T Handymax (35-60k dwt)Liquidtradelane
bc-pm-l-80T Panamax (60-80k dwt)Liquidtradelane
bc-am-l-120T Adramax (80-120k dwt)Liquidtradelane
bc-sm-l-200T Suezmax (120-200k dwt)Liquidtradelane
bc-vl-l-200T VLCC (>200k dwt)Liquidtradelane
cc-ic-eu-a-20CC Intra-continental EU (0,5-2k TEU)Containertradelane
cc-ic-a-35CC Intra-continental non EU (0,5-3,5k TEU)Containertradelane
cc-pa-a-47CC Panama Trade (2-4,7k TEU)Containertradelane
cc-ta-a-47CC Transatlantic trade (2-4,7k TEU)Containertradelane
cc-tp-a-70CC Transpacific trade (1-7k TEU)Containertradelane
cc-sz-a-70CC Suez trade (4,7-7k TEU)Containertradelane
cc-og-a-47CC Other global trade (1-4,7k TEU)Containertradelane
cc-fe-10CC Feeder (<1k TEU)Containertradelane
cc-hs-20CC Handysize (1-2k TEU)Containertradelane
cc-hm-35CC Handymax (2-3,5k TEU)Containertradelane
cc-pm-47CC Panamax (3,5-4,7k TEU)Containertradelane
cc-am-70CC Aframax (4,7-7k TEU)Containertradelane
cc-sm-145CC Suezmax (>7k TEU)Containertradelane
cc-sm-ulcv-145CC Ultra Large Vehicle Container (ULVC)(>14,5k TEU)Containertradelane
cc-world-avgCC Global Average WorldContainertradelane
bc-0-10000Bulk carrier (0 – 10k dwt)BulkCarriervessel size
bc-10000-35000Bulk carrier (10 – 35k dwt)BulkCarriervessel size
bc-35000-60000Bulk carrier (35 – 60k dwt)BulkCarriervessel size
bc-60000-100000Bulk carrier (60 – 100k dwt)BulkCarriervessel size
bc-100000-200000Bulk carrier (100 – 200k dwt)BulkCarriervessel size
bc-200000Bulk carrier (> 200k dwt)BulkCarriervessel size
tc-0-5000Chemical tanker (0 – 5k dwt)ChemicalTankervessel size
tc-5000-10000Chemical tanker (5 – 10k dwt)ChemicalTankervessel size
tc-10000-20000Chemical tanker (10 – 20k dwt)ChemicalTankervessel size
tc-20000-40000Chemical tanker (20 – 40k dwt)ChemicalTankervessel size
tc-40000Chemical tanker (> 40k dwt)ChemicalTankervessel size
cc-0-1000Container (0 – 1k TEU)Containervessel size
cc-1000-2000Container (1 – 2k TEU)Containervessel size
cc-2000-3000Container (2 – 3k TEU)Containervessel size
cc-3000-5000Container (3 – 5k TEU)Containervessel size
cc-5000-8000Container (5 – 8k TEU)Containervessel size
cc-8000-12000Container (8 – 12k TEU)Containervessel size
cc-12000-14500Container (12 – 14,5k TEU)Containervessel size
cc-14500-20000Container (14,5 – 20k TEU)Containervessel size
cc-20000Container (>20k TEU)Containervessel size
gc-0-5000General cargo (0 – 5k dwt)GeneralCargovessel size
gc-5000-10000General cargo (5 - 10000 dwt)GeneralCargovessel size
gc-10000-20000General cargo (10000 - 20000 dwt)GeneralCargovessel size
gc-20000General cargo (20000+ dwt)GeneralCargovessel size
tg-0-50000Liquefied gas tanker (0 – 50k cbm)Liquidvessel size
tg-50000-100000Liquefied gas tanker (50 – 100k cbm)Liquidvessel size
tg-100000-200000Liquefied gas tanker (100 – 200k cbm)Liquidvessel size
tg-200000Liquefied gas tanker (>200k cbm)Liquidvessel size
to-0-5000Oil tanker (0 – 5k dwt)OilTankervessel size
to-5000-10000Oil tanker (5 – 10k dwt)OilTankervessel size
to-10000-20000Oil tanker (10 – 20k dwt)OilTankervessel size
to-20000-60000Oil tanker (20 – 60k dwt)OilTankervessel size
to-60000-80000Oil tanker (60 – 80k dwt)OilTankervessel size
to-80000-120000Oil tanker (80 – 120k dwt)OilTankervessel size
to-120000-200000Oil tanker (120 – 200k dwt)OilTankervessel size
to-200000Oil tanker (>200k dwt)OilTankervessel size
tl-0-1000Other liquids tankers (0 – 1k dwt)Liquidvessel size
tl-1000Other liquids tankers (>1k dwt)Liquidvessel size
rp-0-2000Ferry-RoPax (0 – 2k gt)Ferryvessel size
rp-2000-5000Ferry-RoPax (2 – 5k gt)Ferryvessel size
rp-5000-10000Ferry-RoPax (5 – 10k gt)Ferryvessel size
rp-10000-20000Ferry-RoPax (10 – 20k gt)Ferryvessel size
rp-20000Ferry-RoPax (>20k gt)Ferryvessel size
br-0-2000Refrigerated bulk (0 – 2k dwt)BulkCarriervessel size
br-2000-6000Refrigerated bulk (2 – 6k dwt)BulkCarriervessel size
br-6000-10000Refrigerated bulk (6 – 10k dwt)BulkCarriervessel size
br-10000Refrigerated bulk (>10k dwt)BulkCarriervessel size
rr-0-5000Ro-Ro (0 – 5k dwt)RoRovessel size
rr-5000-10000Ro-Ro (5 – 10k dwt)RoRovessel size
rr-10000-15000Ro-Ro (10 – 15k dwt)RoRovessel size
rr-15000Ro-Ro (>15k dwt)RoRovessel size
rv-0-30000Vehicle (0 – 30k gt)Vehiclevessel size
rv-30000-50000Vehicle (30 – 50k gt)Vehiclevessel size
rv-50000Vehicle (>50k gt)Vehiclevessel 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.

KeyDescription
BULK_CARRIERBulk carrier vessels
CHEMICAL_TANKERChemical tanker vessels
CONTAINER_VESSELContainer vessels
GENERAL_CARGO_VESSELGeneral Cargo vessels
LIQUID_TANKERLiquid gas vessels
OIL_TANKEROil tanker vessels
FERRYFerry vessels
RORO_VESSELRoll-on Roll-off vessels
VEHICLE_CARRIERVehicle 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.

KeyValue
NONEOnly the gross weight of the freight is on the RoRo ship.
CLASS_3_5Gross weight is located on a 3.5t truck.
CLASS_7_5Gross weight is located on a 7.5t truck.
CLASS_12Gross weight is located on a 12t truck.
CLASS_20Gross weight is located on a 20t truck.
CLASS_26Gross weight is located on a 26t truck.
CLASS_40Gross weight is located on a 40t truck. (default)
CLASS_60Gross weight is located on a 60t truck.
TRAIN_STANDARD_WAGONGross weight is located on a standard train wagon.
TRAILER_ONLYGross 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”.

KeyValue
NONESea ship calculation on the base of the ETW methodology (comparable to the calculation at www.ecotransit.org and default)
CLEAN_CARGO_TRADELANESea ship calculation on the base of the Clean Cargo tradelane emission intensities
CLEAN_CARGO_TRADELANE_REEFERSea ship calculation on the base of the Clean Cargo tradelane emission intensities as reefer container
CLEAN_CARGO_PORTPAIRSea ship calculation on the base of the Clean Cargo port-pair emission intensities (only available for Clean Cargo members)
CLEAN_CARGO_PORTPAIR_REEFERSea ship calculation on the base of the Clean Cargo port-pair emission intensities as reefer container (only available for Clean Cargo members)
cleanCargoTimeFrameThe 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:

KeyEmission Area
afAfrica
asAsia South
anAsia North
ciCaribbean
euEurope
mdMediterranean
ueNorth America East Coast
uwNorth America West Coast
miMiddle East
ozOceania
otherGlobal 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:

KeyValue
xAVGCCWG Average values (default)
APLUAPL
ARKUArkas Container Transport S.A.
CMDU DVRU CNCUCMA CGM
COSU COEUCOSCO SHIPPING Lines Co., Ltd.
CMCUCrowley
EGLVEvergreen Marine Corp. Ltd.
HLCU UASUHapag-Lloyd
HDMUHyundai Merchant Marine Co., Ltd.
MAEU SUDUMaersk
MATSMatson Navigation Company, Inc
MCCQMCC Transport Pte. Ltd.
MSCUMediterranean Shipping Company (MSC)
ONEY KKLU NYKS MOLUOcean Network Express (ONE Line)
OOLUOOCL USA Inc
UFEEUnifeeder A/S
WHLUWan Hai Lines
YMLUYang Ming Marine Transport Corporation
ZIMUZim Integrated Shipping Services Ltd. (Zim Line)
22AAWan 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.

KeyValue
TRADELANE (default)Emission calculation based on aggregated tradelane vessel classes
VESSEL_SIZEEmission 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:

KeyValue
VESSELThe 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
CARRIERBased 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).
ALLIANCEBased 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:

KeyValue
SHARE_BASED (default)Enables the realistic rout filter in the ais-based routing.
NONEDisables the filter and includes all possible vessel trips in the ais-based routing
KeyValue
minVesselTeuminimum dead weight in TEU of the vessel
minVesselDwtminimum dead weight in tons of the vessel
onlyServiceVesselsuse 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.

KeyValid Values
distanceAdjustmentFactor0 – 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.

KeyValue
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_FLIGHTSRouting and transfer point determination will be based on the satellite-data of real aircraft trips
SCHEDULEDRouting 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)

KeyValue
freight0 – 100% (only applicable if a single aircraft is specified)
passenger0-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

KeyValue
carrierCodeCarrier code (e.g. LH or AF)
flightNumberFlight number without leading zero (e.g. LH123)
directFlighttrue or false (default), disables the air network routing and calculates a direct flight from the origin to the destination airport
considerRfiFactorconsider 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.

KeyValue
BELLY_FREIGHTBelly freighter aircraft type
FREIGHTERFreighter aircraft type incl. Hybrid planes
ALL_CLASSESALL_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.

KeyValue
NONEBased on aggregated fuel consumptions from Small Emitters Tool
ICAOBelly plane allocation on the base of ICAO/IATA methodology
SKAILARKBased 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"
        }
    }
}
KeyValueTypeDefault for Hybrid
HybSHHybrid short haulHybrid
HybMHHybrid medium haulHybrid
HybLHHybrid long haulHybrid
100Fokker 100Belly-Freight
141BAe 146-100 PassengerBelly-Freight
142BAe 146-200 PassengerBelly-Freight
143BAe 146-300 PassengerBelly-Freight
146BAe 146 PassengerBelly-Freight
220Airbus A220 PassengerBelly-Freight
221Airbus A220-100Belly-Freight
223Airbus A220-300Belly-Freight
290Embraer 190 E2Belly-Freight
295Embraer E195-E2Belly-Freight
310Airbus A310 PassengerBelly-Freight
313Airbus A310-300 PassengerBelly-Freight
318Airbus A318Belly-Freight
319Airbus A319Belly-Freight
320Airbus A320Belly-FreightMedium Haul
321Airbus A321Belly-Freight
330Airbus A330Belly-Freight
332Airbus A330-200Belly-Freight
333Airbus A330-300Belly-Freight
338Airbus A330-800neoBelly-Freight
339Airbus A330-900neoBelly-Freight
340Airbus A340Belly-Freight
342Airbus A340-200Belly-Freight
343Airbus A340-300Belly-Freight
345Airbus A340-500Belly-Freight
346Airbus A340-600Belly-Freight
350Airbus Industrie A350Belly-Freight
351Airbus A350-1000Belly-Freight
359Airbus Industrie A350-900Belly-Freight
380Airbus Industrie A380 PassengerBelly-Freight
388Airbus A380-800 PassengerBelly-Freight
717Boeing 717-200Belly-Freight
722Boeing 727-200 PassengerBelly-Freight
727Boeing 727Belly-Freight
731Boeing 737-100 PassengerBelly-Freight
732Boeing 737-200 PassengerBelly-Freight
733Boeing 737-300 PassengerBelly-Freight
734Boeing 737-400 PassengerBelly-Freight
735Boeing 737-500 PassengerBelly-Freight
736Boeing 737-600 PassengerBelly-Freight
737Boeing 737 PassengerBelly-Freight
738Boeing 737-800 PassengerBelly-Freight
739Boeing 737-900 PassengerBelly-Freight
742Boeing 747-200 (Passenger)Belly-Freight
743Boeing 747-300/100/200 SudBelly-Freight
744Boeing 747-400 (Passenger)Belly-FreightLong haul
747Boeing 747 (Passenger)Belly-Freight
752Boeing 757-200 PassengerBelly-Freight
753Boeing 757-300 PassengerBelly-Freight
757Boeing 757 (Passenger)Belly-Freight
762Boeing 767-200 PassengerBelly-Freight
763Boeing 767-300 PassengerBelly-Freight
764Boeing 767-400 PassengerBelly-Freight
767Boeing 767 PassengerBelly-Freight
772Boeing 777-200/200ER PassengerBelly-Freight
773Boeing 777-300 PassengerBelly-Freight
777Boeing 777 PassengerBelly-Freight
781Boeing 787-10Belly-Freight
787Boeing 787Belly-Freight
788Boeing 787-8Belly-Freight
789Boeing 787-9Belly-Freight
919COMAC C919Belly-Freight
14FBAe 146 (Freighter)Freighter
14YBAE Systems 146-200 (Freighter)Freighter
14ZBAE Systems 146-300 (Freighter)Freighter
31BAirbus A319 (sharklets)Belly-Freight
31FAirbus A310FFreighter
31NAirbus A319neoBelly-Freight
31YAirbus A310-300 FreighterFreighter
32AAirbus A320 (sharklets)Belly-Freight
32BAirbus Industrie A321 (Sharklets)Belly-Freight
32NAirbus A320neoBelly-Freight
32QAirbus A321neoBelly-Freight
32SAirbus A318 /319 /320 /321Belly-Freight
32XAirbus A321 (Freighter)Freighter
33BA330-700STFreighter
33FAirbus A330 FreighterFreighter
33XAirbus A330-200 FreighterFreighter
33YAirbus A330-300 FreighterFreighter
3XLA330-700LFreighter
72FBoeing 727 (Freighter)Freighter
72SBoeing 727-200 (Pax)Belly-Freight
72YBoeing 727-200 (Freighter)Freighter
73CBoeing 737-300 (winglets) PassengerBelly-Freight
73EBoeing 737-500 (winglets) PassengerBelly-Freight
73FBoeing 737 (Freighter)Freighter
73GBoeing 737-700 PassengerBelly-Freight
73HBoeing 737-800 (winglets) PassengerBelly-Freight
73JBoeing 737-900 (winglets) PassengerBelly-Freight
73KBoeing 737-800 (wl) FreighterFreighter
73LBoeing 737-200 (Mixed Configuration)Belly-Freight
73MBoeing 737 (Mixed Configuration)Belly-Freight
73NBoeing 737-300 (Mixed Configuration)Belly-Freight
73PBoeing 737-400 (Freighter)Freighter
73QBoeing 737-400 (Mixed Configuration)Belly-Freight
73RBoeing 737-700 (Mixed Configuration)Belly-Freight
73SBoeing 737 Advanced all SeriesBelly-Freight
73TB737-700(BDSF)FreighterShort haul
73UB737-800(BCF) Boeing 737-800 FreighterFreighter
73WBoeing 737-700 (winglets) PassengerBelly-Freight
73XBoeing 737-200 (Freighter)Freighter
73YBoeing 737-300 (Freighter)Freighter
74B747-400FFreighter
74CBoeing 747-200 KombiBelly-Freight
74EBoeing 747-400 (Mixed Configuration)Belly-Freight
74FBoeing 747 (Freighter)Freighter
74HBoeing 747-8i PassengerBelly-Freight
74LBoeing 747SP PassengerBelly-FreightLong haul
74MBoeing 747Belly-Freight
74NBoeing 747-8F (Freighter)Freighter
74UB747-300(SF)Freighter
74XBoeing 747-200 (Freighter)Freighter
74YBoeing 747-400F (Freighter)Freighter
75CBoeing 757-200 FreighterFreighter
75FBoeing 757-200PF (Freighter)Freighter
75M757-200PF -SF -PCFFreighter
75TBoeing 757-300 (winglets) PassengerBelly-Freight
75VBoeing 757-200 Freighter (winglets)FreighterMedium Haul
75WBoeing 757-200 (winglets) PassengerBelly-Freight
76FBoeing 767 FreighterFreighter
76VBoeing 767-300 (winglets) FreighterFreighter
76WBoeing 767-300 (winglets) PassengerBelly-Freight
76XBoeing 767-200 FreighterFreighter
76YBoeing 767-300 FreighterFreighter
77FBoeing 777 FreighterFreighter
77LBoeing 777-200LRBelly-Freight
77WBoeing 777-300ER PassengerBelly-Freight
77XBoeing 777-200F FreighterFreighter
7F8B737-800(BCF)Freighter
7M7Boeing 737MAX 7 PassengerBelly-Freight
7M8Boeing 737MAX 8 PassengerBelly-Freight
7M9Boeing 737MAX 9 PassengerBelly-Freight
7S8Boeing 737-800 (Scimitar Winglets) PaxBelly-Freight
A26Antonov An-26Belly-Freight
A32Antonov An-32Belly-Freight
A38Antonov AN-38Belly-Freight
A40Antonov AN-140Belly-Freight
A4FAntonov AN-124 RuslanFreighter
A58Antonov An-158Belly-Freight
A81Antonov An148-100Belly-Freight
AB3Airbus A300 PassengerBelly-Freight
AB4Airbus A300B2/B4/C4Belly-Freight
AB6Airbus A300-600 PassengerBelly-Freight
ABBA300-600STFreighter
ABFAirbus A300 (Freighter)Freighter
ABXAirbus A300B4 /A300C4 /A300F4Belly-Freight
ABYAirbus A300-600 FreighterFreighter
AGHAgusta A109Belly-Freight
AN4Antonov AN-24Belly-Freight
AN6Antonov AN-26 /30 /32Belly-Freight
ANFAntonov AN-12Freighter
APFBAe ATP(F)Freighter
AR1Avro RJ100Belly-Freight
AR7ARJ70Belly-Freight
AR8Avro RJ85Belly-Freight
ARJAvro RJ70 /rj85 /rj100Belly-Freight
AT4ATR 42-300 /320Belly-Freight
AT5ATR 42-500Belly-Freight
AT7ATR 72Belly-Freight
ATFATR 72 (Freighter)Freighter
ATPBAe ATPBelly-Freight
ATRATR42 /ATR72Belly-Freight
ATXATR 42-300F (Freighter)Freighter
ATYATR 72-200F (Freighter)Freighter
ATZATR 42 FreighterFreighter
AWHAgustaWestland AW139Belly-Freight
BE1Beechcraft 1900 AirlinerBelly-Freight
BE2Beechcraft-Lght Acft-Twin Piston EngineBelly-Freight
BE4Hawker 400 Beechjet/400A/400XP/400TBelly-Freight
BE9Beechcraft C99 AirlinerBelly-Freight
BECBeechcraft (Light Aircraft)Belly-Freight
BEFHawker Beechcraft 1900 (Freighter)Freighter
BEHBeechcraft 1900D AirlinerBelly-Freight
BESBeechcraft 1900C AirlinerBelly-Freight
BETBeechcraft (Lght Acft - Twin Turboprop)Belly-Freight
BH2Bell (Helicopters)Belly-Freight
BNIBN BN-2a/BN-2b IslanderBelly-Freight
BNTBN BN-2a Mk,iii TrislanderBelly-Freight
C27COMAC ARJ21Belly-Freight
CCJCanadair ChallengerBelly-Freight
CJ8Cessna 680 CitationBelly-Freight
CN1Cessna Light Acft(single Piston Engine)Belly-Freight
CN2Cessna Light Acft (Twin piston engines)Belly-Freight
CNACessna (Light Aircraft)Belly-Freight
CNCCessna Light Aircraft(Single Turboprop)Belly-Freight
CNFCessna 208b FreighterFreighter
CNJCessna CitationBelly-Freight
CNTCessna Light Aircraft (Twin TurbopropBelly-Freight
CR1Canadair Regional Jet 100Belly-Freight
CR2Canadair Regional Jet 200Belly-Freight
CR5Canadair Regional Jet 550Belly-Freight
CR7Canadair Regional Jet 700Belly-Freight
CR9Canadair Regional Jet 900Belly-Freight
CRACanadair CRJ Series 705Belly-Freight
CRFCanadair Regional Jet FreighterFreighter
CRJCanadair Regional JetBelly-Freight
CRKCanadair (Bombardier) Regional Jet 1000Belly-Freight
CS1Bombardier CS100Belly-Freight
CS2CASA C212 /Nusantara NC-212 AviocarFreighter
CS3Bombardier CS300Belly-Freight
CSFSkyCourier 408FFreighter
CV5Convair 580 PassengerBelly-Freight
CVFConvair 440 /580 /600 /640 (Freighter)Freighter
CVRConvair 240 /440 /580 (Passenger)Belly-Freight
CVYConvair 580/5800/600/640 (freighter)Freighter
CWCCurtiss C-46 CommandoFreighter
D10Boeing (Douglas) DC10 PassengerBelly-Freight
D1CBoeing (douglas) DC10-30 /40 (Pax)Belly-Freight
D1FBoeing (douglas) DC10 (Freighter)Freighter
D1XMD-10-10(F)Freighter
D1YDC-10-30(F)/DC-10-40(F)/DC-10-30(F)Freighter
D28vFairchild Dornier 228Belly-Freight
D38Fairchild Dornier 328-100Belly-Freight
D3XDHC-8-300(F)Freighter
D6FBoeing (douglas) DC6A /B /C FreighterFreighter
D8FBoeing (douglas) DC8 FreighterFreighter
D8XBoeing (douglas) DC-8-61 /62 /63 FrtrFreighter
D93Boeing (Douglas) DC9-30 PassengerBelly-Freight
D95Boeing (Douglas) DC9-50 PassengerBelly-Freight
D9CBoeing (Douglas) DC-9-30 FreighterFreighter
D9FBoeing (Douglas) DC9 FreighterFreighter
D9XDouglas DC-9-10 FrachterFreighter
DC3Boeing (Douglas) DC-3Belly-Freight
DC8Boeing (Douglas) DC-8 PassengerBelly-Freight
DC9Boeing (douglas) DC-9 PassengerBelly-Freight
DH1De Havilland DHC-8-100 Dash 8 /8qBelly-Freight
DH2De Havilland DHC-8-200 Dash 8 /8qBelly-Freight
DH3De Havilland DHC-8-300 Dash 8 /8qBelly-Freight
DH4De Havilland DHC-8 Dash 8-400 Dash 8qBelly-Freight
DH7De Havilland DHC-7 Dash 7Belly-FreightShort haul
DH8DHvilld-Bombardier DHC8 Dsh 8Belly-Freight
DHBDHvilld-Bombardier DHC2 Bvr/Tb BvrBelly-Freight
DHCDHvilld-Bombardier DHC4 CaribouBelly-Freight
DHLDe Havilland DHC-3 Turbo OtterBelly-Freight
DHPDHvilld-Bombardier DHC2 BvrBelly-Freight
DHSDHvilld-Bombardier DHC3 OtterBelly-Freight
DHTDe Havilland DHC-6 Twin OtterBelly-Freight
E70Embraer 170Belly-Freight
E75Embraer 175Belly-Freight
E7WEmbraer 175 (Enhanced Winglets)Belly-Freight
E90Embraer 190Belly-Freight
E95Embraer 195Belly-Freight
EC3Eurocopter EC130/EC130T2Belly-Freight
EM2Embraer 120 BrasiliaBelly-Freight
EMBEmbraer 110 BandeiranteBelly-Freight
EMJEmbraer 170/195Belly-Freight
EP1Embraer EMB-500 Phenom 100Belly-Freight
EP3Embraer EMB-505 Phenom 300Belly-Freight
ER3Embraer RJ135Belly-Freight
ER4Embraer RJ145Belly-Freight
ERDEmbraer RJ140Belly-Freight
ERJEmbraer RJ 135/140/145Belly-Freight
F27Fokker 27Belly-Freight
F28Fokker F28 FellowshipBelly-Freight
F50Fokker 50Belly-Freight
F5FF50(F)Freighter
F70Fokker 70Belly-Freight
FRJFairchild Dornier 328jetBelly-Freight
GRJGulfstream Aerospace G/stream 2/3/4/5/6Belly-Freight
HS7BAe (HS) 748Belly-Freight
I14Ilyushin IL114Belly-Freight
I9FIlyushin IL96 FreighterFreighter
I9XIlyushin IL96-300 FreighterFreighter
I9YIlyushin IL96T FreighterFreighter
IL6Il-62MBelly-Freight
IL7Ilyushin IL-76Freighter
IL8Ilyushin IL-18Belly-Freight
IL9Ilyushin Il-96 PassengerBelly-Freight
J31BAe Jetstream 31Belly-Freight
J32BAe Jetstream 32Belly-Freight
J41BAe Jetstream 41Belly-Freight
L4TLet 410Belly-Freight
LOHLockheed L182 /l282 /l382 (L100) HerculFreighter
M11Boeing (Douglas) MD-11 PassengerBelly-Freight
M1FBoeing (douglas) MD-11 (Freighter)Freighter
M2FMD-82(SF)Freighter
M3FMD-83(SF)Freighter
M80Boeing (douglas) MD-80Belly-Freight
M81Boeing (douglas) MD-81Belly-Freight
M82Boeing (Douglas) MD-82Belly-Freight
M83Boeing (Douglas) MD-83Belly-Freight
M87 Boeing (Douglas) MD-87Belly-Freight
M88 Boeing (Douglas) MD-88Belly-Freight
M8F MD-88(SF)Freighter
M90 Boeing (Douglas) MD-90Belly-Freight
MA6 Xian Yunshuji Ma-60Belly-Freight
MIH Mil MI-8 /MI-17 /MI-171 /MI-172Freighter
NDE Eurocopter Ecureuil AS350/As355 2Belly-Freight
NDH Aerospatiale SA365 Dauphin 2Belly-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-12Belly-Freight
PN6 Partenavia P.68Belly-Freight
S20 Saab 2000Belly-Freight
S76 Sikorsky S-76Belly-Freight
S9S SSJ 100/95SBJBelly-Freight
SF3 Saab 340Belly-Freight
SFB Saab 340BBelly-Freight
SFF Saab 340 FreighterFreighter
SH3 Shorts 330 (sd3-30)Belly-Freight
SH6 Shorts 360 (sd3-60)Belly-Freight
SU9 Sukhoi Superjet 100-95Belly-Freight
SWM Fairchild Sa26 /Sa226 /Sa227 Merlin /MeBelly-Freight
T12 Tecnam P2012 TravellerBelly-Freight
T20 Tupolev TU-204 /tu-214Belly-Freight
T2F TU-204-100CEFreighter
TU3 Tupolev TU134Belly-Freight
TU5 Tupolev TU154Belly-Freight
YK2 Yakovlev Yak-42 /142Belly-Freight
YK4 Yakovlev Yak-40Belly-Freight
YN2 Harbin Yunshuji Y12Belly-Freight
YN7 Xian Yunshuji Y7/Ma60Belly-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.

REff-Tool 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.

idLogistic Hub
1Transhipment site, ambient
2Transhipment site, mixed
3Container terminal, dry
4Container terminal, cooled
5Bulk terminal, mixed

A logistic hub can use the id-related values or directly defined values. The following attributes can be applied:

KeyValue
idId of the logistic hubs as defined in the REff-Tool from Fraunhofer IML. This needs to be exported and sent to IVE.
LogisticHubParametersList 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.

KeyDescribtion
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_TRIPThe 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:

KeyDescription
pastThe specified timeframe is before the transport date (default)
balancedThe timeframe is evenly distributed around the transport date
futureThe 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.

KeyDescription
SUEZExclude Suez canal from routing.
PANAMAExclude Panama canal from routing.
KIELExclude 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.

KeyOptions
ERRORThrow an Error and terminate calculation.
IGNOREIgnores inconsistent or bad input and let EcoTransIT World make the most reasonable assumption to resolve the conflict and give a response with proper emissions
CUSTOMFurther 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:

KeyDescribtion
DISABLEDTranshipments are not considered (default)
ALWAYSAll potential transhipments are considered
INTERMODALCHANGEOnly intermodal transhipments are considered

handlingType

The attribute handlingType defines the freight type and is mandatory.

KeyDescribtion
DRYDry Bulk
LIQUIDLiquid Bulk
PIECEPiece goods / Break Bulk
PALLETFreight on pallets
CONTAINERFreight in containers
RORO Vehiclebased 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.

KeyValue
trueEnables the appliance of the alias table (default).
falseDisables 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).

KeyValueDescription
frontierstrue or falseSplits the carriage when crossing country borders.
railtrue or falseSplits the carriage on railTraction change. For example if part of the track is not electrified. It is recommended to set this to true
seatrue or falseSplits 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.

KeyValue
STANDARDMinimal amount of information (default)
DETAILEDOutput 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)