Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

The following endpoint allow to get emissions data for transports that finished tracking.

Details on how Transporeon Visibility calculates carbon emissions data can be found in the following help center article: https://intercom.help/sixfold/en/articles/5800433-carbon-visibility-methodology

GET emissions for transports

Make an authenticated GET request as shown in the example below:

https://api.test.transporeon.com/rtv/v1/emissions

The response contains a list of transports, sorted by the transport’s tracking start time (newest - oldest).

For each transport, various emissions related fields can be present:

  • emissions_first_calculated_at& emissions_latest_calculated_at: First and latest time when the emissions were calculated.

  • calculation_errors: Details on the error in case the system wasn’t able to calculate the emissions.

  • planned_emissions: Details on the default emissions calculated based on the transport plan.

    • total_emissions: Accumulated emissions for all legs

    • legs: Listing of single legs used for emissions calculation. Leg definition needed?

      • emissions: Details to the emissions for each leg

      • transport_mode: Mode of the transport. Possible values: ROAD, RAIL, AIR, SEA, INLANDWATERWAYS, LOGISTICSITE

      • start_location& end_location: Latitude and longitude of leg start- and end location

      • distance_km: The distance of the leg in kilometers

      • type: Type of carriage for multimodal transports, possible values: PRE_CARRIAGE, MAINHAUL, POST_CARRIAGE

      • carriage_parameters: Details on the carriage, such as bio_fuel_shareand carriage_mode_parameters

      • external_costs: Details on the accident_, external_ and emissions_costas well as the total_external_costs in the specified currency

    • cargo: Details on the transported cargo, such as weight and volume.

    • transport_activity_tonne_kms: Quantifies the weight of cargo transported over distance. Calculated by multiplying the weight of the goods (in tonnes) by the distance traveled (in kilometers).

    • emissions_intensity_gram_per_tonne_kms: Amount of emissions produced for transporting one tonne of goods over one kilometer (g/tonne-km)

  • driven_distance: Driven distance in kilometers.

  • driven_distance_source: Source of the driven distance data. Possible values: TOTAL_DISTANCE_METERS, ODOMETER_KM

  • fuel_based_emissions: Fuel consumption, type and other details.

  • carbon_data_index: Composite metric used to evaluate the overall carbon efficiency of transportation activities. Shows how good data input was given to be used for calculations. If only shipper data is given, then this is low (below 20%), if also carrier primary data is available then it is higher, up to 100%. Higher is better.

  • visibility_stakeholders: Companies involved in the transport.

  • start_time: Initial planned start time of the transport.

Example:

{
  "transports": [
    {
      "transport_id": "314159",
      "emissions_first_calculated_at": "2019-08-24T14:15:22Z",
      "emissions_latest_calculated_at": "2019-08-24T14:15:22Z",
      "transport_number": "T1234",
      "calculation_errors": [
        {
          "error_type": "DISTANCE",
          "error_code": "TOUR_WEIGHT_OUT_OF_ALLOWED_RANGE",
          "error_message": "Skipping CO2 emissions calculation, weight data invalid, weightInTonnes: 0, main_mode: undefined"
        }
      ],
      "planned_emissions": {
        "total_emissions": {
          "co2_well_to_tank_tonnes": 0,
          "co2_tank_to_wheel_tonnes": 0,
          "co2_well_to_wheel_tonnes": 0
        },
        "legs": [
          {
            "emissions": [
              {
                "type": "CARBON_DIOXIDE",
                "emission_mode": "ROAD",
                "unit": "TONNES",
                "tank_to_wheel": 0,
                "well_to_tank": 0,
                "total": 0
              }
            ],
            "transport_mode": "ROAD",
            "start_location": {
              "lat": 0,
              "lng": 0
            },
            "end_location": {
              "lat": 0,
              "lng": 0
            },
            "type": "PRE_CARRIAGE",
            "carriage_parameters": {
              "bio_fuel_share": 0,
              "carriage_mode_parameters": [
                {
                  "mode": "ROAD",
                  "emission_class": "EuEuro6ac",
                  "empty_run_factor": 0,
                  "ferry_routing": "Normal",
                  "fuel_type": "diesel",
                  "load_factor": 0,
                  "lorry_class": "Class40",
                  "drive_class": "string",
                  "aircraft_type": "string",
                  "sea_ship_type": "string",
                  "inland_ship_type": "string"
                }
              ]
            },
            "distance_km": 0,
            "external_costs": {
              "currency": "Euro",
              "accident_costs": [
                {
                  "transport_mode": "ROAD",
                  "accident_cost_value": 0
                }
              ],
              "noise_costs": [
                {
                  "transport_mode": "ROAD",
                  "noise_costs_value": 0
                }
              ],
              "emission_costs": [
                {
                  "name": "SULFUR_DIOXIDES",
                  "tank_to_wheel": 0,
                  "well_to_tank": 0,
                  "total": 0
                }
              ],
              "total_external_costs": 0
            }
          }
        ],
        "cargo": {
          "container_empty_weight": 0,
          "tons_per_feu": 0,
          "tons_per_teu": 0,
          "unit": "string",
          "volume_weight": "AVERAGE",
          "weight": 0
        },
        "transport_activity_tonne_kms": 0,
        "emissions_intensity_gram_per_tonne_kms": 0
      },
      "driven_distance": 253.4,
      "driven_distance_source": "string",
      "fuel_based_emissions": {
        "accumulated_fuel_consumption_liters": 0,
        "fuel_type": "string",
        "co2_well_to_tank_tonnes": 0,
        "co2_tank_to_wheel_tonnes": 0,
        "co2_well_to_wheel_tonnes": 0,
        "transport_activity_tonne_kms": 0,
        "emissions_intensity_gram_per_tonne_kms": 0
      },
      "carbon_data_index": 0,
      "visibility_stakeholders": [
        {
          "company_id": "1337",
          "company_name": "A Corp."
        }
      ],
      "start_time": "2019-08-24T14:15:22Z"
    }
  ],
  "page_info": {
    "cursor": "c2l4Zm9sZF9hcGlfZXhhbXBsZQ=="
  }
}

Use query parameters to narrow down the results

You can use the following query parameters to narrow down the list of transports or find a specific one:

  • transport_number

  • transport_id
    --> see here for more details.

  • transport_filter:
    Transports with matching

    • transport_number

    • transport_id

    • delivery_number

    • purchase_order_number

    • order_number will be returned.

Supports partial search. This is especially helpful if the exact field used by the customer is not known / varies from customer to customer or if multiple transports/deliveries should be returned that match the same criteria.

  • vehicle_allocation_status: Whether the transport currently has an active vehicle allocation (allocated) or not (unallocated).

  • is_finished: See the definition here

  • start_time_before

  • start_time_after

  • end_time_before

  • end_time_after

  • company_id: The company_id of a company being part of that transport. Exposed in the visibility_stakeholders list.

  • custom_fields: The custom_fields exact key:value pair (for two key:value pairs search the result will be meeting at least one of them).

  • No labels

Transporeon status page I Privacy Policy I Imprint