Receive emissions calculations from the provider.
| Name | Description |
|---|---|
| Root | Chain.io schema for sending emissions calculations. |
| Co2Emissions | A single emissions value to report. |
| Emissions | The emission totals associated with the origin / destination of the shipment. |
| CarbonIntensity | A measurement of how polluting the shipment is per cargo weight and distance travelled. The intensity formula produces a value representing the emissions per unit of work done - where unit of work is measured as weight * distance. You will generally see this metric expressed something like gCO₂e / tkm. The CO₂e value used in the equation should be found as the well_to_wheel_emissions.carbon_dioxide_equivalent property. |
| EmissionAmounts | The individual emission calculation amounts produced by the emissions platform. |
| EmissionCalculation | An individual emission calculation. |
| ShipmentLeg | A single transportation segment in a shipment's larger journey from origin to destination. A leg represent both a physical transport from an origin to a different destination, but may also represent a transport process, like a transhipment, taking place at a singular location. In these cases, the transport mode should be left blank and a destination should not be present. |
| Location | A unique location. |
| SeaPort | A location representing a sea port. |
| Airport | A location representing an airport. |
| Address | A location representing a street address. |
| Coordinate | A location representing a latitude and longitude. |
| Vessel | A type of conveyance. |
| Truck | |
| Train | |
| Plane | |
| Ship | |
| Coordinates | |
| CustomProperties | An object an input converter can utilize to pass any custom data back into a flow that can potentially be utilized by an output converter. |
| CarbonIntensity_calculated_distance | The total distance calculated for the journey this emissions calculation is linked to. This is the distance that is used as the basis for all distance based calculations associated with this emissions object. |
| CarbonIntensity_calculated_weight | The weight amount used in the carbon intensity calculation. |
| CarbonIntensity_calculated_intensity | The carbon intensity calculated total. |
| EmissionAmounts_energy | The calculated amount of energy consumed. |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The 'primary key' uniquely identifying the shipment in the source TMS system. This value is what will be utilized to identify what unique shipment to associated the the emissions calculation data with. | YES |
emissions_platform_identifier | String | The 'primary key' uniquely identifying the emissions calculation in the emissions data provider's platform. | |
emissions_platform_url | String | A link to the emissions calculation on the emissions data provider's platform. | |
emissions_calculation_date | DateTime | The date / time when the emissions data was calculated. | |
tank_to_wheels_co2_emissions | Co2Emissions | ||
well_to_wheels_co2_emissions | Co2Emissions | ||
emissions | Emissions | The emission totals for the entire shipment from origin to destination. | |
shipment_legs | Array<ShipmentLeg> | All the routing information for the shipment. Legs should be ordered such that they describe the progression of the cargo from the shipment origin to destination. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The actual calculated CO2 emissions amount. | YES |
unit | String | The unit of measure the CO2 emissions amount is expressed in. tonne - Metric Ton (1000 KG), ton - Short Ton (2000 LB) Allowed values: kilogram, tonne, pound, ton. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
carbon_intensity | CarbonIntensity | The carbon intensity score and component values used to calculate it. | |
tank_to_wheel_emissions | EmissionAmounts | The tank to wheel emission values calculated by the emissions platform. | |
well_to_wheel_emissions | EmissionAmounts | The tank to wheel emission values calculated by the emissions platform. | |
well_to_tank_emissions | EmissionAmounts | The well to tank emission values calculated by the emissions platform. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
calculated_distance | CarbonIntensity_calculated_distance | The total distance calculated for the journey this emissions calculation is linked to. This is the distance that is used as the basis for all distance based calculations associated with this emissions object. | |
calculated_weight | CarbonIntensity_calculated_weight | The weight amount used in the carbon intensity calculation. | |
calculated_intensity | CarbonIntensity_calculated_intensity | The carbon intensity calculated total. |
| Name | Data Type | Description | Required |
|---|---|---|---|
carbon_dioxide_equivalent | EmissionCalculation | CO₂e | |
carbon_dioxide | EmissionCalculation | CO₂ | |
methane | EmissionCalculation | CH₄ | |
nitrous_oxide | EmissionCalculation | N₂O | |
nox | EmissionCalculation | Nitrogen oxides (nitric oxide [NO] and nitrogen dioxide [NO₂]). | |
non_methane_hydrocarbon | EmissionCalculation | NMHC | |
sulfur_dioxide | EmissionCalculation | SO₂ | |
particulate_matter | EmissionCalculation | PM | |
energy | EmissionAmounts_energy | The calculated amount of energy consumed. |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric total emission value. | YES |
unit | String | The unit of measure of the emissions calculation. tonne = Metric Tonne (1,000 kilograms), ton = Short Ton (2,000 pounds) Allowed values: kilogram, tonne, pound, ton. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
transport_mode | String | The primary means of transport of the goods for this leg. This may be left undefined for legs that do not involve physical transport of the goods, like transship/transload legs. Allowed values: sea, air, road, rail, inland_waterway. | |
origin | Location | YES | |
destination | Location | ||
vessel | Vessel | ||
emissions | Emissions | The emission totals for this shipment leg. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier Allowed values: seaport. | YES |
unlocode | String | The UN/Locode identifier for the sea port. | YES |
unlocode_description | String | A free text description of the UN/Locode. | |
coordinates | Coordinates |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: airport. | YES |
iata_code | String | The IATA airport location identifier. | YES |
iata_code_description | String | A free text description of the IATA Code. | |
unlocode | String | The UN/Locode identifier correlated with the IATA code. | |
coordinates | Coordinates |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: address. | YES |
name | String | A name for the address. Typically the name of the business located at the address. | |
address_1 | String | The address' street number and name. | YES |
address_2 | String | The address' secondary address information. | |
city | String | The address' city component. | YES |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The address' 2 character ISO-3166-2 country Code. | YES |
postal_code | String | The unique postal code identifier for the address. | |
unlocode | String | A UN/Locode identifier correlated with the address. | |
coordinates | Coordinates |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: coordinates. | YES |
name | String | A name for the location. Typically the name of the business at that location. | |
latitude | String | The numeric coordinate specifying the north-south position of a point on the surface of the earth. | YES |
longitude | String | The numeric coordinate specifying the east-west position of a point on the surface of the earth. | YES |
city | String | The location's city component. | |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The location's 2 character ISO-3166-2 country Code. | |
postal_code | String | The unique postal code identifier for the location. | |
unlocode | String | A UN/Locode identifier correlated with the location. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | Allowed values: plane. | YES |
flight_number | String | The carrier's identifier for the flight. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | Allowed values: ship. | YES |
imo_number | String | The vessel's International Maritime Organization unique seven digit number. | |
vessel_name | String | The carrier's name for the vessel. | |
voyage_number | String | The carrier's voyage identifier for the vessel. |
| Name | Data Type | Description | Required |
|---|---|---|---|
latitude | String | The numeric coordinate specifying the north-south position of a point on the surface of the earth. | YES |
longitude | String | The numeric coordinate specifying the east-west position of a point on the surface of the earth. | YES |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric distance value. | YES |
unit | String | Allowed values: kilometer, mile. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric weight amount | YES |
unit | String | The unit of measure associated with the amount property. tonne = Metric Tonne (1,000 kilograms), ton = Short ton (2,000 pounds) Allowed values: kilogram, pound, tonne, ton. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric intensity value. | YES |
unit | String | The units involved in the intensity calculation. gram_per_tonne_kilometer = Grams CO₂e / (Metric Ton transported * Kilometers travelled) gram_per_ton_mile = Grams CO₂e / (Short Ton [2000 LB] transported * Miles travelled) gram_per_tonne = Grams CO₂e / (Metric Ton transported) Allowed values: gram_per_tonne_kilometer, gram_per_ton_mile, gram_per_tonne, gram_per_ton. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric energy value. | YES |
unit | String | The unit of measure of energy consumption. Allowed values: megajoule. | YES |