Skip to main content

Transport Tools

Query upstream and downstream transport records — goods transportation with routes, distances, and CO₂e emissions. This covers Scope 3 Category 4 (upstream transportation) and Category 9 (downstream transportation).

list_transports

List upstream/downstream transport records with routes, distances, and CO₂e emissions. Use transport_direction to separate inbound raw materials (upstream) from outbound product distribution (downstream). Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringNodefault orgOrganization UUID
searchstringNoSearch by description
statusstringNoStatus filter: active, deleted
transport_directionstringNoDirection: upstream or downstream
from_datestringNoFilter from this date (YYYY-MM-DD)
to_datestringNoFilter until this date (YYYY-MM-DD)
pageintegerNo1Page number
sizeintegerNo50Results per page
Example response:
{
  "items": [
    {
      "id": "a3f1b2c4-...",
      "name": "Raw materials from supplier",
      "transport_date": "2024-06-15",
      "transport_direction": "upstream",
      "transport_frequency": "once",
      "quantity_transported": 2500.0,
      "supplier": "Acme Logistics",
      "status": "active",
      "co2e": 145.3,
      "unit": {
        "id": "61743a63-...",
        "name": "kilogram_(kg)",
        "type": "weight"
      },
      "sections": [
        {
          "id": "sec-1a2b3c4d-...",
          "part": 1,
          "origin": "Barcelona, Spain",
          "origin_geocode": {
            "country_code": "ES",
            "place_id": "ChIJ5TCOcRaYpBIRCmZHTz37sEQ",
            "address_formatted": "Barcelona, Spain",
            "latitude": 41.3874,
            "longitude": 2.1686
          },
          "destination": "Madrid, Spain",
          "destination_geocode": {
            "country_code": "ES",
            "place_id": "ChIJgTwKgJcpQg0RaSKMYcHeNsQ",
            "address_formatted": "Madrid, Spain",
            "latitude": 40.4168,
            "longitude": -3.7038
          },
          "transport_type": "road",
          "electric": false,
          "refrigerated": false,
          "kms": 620.0,
          "kms_source": "google_maps",
          "status": "active",
          "reference_product": null,
          "emissions": [
            { "value": 145.3, "gas": "co2e", "unit_name": "kgCO2e" }
          ]
        }
      ],
      "created_at": "2024-06-10T08:00:00Z"
    }
  ],
  "total": 156,
  "page": 1,
  "size": 50,
  "pages": 4
}
Key response fields:
FieldDescription
transport_directionupstream (suppliers → you) or downstream (you → customers)
transport_frequencyonce, weekly, or monthly
quantity_transportedAmount transported in the unit specified by unit.name
supplierSupplier or carrier name
co2eTotal CO₂e emissions in kg across all sections
sectionsRoute legs with origin/destination, geocodes, distance (kms), and per-section emissions
sections[].transport_typeroad, air, rail, maritime, or do_not_know
sections[].kmsCalculated or user-provided distance in kilometers
sections[].origin_geocodeGeocoded origin with lat/lon and country code (null if not geocoded)
Example prompts:
"Show our upstream transport records for 2024"
"List downstream transports to Madrid"
"What are our transport emissions from Barcelona routes?"
"Show all transports from supplier Acme"
"List one-time transports in Q1 2025"

Workflow

  1. List transportslist_transports filtered by direction, date range, or search
  2. View emissionsget_greenhouse_gas_emissions with category=transport_distribution_upstream or category=transport_distribution_downstream for aggregated totals
  3. View logisticslist_logistics_requests for GLEC-framework logistics calculations

Logistics

GLEC-framework logistics calculations

Emissions

Aggregated Scope 3 transport emissions

API Reference

REST API endpoints for transport records