Calculate a shipment's emissions
calculate_shipmentRead-onlyIdempotent
Calculates one shipment's greenhouse gas emissions (kg CO2e: well-to-wheel, tank-to-wheel, well-to-tank) following the GLEC Framework v3.2 and ISO 14083. Routes each leg's distance from its coordinates or codes. Returns the result per leg (distance and how it was found, method, data type, emission factor and its source, distance adjustment, notes on legs Sootcase added) and a step-by-step calculation sheet with the arithmetic and the GLEC page and ISO 14083 clause behind each step.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Your reference for the shipment | |
| teu | No | Containers in TEU, instead of weight_kg; needs teu_net_tonnes | |
| hubs | No | Hub stops (transhipment, storage); needs a dataset with hub factors. | |
| legs | Yes | The legs in order, from where the shipper hands the goods over to where the consignee receives them. | |
| weight_kg | No | Cargo weight in kg (or give teu instead) | |
| add_road_legs | No | Add road legs where the legs don't join up (gaps over 5 km), and to a port or terminal when a sea, rail or river leg starts or ends off its network (default true). Added legs are marked in the result. | |
| container_load | No | With teu: a container load profile defined by the dataset, instead of teu_net_tonnes | |
| teu_net_tonnes | No | With teu: net cargo tonnes per TEU (container tare is not added) |