Single leg

Deprecated. Please use the Multi leg method instead.

Create a shipping emission estimate (single)

HTTP POST to /v1/estimates/shipping

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

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

Sample request

Response

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

imo_unavailable_container_ship_fallback: the vessel IMO was not found, therefore a generic container ship emission factor has been used. flight_number_unavailable_fallback: the flight number could not be found or the aircraft is currently not supported, therefore a generic plane method has been used.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

converted_shipmentobjectrequirednullable

The shipment after conversion to the emission factor unit (mass to/from TEU).

null if no conversion was necessary.

amountstringrequired

unitoneOfrequired

shipment_conversion_methodstringrequirednullable

The method we used to convert the shipment to the emission factor unit.

null if no conversion was necessary.

user_provided_cargo_type

average_cargo_type

resolved_legsarrayrequirednullable

If the input shipping method results in multiple legs being detected, each leg will be calculated and shown separately.

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

methodoneOfrequired

idstringrequired

The emission calculation unique identifier

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.

quoteoneOfrequired

requestobjectrequired

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

external_estimate_urlstring (https-url)requirednullable

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

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

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

sourcestring

Identifies the source used to create the estimate.

api

dashboard

csv

chain_io

ecotransit_csv

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

List all shipping estimates

HTTP GET to /v1/estimates/shipping/allReturns single and multi-leg shipping estimates paginated in reverse order.

Query parameters

limitstring

Pattern: ^\d+$

Maximum number of resources to return, between 1 and 100.

afterstring

A cursor for use in pagination.

The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.

is_shipmentstring

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

When true, the estimate represents an actual shipment of goods and will be included in Lune analytics.

fromstring (date-time)

When set, the result includes estimates created at or after the timestamp.

Both from and through are either provided or missing.

throughstring (date-time)

When set, the result includes estimates created at or before the timestamp.

Both from and through are either provided or missing.

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

has_morebooleanrequired

Whether or not there are more elements available after this set.

If false, this set comprises the end of the array.

Part of a paginated response.

next_cursorstringrequirednullable

The cursor value to be used as the after parameter for fetching the next page of results.

null if has_more is false.

dataarrayrequired

Paginated single and multi-leg shipping emission estimates

oneOf

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 shipping emission estimate (single)

HTTP GET to /v1/estimates/shipping/{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

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

converted_shipmentobjectrequirednullable

The shipment after conversion to the emission factor unit (mass to/from TEU).

null if no conversion was necessary.

amountstringrequired

unitoneOfrequired

shipment_conversion_methodstringrequirednullable

The method we used to convert the shipment to the emission factor unit.

null if no conversion was necessary.

user_provided_cargo_type

average_cargo_type

resolved_legsarrayrequirednullable

If the input shipping method results in multiple legs being detected, each leg will be calculated and shown separately.

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

methodoneOfrequired

idstringrequired

The emission calculation unique identifier

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.

quoteoneOfrequired

requestobjectrequired

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

external_estimate_urlstring (https-url)requirednullable

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

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

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

sourcestring

Identifies the source used to create the estimate.

api

dashboard

csv

chain_io

ecotransit_csv

Sample response

Errors

This API operation can return the following errors:

HTTP status codeError code

401

404

429

503

service_unavailable

Update a shipping emission estimate (single)

HTTP PUT to /v1/estimates/shipping/{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

Request body

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

Sample request

Response

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

converted_shipmentobjectrequirednullable

The shipment after conversion to the emission factor unit (mass to/from TEU).

null if no conversion was necessary.

amountstringrequired

unitoneOfrequired

shipment_conversion_methodstringrequirednullable

The method we used to convert the shipment to the emission factor unit.

null if no conversion was necessary.

user_provided_cargo_type

average_cargo_type

resolved_legsarrayrequirednullable

If the input shipping method results in multiple legs being detected, each leg will be calculated and shown separately.

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

methodoneOfrequired

idstringrequired

The emission calculation unique identifier

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.

quoteoneOfrequired

requestobjectrequired

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

external_estimate_urlstring (https-url)requirednullable

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

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

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

sourcestring

Identifies the source used to create the estimate.

api

dashboard

csv

chain_io

ecotransit_csv

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

Update a shipping emission estimate's annotations

HTTP PATCH to /v1/estimates/shipping/{id}/annotationsThis method allows updating a selection of estimate annotations without going through a full estimate update (with all the necessary inputs).Only properties included in the input data are updated.

Query parameters

idstringrequired

The estimate's unique identifier

Request body

oneOf

Sample request

Response

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

converted_shipmentobjectrequirednullable

The shipment after conversion to the emission factor unit (mass to/from TEU).

null if no conversion was necessary.

amountstringrequired

unitoneOfrequired

shipment_conversion_methodstringrequirednullable

The method we used to convert the shipment to the emission factor unit.

null if no conversion was necessary.

user_provided_cargo_type

average_cargo_type

resolved_legsarrayrequirednullable

If the input shipping method results in multiple legs being detected, each leg will be calculated and shown separately.

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

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

vessel_inference_detailsoneOf

The method we used to infer a vessel from client provided input.

null when vessel identifier provided by client or no vessel inference not relevant to estimation.

raw_distanceobject

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobject

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobject

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

distance_calculation_methodstringrequirednullable

The method we used to determine the shipping distance.

null in case of logistics sites or when resolved_legs is set.

great_circle_distance

great_circle_distance_x2

sea_distance_algorithm

mapbox

user_input

activityobjectrequirednullable

valuestringrequired

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

The transport activity being measured.

For example, if you are measuring a truck transporting 4 tonnes of goods that traveled 15.25 kilometers, the activity value would be 61 t*km

unitstringrequired

The units of the transport activity being measured.

t*km

t

intensityobjectrequirednullable

wttobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

ttwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

wtwobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

unknownobjectrequired

amountstringrequired

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

unitstringrequired

Carbon intensity in CO2 equivalents.

Example: t_per_tkm for tonnes of CO2 equivalent per tonne-kilometre,

t_per_tkm

kg_per_tkm

g_per_tkm

mg_per_tkm

t_per_t

routeobjectrequirednullable

The shipping route.

null in case of logistics sites and situations where the concept of a route doesn't make sense or we're unable to return the route. That includes the following situations at the moment:

Routes where source or destination is an address (or both are).
Most land and inland waterways routes.
The actual distance value was provided by the user.
The emission estimate was created before 2023-09-22.

sourceobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

legsarrayrequired

object

A location and a distance from the previous location (or source, if this is the first leg).

If this is the last leg then the location is the final location (destination) of the route.

locationobjectrequired

labelstringrequirednullable

coordinatesobjectrequired

latnumberrequired

Latitude

lonnumberrequired

Longitude

raw_distanceobjectrequired

amountstringrequired

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

unitstringrequired

A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.

km

mi

nm

distanceobjectrequired

amountstringrequired

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

unitstringrequired

The estimated distance. Unit, km for kilometers, mi for miles

km

mi

nm

adjusted_distanceobjectrequired

Deprecated. This value is the same as Distance.

amountstringrequired

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

unitstringrequired

km

mi

nm

attributionstringrequirednullable

Attribution for the route provider, if applicable.

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.

methodologyarrayrequired

Summary of the methodology used to calculate emissions or any value which is a prerequisite.

string

imo_unavailable_container_ship_fallback

imo_unavailable_container_ship_trade_lane_fallback

flight_number_unavailable_fallback

invalid_flight_route_fallback

distance_calculation_detailsobjectrequirednullable

Information regarding why an alternative distance calculation method was used. null in case several resolved legs are presented.

vessel_trackingoneOfrequired

carrier_schedule_stopsobjectrequirednullable

messagestringrequired

The human-readable message describing the details of how we used or failed to use carrier schedule stops to calculate the route.

The property is meant only for informational purposes and its exact format can change.

methodology_detailsoneOfrequired

data_quality_scoreobjectrequirednullable

Represents the quality of the emission estimation for a particular shipping leg.

scorestringrequired

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

A_plus

A

A_minus

B_plus

B

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

inference_detailsobjectnullable

Lune infers certain properties to improve estimation accuracy. Any inferences made will be described in this property.

trade_lane_from_routestring

The trade lane Lune has inferred as most likely for the shipment's route.

rail_type_from_routeobjectrequirednullable

Inferred rail transport type based on the shipment's route.

rail_typestringrequired

electric_freight_train

diesel_freight_train

source_countrystringrequired

destination_countrystringrequired

cleaned_routeobjectrequirednullable

Routes that have been cleaned, corrected, and had missing parts inferred using a large language model

sourceoneOfrequired

destinationoneOfrequired

road_emission_standardobjectrequirednullable

The road emission standard trade has inferred via country information in the shipment's route.

valuestringrequired

The vehicle's emission standard for pollution.

euro1

euro2

euro3

euro4

euro5

fromstringrequired

source

destination

both

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

destination_country_codestringrequirednullable

Inferred destination country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

destination_regionstringrequirednullable

Inferred destination country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_truck_typeobjectrequirednullable

The truck type infered via the shipment's route and shipment mass.

valuestringrequired

truck_generic_van

truck_rigid_7_5t

truck_rigid_12t

truck_rigid_20t

truck_rigid_26t

is_international_shipmentbooleanrequired

road_fuelobjectrequirednullable

The road fuel has inferred via source country information in the shipment's route.

valuestringrequired

The vehicle's infered fuel.

gasoline

diesel

99_diesel_1_biodiesel

98_diesel_2_biodiesel

95_diesel_5_biodiesel

source_country_codestringrequirednullable

Inferred source country code

AFG

ALA

ALB

DZA

ASM

source_regionstringrequirednullable

Inferred source country region, present when region information was used to infer the standard

Africa

Asia and Pacific

North America

Central and South America

Europe

road_gradientobjectrequirednullable

The road gradient inferred via elevation data for the shipment's route.

valuestringrequired

Describes the road's topology.

flat

hilly

mountainous

road_situationobjectrequirednullable

The road situation inferred via the road types and traffic conditions for the route.

valuestringrequired

Situation describes the driving environment and road condition.

city_urban_freeflow

motorway_urban_freeflow

motorway_rural_freeflow

city_urban_heavy_traffic

city_urban_stop_and_go

methodoneOfrequired

idstringrequired

The emission calculation unique identifier

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.

quoteoneOfrequired

requestobjectrequired

Parameters for estimating shipping emissions

shipmentoneOfrequired

Provide the shipment weight using either mass (in grams, kilograms, or tonnes) or containers (in Twenty-foot Equivalent Units, or TEUs).

When using containers, you can optionally include mass and cargo_type for more accurate estimates.

namestring

A name to reference this calculation.

bundle_selectionarray

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

object

Maps a bundle id to an allocation ratio

bundle_idstringrequired

The bundle's unique identifier

percentageoneOf

quantity_truncstring

Selects to which precision to truncate quantities specific to carbon offsetting.

g

kg

t

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.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
Clients can use idempotency_key to reconcile estimates with entities on their system.

oneOf

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

external_estimate_urlstring (https-url)requirednullable

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

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

componentsobjectrequired

emission_factor_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

route_scorestringrequirednullable

A_plus

A

A_minus

B_plus

B

shipment_scorestringrequired

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

A_plus

A

A_minus

B_plus

B

sourcestring

Identifies the source used to create the estimate.

api

dashboard

csv

chain_io

ecotransit_csv

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

Single leg

Create a shipping emission estimate (single)

Query parameters

Request body

namestring

bundle_selectionarray

object

bundle_idstringrequired

quantity_truncstring

is_shipmentboolean

shipped_atstring (date-time)

metadataobject

idempotency_keystring

Response

massobjectrequired

amountstringrequired

unitstringrequired

wtw_detailsobjectrequired.css-1yk938h{margin:0;font-family:Helvetica Neue,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:17px;letter-spacing:0;text-align:left;color:#212121;color:#2864D9;}nullable

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

unknownobjectrequired

amountstringrequired

unitstringrequired

pollutantsobjectrequirednullable

noxobjectrequired

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

nmhcobjectrequired

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

so2objectrequired

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

co2objectrequired

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

pmobjectrequired

wttobjectrequired

amountstringrequired

unitstringrequired

ttwobjectrequired

amountstringrequired

unitstringrequired

metadataobject

idempotency_keystring

raw_distanceobject

amountstringrequired

unitstringrequired

distanceobject

amountstringrequired

unitstringrequired

adjusted_distanceobject

amountstringrequired

unitstringrequired

distance_calculation_methodstringrequirednullable

activityobjectrequirednullable

valuestringrequired

unitstringrequired

intensityobjectrequirednullable

wttobjectrequired

wtw_detailsobjectrequirednullable