{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/lune/json-schema/lune-create-multi-leg-shipping-estimate-by-fuel-response-schema.json", "title": "CreateMultiLegShippingEstimateByFuelResponse", "x-generated": "2026-10-29", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/lune-openapi.yml#/components/schemas/CreateMultiLegShippingEstimateByFuelResponse", "type": "object", "required": [ "id", "quote", "request", "external_estimate_url", "legs", "mass", "is_shipment", "shipped_at", "data_quality_score", "created_at", "filename", "user_fullname" ], "properties": { "id": { "type": "string", "description": "The emission calculation unique identifier" }, "quote": { "$ref": "#/$defs/EstimateQuote" }, "request": { "$ref": "#/$defs/CreateMultiLegShippingEstimateByFuelRequest" }, "external_estimate_url": { "description": "An external accessible URL linking to a detailed page that provides complete information about the estimate.", "oneOf": [ { "$ref": "#/$defs/Url" }, { "$ref": "#/$defs/NullEnum" } ] }, "legs": { "description": "Emissions information for every input leg. Each item corresponds to the\nrespective item in the input `legs` array.\n", "type": "array", "minItems": 1, "maxItems": 10, "items": { "type": "object", "required": [ "emission_factor", "mass", "methodology_details" ], "properties": { "mass": { "$ref": "#/$defs/EstimateMassWithBreakdowns" }, "emission_factor": { "$ref": "#/$defs/EmissionFactorWithGasEmissions" }, "methodology_details": { "$ref": "#/$defs/FuelMethodologyDetails" } } } }, "mass": { "$ref": "#/$defs/EstimateMassWithBreakdowns" }, "is_shipment": { "$ref": "#/$defs/IsShipment" }, "shipped_at": { "$ref": "#/$defs/ShippedAt" }, "data_quality_score": { "description": "Represents the quality of the emission estimation.\n", "oneOf": [ { "type": "object", "required": [ "score" ], "properties": { "score": { "$ref": "#/$defs/DataQualityGrade" } } }, { "$ref": "#/$defs/NullEnum" } ] }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time when the estimate was created." }, "filename": { "description": "Name of the uploaded data sheet.", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/NullEnum" } ] }, "user_fullname": { "description": "Full name of the user that uploaded the data sheet.", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/NullEnum" } ] } }, "$defs": { "CreateMultiLegShippingEstimateByFuelRequest": { "type": "object", "required": [ "legs" ], "properties": { "legs": { "description": "Shipment legs fuel use information, can be only one leg if you only a single\ntransport to calculate emissions for.\n", "type": "array", "minItems": 1, "maxItems": 10, "items": { "type": "object", "required": [ "fuel", "fuel_consumed_litres" ], "properties": { "fuel": { "description": "The vehicle's fuel.", "type": "string", "enum": [ "gasoline", "diesel", "99_diesel_1_biodiesel", "98_diesel_2_biodiesel", "95_diesel_5_biodiesel", "93_diesel_7_biodiesel", "90_diesel_10_biodiesel", "80_diesel_20_biodiesel", "50_diesel_50_biodiesel", "ethanol_from_corn", "hvo_from_tallow", "lpg" ] }, "fuel_consumed_litres": { "description": "How much fuel was consumed by the shipment, in litres.", "type": "number", "format": "float", "minimum": 0.001 } } } }, "is_shipment": { "$ref": "#/$defs/IsShipment" }, "shipped_at": { "$ref": "#/$defs/ShippedAt" } } }, "CurrencyCode": { "x-lune-name": "Currency code", "type": "string", "description": "ISO 4217 3 character currency code.\n\nNote: Lune supports most but not all currency codes.\n", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "DataQualityGrade": { "type": "string", "description": "A quality grade ranging from \"A_plus\" (excellent) to \"D\" (unsatisfactory).\n", "enum": [ "A_plus", "A", "A_minus", "B_plus", "B", "B_minus", "C_plus", "C", "C_minus", "D" ] }, "DistanceUnit": { "x-lune-name": "Distance", "type": "string", "enum": [ "m", "km", "mi", "nm" ], "description": "Distance unit, `km` for kilometers, `mi` for miles and `nm` for nautical miles" }, "EmissionFactor": { "description": "An emission factors is a coefficient representing the amount of emissions per unit of activity, eg 0.354kgCO₂/USD.\n\nThe `source` property describes what database the emission factor has been ingested from.\n", "type": "object", "required": [ "id", "name", "source", "source_version", "publication_year", "numerator_unit", "denominator_unit", "created_at", "region", "category" ], "properties": { "id": { "description": "The emission factor unique identifier", "type": "string" }, "name": { "description": "The emission factor name", "type": "string" }, "source": { "$ref": "#/$defs/EmissionFactorSource" }, "source_version": { "description": "Source version of the emission factor.", "type": "string" }, "publication_year": { "description": "Publication year of the emission factor", "type": "number" }, "numerator_unit": { "description": "Numerator unit of the emission factor", "$ref": "#/$defs/MassUnit" }, "denominator_unit": { "description": "Denominator unit of the emission factor", "$ref": "#/$defs/EmissionFactorDenominatorUnit" }, "created_at": { "description": "Date of creation of the emission factor", "type": "string", "format": "date-time" }, "region": { "type": "string", "description": "The name of the region that the emission factor covers." }, "category": { "type": [ "string", "null" ], "description": "A category that describes the emission factor." } } }, "EmissionFactorDenominatorUnit": { "oneOf": [ { "$ref": "#/$defs/CurrencyCode" }, { "$ref": "#/$defs/DistanceUnit" }, { "type": "string", "x-lune-name": "Other units", "enum": [ "item", "MJ", "GJ", "guest*night", "room*night", "ha", "hour", "seconds", "kWh", "kWh ICV", "kWh LHV", "kWh HHV", "kWh SCV", "toe", "toe ICV", "toe HHV", "toe SCV", "GJ ICV", "GJ HHV", "GJ SCV", "MJ ICV", "kg", "kg*day", "km*year", "l", "Ml", "ml", "m*year", "cm2", "m2", "ha*year", "m2*year", "m3", "m3*km", "t*km", "person*km", "person*month", "vehicle*km", "meal", "t", "fte*working_hour", "TEU", "TEU*km", "p", "A4_sheets" ] } ] }, "EmissionFactorSource": { "type": "string", "enum": [ "epa", "exiobase", "ecoinvent", "beis", "lune", "glec", "emsa", "cbam", "ademe", "idemat", "iata", "ember", "ceda", "icct" ] }, "EmissionFactorWithGasEmissions": { "allOf": [ { "$ref": "#/$defs/EmissionFactor" }, { "type": "object", "required": [ "gas_emissions" ], "properties": { "gas_emissions": { "description": "Detailed information about the gas emissions.\n\nThis property is always set as of March 2024.\n", "oneOf": [ { "$ref": "#/$defs/GasEmissions" }, { "$ref": "#/$defs/NullEnum" } ] } } } ] }, "Error": { "type": "object", "description": "Individual error information", "required": [ "error_code", "message" ], "properties": { "error_code": { "type": "string", "description": "Immutable string representing a specific error.", "enum": [ "api_version_invalid", "account_suspended", "bundle_selection_ratios_invalid", "bundle_selection_bundle_invalid", "order_idempotency_already_exists", "order_quantity_invalid", "order_value_invalid", "bundle_id_invalid", "id_invalid", "distance_invalid", "test_account_name_update_disallowed", "validation_error", "bundle_selection_ratios_invalid_format", "address_not_found", "port_not_found", "locode_not_found", "airport_invalid", "webhook_limit_reached", "time_range_invalid", "exchange_rate_not_found", "live_account_required", "unauthorised", "estimate_not_found", "estimate_order_already_placed", "sustainability_page_slug_not_unique", "sustainability_page_exists", "pagination_limit_invalid", "unsupported_image_format", "source_location_code_invalid", "destination_location_code_invalid", "emission_factor_id_invalid", "emission_factor_unit_mismatch", "emission_factor_gated", "account_scope_incorrect", "service_unavailable", "handle_not_unique", "estimate_idempotency_already_exists", "airport_route_required", "future_departure_invalid", "transaction_document_inference_failure", "transaction_document_creation_failure", "invalid_selected_account_id", "account_idempotency_already_exists", "account_handle_idempotency_key_inconsistency", "shipment_batch_idempotency_already_exists", "route_not_found", "insufficient_credits", "client_account_mismatch" ] }, "message": { "type": "string", "description": "Human readable error message.\n\nThis value can contain some extra information about the error in\nhuman-readable form. Not suitable for programmatic consumption, the format\nis not guaranteed to be stable.\n" } } }, "ErrorResponse": { "x-lune-name": "Error response", "description": "An error response containing the error details.\n\nThe `error` property provides information about the type of error that occurred.\nUse this property for error handling.\n\nThe `errors` array is present for backwards compatibility purposes. It always\ncontains a single error element which is the same seen in the `error` property.\n", "type": "object", "required": [ "errors", "error" ], "properties": { "errors": { "type": "array", "description": "An array containing errors", "items": { "$ref": "#/$defs/Error" } }, "error": { "$ref": "#/$defs/Error" } } }, "EstimateMass": { "type": "object", "required": [ "amount", "unit" ], "properties": { "amount": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "unit": { "$ref": "#/$defs/EstimateMassUnit" } } }, "EstimateMassBreakdowns": { "type": "object", "required": [ "wtw_details", "pollutants" ], "properties": { "wtw_details": { "description": "This property is `null` for any estimate created before 30/01/2025", "oneOf": [ { "$ref": "#/$defs/WTWBreakdown" }, { "$ref": "#/$defs/NullEnum" } ] }, "pollutants": { "oneOf": [ { "$ref": "#/$defs/NullEnum" }, { "$ref": "#/$defs/PollutantBreakdown" } ] } } }, "EstimateMassUnit": { "type": "string", "description": "Unit, `t` for tonne, `kg` for kilogram, `g` for gram, `mg` for milligram, `lbs` for pound", "enum": [ "mg", "g", "kg", "t", "lbs" ] }, "EstimateMassWithBreakdowns": { "allOf": [ { "$ref": "#/$defs/EstimateMass" }, { "$ref": "#/$defs/EstimateMassBreakdowns" } ] }, "EstimateQuote": { "oneOf": [ { "x-lune-name": "Quoting error", "$ref": "#/$defs/ErrorResponse" }, { "x-lune-name": "Successful quote", "$ref": "#/$defs/OrderQuoteByQuantity" } ] }, "FuelMethodologyDetails": { "description": "Details about the parameters and calculations used in the methodology for estimating emissions by fuel.\n", "type": "object", "additionalProperties": false, "required": [ "energy_density" ], "properties": { "energy_density": { "type": "object", "additionalProperties": false, "description": "The fuel's energy density.\n\nEnergy density represents how much energy is stored in a litre of fuel.\n", "required": [ "amount", "unit" ], "properties": { "amount": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "unit": { "type": "string", "enum": [ "MJ/l" ] } } } } }, "GasEmissions": { "type": "object", "required": [ "co2e" ], "properties": { "co2e": { "description": "Amount of CO₂ equivalent gas. All gas emissions are accounted here.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "co2": { "description": "Amount of CO₂ gas.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "methane": { "description": "Amount of methane gas.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "nitrous_oxide": { "description": "Amount of nitrous oxide gas.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "other": { "description": "Amount of CO₂ equivalent gas contributed by other greenhouse gases.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "wtw_breakdown": { "$ref": "#/$defs/GasWTWBreakdown" } } }, "GasWTWBreakdown": { "type": "object", "required": [ "source", "wtt_co2e", "ttw_co2e" ], "properties": { "source": { "type": "string", "enum": [ "direct_from_source", "inferred_from_fuel", "global_fuel_mix_inferred" ] }, "wtt_co2e": { "description": "Amount of CO₂ equivalent for the WTT (Well-To-Tank) stage. All gas emissions are accounted here.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "ttw_co2e": { "description": "Amount of CO₂ equivalent for the TTW (Tank-To-Wheel) stage. All gas emissions are accounted here.", "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$" } } }, "IsShipment": { "type": "boolean", "description": "Use to distinguish confirmed shipments from quotes. Defaults to `false` when omitted. Can be updated at any point.\n\nThis property must be formatted as RFC 3339, section 5.6 timestamp.\n\nExamples:\n* 2023-12-01T12:30:30.000Z\n* 2023-12-01T12:30:30Z\n* 2023-12-01T11:30:30+01.00\n" }, "MassUnit": { "x-lune-name": "Mass", "type": "string", "description": "Unit, `t` for tonne, `kg` for kilogram, `g` for gram, `lbs` for pound", "enum": [ "g", "kg", "t", "lbs" ] }, "NullEnum": { "type": [ "string", "null" ], "x-lune-name": "Null", "description": "The property is set to `null`.", "enum": [ null ] }, "OrderBundle": { "type": "object", "required": [ "bundle_id", "bundle_name", "quantity", "unit_price", "gross_unit_price", "offset_cost", "insufficient_available_quantity" ], "properties": { "bundle_id": { "type": "string", "description": "The bundle's unique identifier" }, "bundle_name": { "type": "string", "description": "The bundle's name" }, "primary_image": { "type": "string", "description": "A bundle's image URL" }, "quantity": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$", "description": "Quantity for the specific bundle (tonnes CO2)" }, "unit_price": { "type": "string", "description": "Bundle unit price per tonne CO2\n\nUnit: order currency\n", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "gross_unit_price": { "type": "string", "description": "Bundle unit price per tonne CO2 inclusive of fees.\n\nUnit: order currency\n", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "offset_cost": { "type": "string", "description": "The bundle's net offset cost being purchased.\n\nUnit: order currency\n", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "insufficient_available_quantity": { "type": [ "boolean", "null" ], "description": "If true, there is no inventory necessary to fully satisfy the order for this bundle.\n" } } }, "OrderQuoteBase": { "type": "object", "required": [ "currency", "estimated_quantity", "estimated_commission", "estimated_offset_cost", "estimated_total_cost", "bundles" ], "properties": { "currency": { "type": "string", "description": "Currency code" }, "estimated_quantity": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$", "description": "Estimated quantity (tonnes CO2).\n\nMay be lower than `requested_quantity`.\n" }, "estimated_offset_cost": { "type": "string", "description": "Estimated offset cost\n\nUnit: order quote currency\n", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "estimated_total_cost": { "type": "string", "description": "Estimated total cost inclusive of Lune fees.\n\nUnit: order quote currency\n", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "estimated_commission": { "type": "string", "description": "Estimated commission", "pattern": "^[0-9]+(\\.[0-9]+)?$" }, "bundles": { "type": "array", "description": "Bundles included in the quote including quantity and cost breakdown.\n", "items": { "$ref": "#/$defs/OrderBundle" } } } }, "OrderQuoteByQuantity": { "allOf": [ { "$ref": "#/$defs/OrderQuoteBase" }, { "type": "object", "required": [ "requested_quantity", "requested_value" ], "properties": { "requested_quantity": { "type": "string", "pattern": "^[0-9]+(\\.[0-9]+)?$", "description": "Requested quantity for the specific bundle (tonnes CO2).\n\nrequested_quantity may be returned as part of an emission estimate response, in which case this property contains the equivalent value as the `mass` property.\n" }, "requested_value": { "description": "Requested value of CO2 offsets to purchase in the account's currency.", "type": [ "string", "null" ], "pattern": "^[0-9]+(\\.[0-9]+)?$" } } } ] }, "PollutantBreakdown": { "description": "Individual pollutants that are part of the estimated emissions.\n\n* `nox` - Nitrogen oxides\n* `nmhc` - Non-methane hydrocarbons\n* `so2` - Sulfur dioxide\n* `co2` - Carbon dioxide\n* `pm` - Particulate matter\n", "type": "object", "required": [ "nox", "nmhc", "so2", "co2", "pm" ], "properties": { "nox": { "$ref": "#/$defs/PollutantEmissions" }, "nmhc": { "$ref": "#/$defs/PollutantEmissions" }, "so2": { "$ref": "#/$defs/PollutantEmissions" }, "co2": { "$ref": "#/$defs/PollutantEmissions" }, "pm": { "$ref": "#/$defs/PollutantEmissions" } } }, "PollutantEmissions": { "type": "object", "required": [ "wtt", "ttw" ], "properties": { "wtt": { "$ref": "#/$defs/EstimateMass" }, "ttw": { "$ref": "#/$defs/EstimateMass" } } }, "ShippedAt": { "type": "string", "format": "date-time", "description": "Provide the shipment date and time, as RFC 3339 timestamp.\n\nIf omitted, the property defaults to the time of request. Used only for analytics, with no impact on the actual estimate calculation.\n" }, "Url": { "type": "string", "format": "https-url", "description": "An HTTPS URL.\n\nThe URL must match the following regular expression: `^https:\\/\\/[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#?&\\/\\/=]*)$`\n" }, "WTWBreakdown": { "type": "object", "required": [ "wtt", "ttw", "unknown" ], "properties": { "wtt": { "$ref": "#/$defs/EstimateMass" }, "ttw": { "$ref": "#/$defs/EstimateMass" }, "unknown": { "$ref": "#/$defs/EstimateMass" } } } } }