Lune Docs Logo
Log inContact us

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

By default estimate mass units are returned in tonnes.

Estimate mass units in responses are converted to estimate_mass_unit when set.

mg
g
kg
t
Request body

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

The vehicle's fuel.

gasoline
diesel
99_diesel_1_biodiesel
98_diesel_2_biodiesel
95_diesel_5_biodiesel

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

When true, the emission estimate refers to an actual shipment of goods, will be included in Lune analytics and can be included in any CO2 emissions reporting.

This property exists to distinguish booking quotes or forecasts from actual shipments where goods are moved.

You can mark an estimate as shipment at any time.

The date and time of shipping the goods for the purpose of analytics (it doesn't affect emission calculations in any way).

If a value is provided when creating or updating an estimate we use the value. Otherwise defaults to the current time when creating estimates and remains unchanged when updating estimates.

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
  • Sample request
  • Response

    The emission calculation unique identifier

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

    The vehicle's fuel.

    gasoline
    diesel
    99_diesel_1_biodiesel
    98_diesel_2_biodiesel
    95_diesel_5_biodiesel

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

    When true, the emission estimate refers to an actual shipment of goods, will be included in Lune analytics and can be included in any CO2 emissions reporting.

    This property exists to distinguish booking quotes or forecasts from actual shipments where goods are moved.

    You can mark an estimate as shipment at any time.

    The date and time of shipping the goods for the purpose of analytics (it doesn't affect emission calculations in any way).

    If a value is provided when creating or updating an estimate we use the value. Otherwise defaults to the current time when creating estimates and remains unchanged when updating estimates.

    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

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

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

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

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

    mg
    g
    kg
    t

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

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

    The emission factor unique identifier

    The emission factor name

    epa
    exiobase
    ecoinvent
    beis
    lune

    Source version of the emission factor.

    Publication year of the emission factor

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

    g
    kg
    t

    Denominator unit of the emission factor

    Date of creation of the emission factor

    The name of the region that the emission factor covers.

    A category that describes the emission factor.

    Detailed information about the gas emissions.

    This property is always set as of March 2024.

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

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

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

    Amount of CO₂ gas.

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

    Amount of methane gas.

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

    Amount of nitrous oxide gas.

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

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

    direct_from_source
    inferred_from_fuel
    global_fuel_mix_inferred

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

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

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

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

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

    The fuel's energy density.

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

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

    MJ/l

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

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

    mg
    g
    kg
    t

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

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

    When true, the emission estimate refers to an actual shipment of goods, will be included in Lune analytics and can be included in any CO2 emissions reporting.

    This property exists to distinguish booking quotes or forecasts from actual shipments where goods are moved.

    You can mark an estimate as shipment at any time.

    The date and time of shipping the goods for the purpose of analytics (it doesn't affect emission calculations in any way).

    If a value is provided when creating or updating an estimate we use the value. Otherwise defaults to the current time when creating estimates and remains unchanged when updating estimates.

    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
  • 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

    The estimate's unique identifier

    By default estimate mass units are returned in tonnes.

    Estimate mass units in responses are converted to estimate_mass_unit when set.

    mg
    g
    kg
    t
  • Sample request
  • Response

    The emission calculation unique identifier

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

    The vehicle's fuel.

    gasoline
    diesel
    99_diesel_1_biodiesel
    98_diesel_2_biodiesel
    95_diesel_5_biodiesel

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

    When true, the emission estimate refers to an actual shipment of goods, will be included in Lune analytics and can be included in any CO2 emissions reporting.

    This property exists to distinguish booking quotes or forecasts from actual shipments where goods are moved.

    You can mark an estimate as shipment at any time.

    The date and time of shipping the goods for the purpose of analytics (it doesn't affect emission calculations in any way).

    If a value is provided when creating or updating an estimate we use the value. Otherwise defaults to the current time when creating estimates and remains unchanged when updating estimates.

    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

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

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

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

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

    mg
    g
    kg
    t

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

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

    The emission factor unique identifier

    The emission factor name

    epa
    exiobase
    ecoinvent
    beis
    lune

    Source version of the emission factor.

    Publication year of the emission factor

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

    g
    kg
    t

    Denominator unit of the emission factor

    Date of creation of the emission factor

    The name of the region that the emission factor covers.

    A category that describes the emission factor.

    Detailed information about the gas emissions.

    This property is always set as of March 2024.

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

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

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

    Amount of CO₂ gas.

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

    Amount of methane gas.

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

    Amount of nitrous oxide gas.

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

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

    direct_from_source
    inferred_from_fuel
    global_fuel_mix_inferred

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

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

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

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

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

    The fuel's energy density.

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

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

    MJ/l

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

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

    mg
    g
    kg
    t

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

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

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

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

    mg
    g
    kg
    t

    When true, the emission estimate refers to an actual shipment of goods, will be included in Lune analytics and can be included in any CO2 emissions reporting.

    This property exists to distinguish booking quotes or forecasts from actual shipments where goods are moved.

    You can mark an estimate as shipment at any time.

    The date and time of shipping the goods for the purpose of analytics (it doesn't affect emission calculations in any way).

    If a value is provided when creating or updating an estimate we use the value. Otherwise defaults to the current time when creating estimates and remains unchanged when updating estimates.

    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
  • 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