CO2 Data Providers
Purpose
This Integration is used to augment the shipment data in the Transportation Management Systems or ERPs with emissions data from a 3rd party emissions service
Roles
These roles describe the different systems involved in this integration
- TMS this is the shipper or freight forwarder's system that houses shipment data. It may be a traditional transportation management system, and ERP, or even an online spreadsheet.
- Emissions Data Provider this is the system responsible for calculating the emissions data for a shipment and potentially returning it to the TMS
Flow Types
| Flow Type | Key | Description | Input Converter | Output Converter |
|---|---|---|---|---|
| Register Shipment | co2.register_shipment | Send shipment information from the TMS to the emissions data provider | TMS | Emissions Data Provider |
| Receive CO2 Update | co2.receive_co2_update | Send CO2 emissions data for a shipment from the emissions data provider to the user's system. | Emissions Data Provider | TMS |
Register Shipment
Sample payloads output by the TMS' Input Adapter and sent to the Emissions Data Provider's Output Adapter
{
"tms_system_identifier": "S123456",
"gross_weight": {
"amount": 1.2,
"unit": "tonne"
},
"teus": 2,
"specialized_freight_handling": ["refrigerated"],
"shipment_legs": [
{
"origin": {
"type": "address",
"name": "Sheraton Hanoi",
"address_1": "K5 Nghi Tam",
"address_2": "11 Đ. Xuân Diệu Road",
"city": "Hà Nội",
"country": "VN",
"postal_code": "100000"
},
"destination": {
"type": "address",
"name": "Port of Hai Phong",
"address_1": "8A Tran Phu Street",
"city": "Hai Phong",
"country": "VN",
"postal_code": "180000"
},
"vessel": {
"type": "truck"
}
},
{
"origin": {
"type": "seaport",
"unlocode": "VNHAI"
},
"destination": {
"type": "seaport",
"unlocode": "TWKHH"
},
"vessel": {
"type": "container_ship",
"vessel_name": "Feeder Vessel",
"imo_number": "IM1890123",
"voyage_number": "ABC123",
"containerization_type": "fcl"
}
},
{
"origin": {
"type": "seaport",
"unlocode": "TWKHH"
},
"destination": {
"type": "seaport",
"unlocode": "USLGB"
},
"vessel": {
"type": "container_ship",
"vessel_name": "Mother Vessel",
"imo_number": "IM9891230",
"voyage_number": "US9190",
"containerization_type": "fcl"
}
},
{
"origin": {
"type": "address",
"address_1": "Pier B",
"city": "Long Beach",
"country": "US",
"postal_code": "90802"
},
"destination": {
"type": "address",
"name": "Bedford Park Rail Terminal",
"address_1": "7000 West 71st St",
"city": "Bedford Park",
"country": "US",
"postal_code": "60638"
},
"vessel": {
"type": "train"
}
},
{
"origin": {
"type": "address",
"name": "Bedford Park Rail Terminal",
"address_1": "7000 West 71st St",
"city": "Bedford Park",
"country": "US",
"postal_code": "60638"
},
"destination": {
"type": "address",
"name": "Sheraton Grand Chicago Riverwalk",
"address_1": "301 E North Water St",
"city": "Chicago",
"country": "US",
"postal_code": "60611"
},
"vessel": {
"type": "truck"
}
}
]
}
{
"tms_system_identifier": "2031472a-853c-4a16-9ebc-acc122ae0dec",
"gross_weight": {
"amount": 500,
"unit": "kilogram"
},
"shipment_legs": [
{
"origin": {
"type": "address",
"name": "Sheraton Hanoi",
"address_1": "K5 Nghi Tam",
"address_2": "11 Đ. Xuân Diệu Road",
"city": "Hà Nội",
"country": "VN",
"postal_code": "100000"
},
"destination": {
"type": "address",
"name": "Nội Bài International Airport",
"address_1": "NTS Building",
"city": "Hà Nội",
"country": "VN",
"postal_code": "100000"
},
"vessel": {
"type": "truck"
}
},
{
"origin": {
"type": "airport",
"iata_code": "HAN"
},
"destination": {
"type": "airport",
"iata_code": "LAX"
},
"vessel": {
"type": "plane",
"flight_number": "BR1910"
}
},
{
"origin": {
"type": "address",
"name": "EVA Air Cargo",
"address_1": "6841 W. Imperial Hwy.",
"city": "Los Angeles",
"country": "US",
"postal_code": "90045"
},
"destination": {
"type": "address",
"name": "Sheraton Grand Los Angeles",
"address_1": "711 South Hope St",
"city": "Los Angeles",
"country": "US",
"postal_code": "90017"
},
"vessel": {
"type": "truck"
}
}
]
}
Receive CO2 Update
Sample payload output by the Emissions Data Provider's Input Adapter and sent to the TMS' Output Adapter
{
"tms_system_identifier": "S123456",
"emissions_platform_identifier": "60ad2c5b-fda5-4518-a22e-6145bf3a0534",
"emissions_platform_url": "https://www.emissions.com/report/60ad2c5b-fda5-4518-a22e-6145bf3a0534",
"emissions_calculation_date": "2023-10-30T14:33:00.000Z",
"emissions": {
"carbon_intensity": {
"calculated_distance": {
"amount": 18720.917,
"unit": "kilometer"
},
"calculated_weight": {
"amount": 10,
"unit": "tonne"
},
"calculated_intensity": {
"amount": 7.148655239484263,
"unit": "gram_per_tonne_kilometer"
}
},
"tank_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 1205.952164,
"unit": "kilogram"
}
},
"well_to_tank_emissions": {
"carbon_dioxide_equivalent": {
"amount": 98.34165,
"unit": "kilogram"
}
},
"well_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 1338.293814,
"unit": "kilogram"
}
}
},
"shipment_legs": [
{
"origin": {
"type": "seaport",
"unlocode": "GBSOU",
"unlocode_description": "Port of Southampton, United Kingdom",
"coordinates": {
"latitude": "50.8776",
"longitude": "-1.3903"
}
},
"destination": {
"type": "seaport",
"unlocode": "SGSIN",
"unlocode_description": "Port of Singapore, Singapore",
"coordinates": {
"latitude": "1.2576",
"longitude": "103.85457"
}
},
"transport_mode": "sea",
"vessel": {
"type": "ship",
"imo_number": "9631967"
},
"emissions": {
"carbon_intensity": {
"calculated_distance": {
"amount": 16157.731,
"unit": "kilometer"
},
"calculated_weight": {
"amount": 10,
"unit": "tonne"
},
"calculated_intensity": {
"amount": 6.010000005570089,
"unit": "gram_per_tonne_kilometer"
}
},
"tank_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 898.369844,
"unit": "kilogram"
}
},
"well_to_tank_emissions": {
"carbon_dioxide_equivalent": {
"amount": 72.70979,
"unit": "kilogram"
}
},
"well_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 971.079634,
"unit": "kilogram"
}
}
}
},
{
"origin": {
"type": "seaport",
"unlocode": "SGSIN",
"unlocode_description": "Port of Singapore, Singapore",
"coordinates": {
"latitude": "1.2576",
"longitude": "103.85457"
}
},
"emissions": {
"carbon_intensity": {
"calculated_weight": {
"amount": 10,
"unit": "tonne"
},
"calculated_intensity": {
"amount": 3400,
"unit": "gram_per_tonne"
}
},
"well_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 34,
"unit": "kilogram"
}
}
}
},
{
"origin": {
"type": "seaport",
"unlocode": "SGSIN",
"unlocode_description": "Port of Singapore, Singapore",
"coordinates": {
"latitude": "1.2576",
"longitude": "103.85457"
}
},
"destination": {
"type": "seaport",
"unlocode": "PHMNL",
"unlocode_description": "Port of Manila, Philippines",
"coordinates": {
"latitude": "14.6153",
"longitude": "120.9468"
}
},
"transport_mode": "sea",
"vessel": {
"type": "ship"
},
"emissions": {
"carbon_intensity": {
"calculated_distance": {
"amount": 2563.186,
"unit": "kilometer"
},
"calculated_weight": {
"amount": 10,
"unit": "tonne"
},
"calculated_intensity": {
"amount": 13,
"unit": "gram_per_tonne_kilometer"
}
},
"tank_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 307.58232,
"unit": "kilogram"
}
},
"well_to_tank_emissions": {
"carbon_dioxide_equivalent": {
"amount": 25.63186,
"unit": "kilogram"
}
},
"well_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 333.21418,
"unit": "kilogram"
}
}
}
}
]
}
{
"tms_system_identifier": "S123456",
"emissions": {
"tank_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 239.462948,
"unit": "kilogram"
}
},
"well_to_tank_emissions": {
"carbon_dioxide_equivalent": {
"amount": 52.681849,
"unit": "kilogram"
}
},
"well_to_wheel_emissions": {
"carbon_dioxide_equivalent": {
"amount": 292.144797,
"unit": "kilogram"
}
}
}
}
{
"tms_system_identifier": "S123456",
"tank_to_wheels_co2_emissions": {
"amount": 22.1,
"unit": "tonne"
},
"well_to_wheels_co2_emissions": {
"amount": 34.06,
"unit": "tonne"
}
}
Updated 6 months ago