By fuel consumption

Create a multi-leg shipping emission estimate based on fuel usage.

HTTP POST to /v1/estimates/shipping/multi-leg/by-fuel

Query parameters

estimate_mass_unitstring

Specify the unit the emission estimate mass should be returned in. Defaults to tonnes (t) if not specified.

mg

g

kg

t

Request body

legsarrayrequired

Shipment legs fuel use information, can be only one leg if you only a single transport to calculate emissions for.

object

fuelstringrequired

The vehicle's fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

fuel_consumed_litresnumber (float)required

How much fuel was consumed by the shipment, in litres.

is_shipmentboolean

Use to distinguish confirmed shipments from quotes. Defaults to false when omitted. Can be updated at any point.

This property must be formatted as RFC 3339, section 5.6 timestamp.

Examples:

2023-12-01T12:30:30.000Z
2023-12-01T12:30:30Z
2023-12-01T11:30:30+01.00

shipped_atstring (date-time)

Provide the shipment date and time, as RFC 3339 timestamp.

If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.

Sample request

Response

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired

requestobjectrequired

legsarrayrequired

Shipment legs fuel use information, can be only one leg if you only a single transport to calculate emissions for.

object

fuelstringrequired

The vehicle's fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

fuel_consumed_litresnumber (float)required

How much fuel was consumed by the shipment, in litres.

is_shipmentboolean

Use to distinguish confirmed shipments from quotes. Defaults to false when omitted. Can be updated at any point.

This property must be formatted as RFC 3339, section 5.6 timestamp.

Examples:

2023-12-01T12:30:30.000Z
2023-12-01T12:30:30Z
2023-12-01T11:30:30+01.00

shipped_atstring (date-time)

Provide the shipment date and time, as RFC 3339 timestamp.

If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.

external_estimate_urlstring (https-url)requirednullable

An external accessible URL linking to a detailed page that provides complete information about the estimate.

legsarrayrequired

Emissions information for every input leg. Each item corresponds to the respective item in the input legs array.

object

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

wtw_detailsobjectrequirednullable

This property is null for any estimate created before 30/01/2025

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

unknownobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pollutantsobjectrequirednullable

noxobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

nmhcobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

so2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

co2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pmobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

emission_factorobjectrequired

idstringrequired

The emission factor unique identifier

namestringrequired

The emission factor name

sourcestringrequired

epa

exiobase

ecoinvent

beis

lune

source_versionstringrequired

Source version of the emission factor.

publication_yearnumberrequired

Publication year of the emission factor

numerator_unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram

g

kg

t

denominator_unitoneOfrequired

Denominator unit of the emission factor

created_atstring (date-time)required

Date of creation of the emission factor

regionstringrequired

The name of the region that the emission factor covers.

categorystringrequirednullable

A category that describes the emission factor.

gas_emissionsobjectrequirednullable

Detailed information about the gas emissions.

This property is always set as of March 2024.

co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent gas. All gas emissions are accounted here.

co2string

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ gas.

methanestring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of methane gas.

nitrous_oxidestring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of nitrous oxide gas.

otherstring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent gas contributed by other greenhouse gases.

wtw_breakdownobject

sourcestringrequired

direct_from_source

inferred_from_fuel

global_fuel_mix_inferred

wtt_co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent for the WTT (Well-To-Tank) stage. All gas emissions are accounted here.

ttw_co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent for the TTW (Tank-To-Wheel) stage. All gas emissions are accounted here.

methodology_detailsobjectrequired

Details about the parameters and calculations used in the methodology for estimating emissions by fuel.

energy_densityobjectrequired

The fuel's energy density.

Energy density represents how much energy is stored in a litre of fuel.

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

MJ/l

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

wtw_detailsobjectrequirednullable

This property is null for any estimate created before 30/01/2025

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

unknownobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pollutantsobjectrequirednullable

noxobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

nmhcobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

so2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

co2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pmobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

is_shipmentbooleanrequired

Use to distinguish confirmed shipments from quotes. Defaults to false when omitted. Can be updated at any point.

This property must be formatted as RFC 3339, section 5.6 timestamp.

Examples:

2023-12-01T12:30:30.000Z
2023-12-01T12:30:30Z
2023-12-01T11:30:30+01.00

shipped_atstring (date-time)required

Provide the shipment date and time, as RFC 3339 timestamp.

If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation.

scorestringrequired

A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).

A_plus

A

A_minus

B_plus

B

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found

Get a multi-leg shipping emission estimate based on fuel usage.

HTTP GET to /v1/estimates/shipping/multi-leg/by-fuel/{id}

Query parameters

idstringrequired

The estimate's unique identifier

estimate_mass_unitstring

Specify the unit the emission estimate mass should be returned in. Defaults to tonnes (t) if not specified.

mg

g

kg

t

Sample request

Response

idstringrequired

The emission calculation unique identifier

quoteoneOfrequired

requestobjectrequired

legsarrayrequired

Shipment legs fuel use information, can be only one leg if you only a single transport to calculate emissions for.

object

fuelstringrequired

The vehicle's fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

fuel_consumed_litresnumber (float)required

How much fuel was consumed by the shipment, in litres.

is_shipmentboolean

Use to distinguish confirmed shipments from quotes. Defaults to false when omitted. Can be updated at any point.

This property must be formatted as RFC 3339, section 5.6 timestamp.

Examples:

2023-12-01T12:30:30.000Z
2023-12-01T12:30:30Z
2023-12-01T11:30:30+01.00

shipped_atstring (date-time)

Provide the shipment date and time, as RFC 3339 timestamp.

If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.

external_estimate_urlstring (https-url)requirednullable

An external accessible URL linking to a detailed page that provides complete information about the estimate.

legsarrayrequired

Emissions information for every input leg. Each item corresponds to the respective item in the input legs array.

object

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

wtw_detailsobjectrequirednullable

This property is null for any estimate created before 30/01/2025

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

unknownobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pollutantsobjectrequirednullable

noxobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

nmhcobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

so2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

co2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pmobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

emission_factorobjectrequired

idstringrequired

The emission factor unique identifier

namestringrequired

The emission factor name

sourcestringrequired

epa

exiobase

ecoinvent

beis

lune

source_versionstringrequired

Source version of the emission factor.

publication_yearnumberrequired

Publication year of the emission factor

numerator_unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram

g

kg

t

denominator_unitoneOfrequired

Denominator unit of the emission factor

created_atstring (date-time)required

Date of creation of the emission factor

regionstringrequired

The name of the region that the emission factor covers.

categorystringrequirednullable

A category that describes the emission factor.

gas_emissionsobjectrequirednullable

Detailed information about the gas emissions.

This property is always set as of March 2024.

co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent gas. All gas emissions are accounted here.

co2string

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ gas.

methanestring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of methane gas.

nitrous_oxidestring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of nitrous oxide gas.

otherstring

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent gas contributed by other greenhouse gases.

wtw_breakdownobject

sourcestringrequired

direct_from_source

inferred_from_fuel

global_fuel_mix_inferred

wtt_co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent for the WTT (Well-To-Tank) stage. All gas emissions are accounted here.

ttw_co2estringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

Amount of CO₂ equivalent for the TTW (Tank-To-Wheel) stage. All gas emissions are accounted here.

methodology_detailsobjectrequired

Details about the parameters and calculations used in the methodology for estimating emissions by fuel.

energy_densityobjectrequired

The fuel's energy density.

Energy density represents how much energy is stored in a litre of fuel.

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

MJ/l

massobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

wtw_detailsobjectrequirednullable

This property is null for any estimate created before 30/01/2025

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

unknownobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pollutantsobjectrequirednullable

noxobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

nmhcobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

so2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

co2objectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

pmobjectrequired

wttobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

ttwobjectrequired

amountstringrequired

Pattern: ^[0-9]+(\.[0-9]+)?$

unitstringrequired

Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

mg

g

kg

t

is_shipmentbooleanrequired

Use to distinguish confirmed shipments from quotes. Defaults to false when omitted. Can be updated at any point.

This property must be formatted as RFC 3339, section 5.6 timestamp.

Examples:

2023-12-01T12:30:30.000Z
2023-12-01T12:30:30Z
2023-12-01T11:30:30+01.00

shipped_atstring (date-time)required

Provide the shipment date and time, as RFC 3339 timestamp.

If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation.

scorestringrequired

A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).

A_plus

A

A_minus

B_plus

B

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

400

api_version_invalid

400

bundle_selection_ratios_invalid

400

bundle_selection_bundle_invalid

400

order_value_invalid

400

bundle_id_invalid

400

id_invalid

400

distance_invalid

400

test_account_name_update_disallowed

400

bundle_selection_ratios_invalid_format

400

address_not_found