General
Create a shipping emission estimate (multi-leg)
POST to /v1/estimates/shipping/multi-legCalculate an emission estimate for your shipment. The shipment may consist of a single leg or multiple legs, with each leg using a different mode of transport.Query parameters
estimate_mass_unitstring
Specify the unit the emission estimate mass should be returned in. Defaults to tonnes (t) if not specified.
mggkgtapply_route_inferencestring
Specify whether to apply road transfer inference to the estimate calculation.
Request body
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
Response
An emission estimate result for a transport involving multiple legs.
Lune's API returns both the total emissions and per-leg emissions (in the legs
property).
The ordering of the legs in the estimate is the same as the ordering of the inputs.
An error with estimating any of the legs will result in the whole estimation process failing completely (we don't provide partial estimates in light of a failure).
is_shipmentbooleanrequired
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.
shipped_atstring (date-time)required
Provide the shipment date and time, as RFC 3339 timestamp.
If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.
data_quality_scoreobjectrequirednullable
Represents the average data quality score for each leg.
scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBlegsarrayrequired
An array representing a leg's emission estimate.
Returned in the same order as the request.
object
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
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_typeaverage_cargo_typeresolved_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
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
methodoneOfrequired
raw_distanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmrequestobjectrequired
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
external_estimate_urlstring (https-url)requirednullable
An external accessible URL linking to a detailed page that provides complete information about the estimate.
sourcestring
Identifies the source used to create the estimate.
apidashboardcsvchain_ioecotransit_csvmassobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequired
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet a shipping emission estimate (multi-leg)
GET to /v1/estimates/shipping/multi-leg/{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.
mggkgtResponse
An emission estimate result for a transport involving multiple legs.
Lune's API returns both the total emissions and per-leg emissions (in the legs
property).
The ordering of the legs in the estimate is the same as the ordering of the inputs.
An error with estimating any of the legs will result in the whole estimation process failing completely (we don't provide partial estimates in light of a failure).
is_shipmentbooleanrequired
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.
shipped_atstring (date-time)required
Provide the shipment date and time, as RFC 3339 timestamp.
If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.
data_quality_scoreobjectrequirednullable
Represents the average data quality score for each leg.
scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBlegsarrayrequired
An array representing a leg's emission estimate.
Returned in the same order as the request.
object
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
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_typeaverage_cargo_typeresolved_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
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
methodoneOfrequired
raw_distanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmrequestobjectrequired
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
external_estimate_urlstring (https-url)requirednullable
An external accessible URL linking to a detailed page that provides complete information about the estimate.
sourcestring
Identifies the source used to create the estimate.
apidashboardcsvchain_ioecotransit_csvmassobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequired
Errors
This API operation can return the following errors:401404429503service_unavailableUpdate a shipping emission estimate (multi-leg)
PUT to /v1/estimates/shipping/multi-leg/{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.
mggkgtapply_route_inferencestring
Specify whether to apply road transfer inference to the estimate calculation.
Request body
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
Response
An emission estimate result for a transport involving multiple legs.
Lune's API returns both the total emissions and per-leg emissions (in the legs
property).
The ordering of the legs in the estimate is the same as the ordering of the inputs.
An error with estimating any of the legs will result in the whole estimation process failing completely (we don't provide partial estimates in light of a failure).
is_shipmentbooleanrequired
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.
shipped_atstring (date-time)required
Provide the shipment date and time, as RFC 3339 timestamp.
If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.
data_quality_scoreobjectrequirednullable
Represents the average data quality score for each leg.
scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBlegsarrayrequired
An array representing a leg's emission estimate.
Returned in the same order as the request.
object
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
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_typeaverage_cargo_typeresolved_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
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
methodoneOfrequired
raw_distanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmrequestobjectrequired
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
external_estimate_urlstring (https-url)requirednullable
An external accessible URL linking to a detailed page that provides complete information about the estimate.
sourcestring
Identifies the source used to create the estimate.
apidashboardcsvchain_ioecotransit_csvmassobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequired
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundUpdate a multi-leg shipping emission estimate's annotations
PATCH to /v1/estimates/shipping/multi-leg/{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
Response
An emission estimate result for a transport involving multiple legs.
Lune's API returns both the total emissions and per-leg emissions (in the legs
property).
The ordering of the legs in the estimate is the same as the ordering of the inputs.
An error with estimating any of the legs will result in the whole estimation process failing completely (we don't provide partial estimates in light of a failure).
is_shipmentbooleanrequired
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.
shipped_atstring (date-time)required
Provide the shipment date and time, as RFC 3339 timestamp.
If omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.
data_quality_scoreobjectrequirednullable
Represents the average data quality score for each leg.
scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBlegsarrayrequired
An array representing a leg's emission estimate.
Returned in the same order as the request.
object
massobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
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_typeaverage_cargo_typeresolved_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
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto 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.
kmminmdistanceobject
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobject
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmdistance_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_distancegreat_circle_distance_x2sea_distance_algorithmmapboxuser_inputrouteobjectrequirednullable
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.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmemission_factorobjectrequired
idstringrequired
The emission factor unique identifier
namestringrequired
The emission factor name
sourcestringrequired
epaexiobaseecoinventbeislunesource_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
gkgtdenominator_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_sourceinferred_from_fuelglobal_fuel_mix_inferredwtt_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_fallbackimo_unavailable_container_ship_trade_lane_fallbackflight_number_unavailable_fallbackinvalid_flight_route_fallbackdistance_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_plusAA_minusB_plusBcomponentsobjectrequired
emission_factor_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBroute_scorestringrequirednullable
A_plusAA_minusB_plusBshipment_scorestringrequired
A quality grade ranging from "A_plus" (excellent) to "D" (unsatisfactory).
A_plusAA_minusB_plusBinference_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_traindiesel_freight_trainsource_countrystringrequired
destination_countrystringrequired
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.
euro1euro2euro3euro4euro5fromstringrequired
sourcedestinationbothsource_country_codestringrequirednullable
Inferred source country code
AFGALAALBDZAASMdestination_country_codestringrequirednullable
Inferred destination country code
AFGALAALBDZAASMsource_regionstringrequirednullable
Inferred source country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuropedestination_regionstringrequirednullable
Inferred destination country region, present when region information was used to infer the standard
AfricaAsia and PacificNorth AmericaCentral and South AmericaEuroperoad_truck_typeobjectrequirednullable
The truck type infered via the shipment's route and shipment mass.
valuestringrequired
truck_generic_vantruck_rigid_7_5ttruck_rigid_12ttruck_rigid_20ttruck_rigid_26tis_international_shipmentbooleanrequired
methodoneOfrequired
raw_distanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
A raw estimate of distance before GLEC required Distance Adjustment Factors are applied.
kmminmdistanceobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
The estimated distance. Unit, km for kilometers, mi for miles
kmminmadjusted_distanceobjectrequired
Deprecated. This value is the same as Distance.
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
kmminmrequestobjectrequired
Calculate an emission estimate for shipments with one or more legs.
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.
legsarrayrequired
An array representing all the legs of a shipment.
oneOf
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.
gkgtis_shipmentboolean
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.
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_keyto reconcile estimates with entities on their system.
client_accountoneOf
Perform the estimate request on behalf of a client account.
The client account is identfied by the handle or idempotency_key.
The client account is created if it does not exist.
For existing client accounts, if both handle and idempotency_key are provided,
they must be consistent with the existing client account. Other properties are ignored.
external_estimate_urlstring (https-url)requirednullable
An external accessible URL linking to a detailed page that provides complete information about the estimate.
sourcestring
Identifies the source used to create the estimate.
apidashboardcsvchain_ioecotransit_csvmassobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtwtw_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
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtunknownobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpollutantsobjectrequirednullable
noxobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtnmhcobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtso2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtco2objectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtpmobjectrequired
wttobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtttwobjectrequired
amountstringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
unitstringrequired
Unit, t for tonne, kg for kilogram, g for gram, mg for milligram
mggkgtmetadataobject
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_keyto reconcile estimates with entities on their system.
idstringrequired
The emission calculation unique identifier
quoteoneOfrequired
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_found