Skip to main content

Tank Wagon Lob All Ep

POST 
/v1/tank_wagon/lob/all

Tank Wagon Left On Board

Returns the fuel left on board (LOB) in every compartment of each tank wagon tractor and trailer, as of a point in time. Each record is the latest LOB reading for that piece of equipment at or before as_of. The driver records the reading, and a dispatcher can edit it. There is one record per tractor and one per trailer.

Required Scopes (io.r)

Request​

Every filter you add narrows the results. With no filters, every tank wagon tractor and trailer with a LOB reading at or before as_of is returned. Equipment that has no reading yet is not returned.

as_of: datetime = now
The point in time to report. A reading taken exactly at as_of is included. A time without an offset is read as UTC.

equipment_ids: list[str] | None = None
equipment_names: list[str] | None = None
equipment_type: str | None = None
The tractors or trailers to report, by id or unit number. equipment_type is tractor or trailer.

driver_ids: list[str] | None = None
market_ids: list[str] | None = None
market_names: list[str] | None = None
depot_ids: list[str] | None = None
depot_names: list[str] | None = None
Matched against the equipment's most recent shift at or before as_of.

manually_adjusted: bool | None = None
true returns only equipment whose actual_lob_volume differs from its expected_lob_volume by a gallon or more. false returns only equipment where they match.


Response​

as_of: datetime
The time reported, in UTC.

volume_basis: str
Always gross.

row_count: int
The number of records in rows.

rows: list[LobOnBoardRow]
One record per tractor or trailer, sorted by equipment_id.

LobOnBoardRow​

equipment_id, equipment_name: str
equipment_type: str
The tractor or trailer. equipment_name is the unit number.

market_id, market_name, depot_id, depot_name: str | None
driver_id, driver_name: str | None
Taken from the equipment's most recent shift at or before as_of, so a depot set on the shift wins over the equipment's home depot, which is used only when the shift names none. The driver is the last driver, even after that shift has ended.

total_volume: float
The sum of actual_lob_volume across the compartments.

total_capacity: int
The sum of the compartment capacities, in gallons.

manually_adjusted: bool
true when any compartment's actual_lob_volume differs from its expected_lob_volume by a gallon or more, after rounding.

attributes: list[AppliedAttribute] = []
The custom attributes set on the tractor or trailer today, not as of as_of. Same shape as /v1/tractor/all, /v1/trailer/all and /v1/tank_wagon/order_movement/all:

  • id: the attribute definition id
  • name: the attribute definition name (null if the definition no longer exists)
  • value_type: boolean, number, string, or presence-only exists (null if the definition no longer exists)
  • value: the value set on the piece

compartments​

index: int
The compartment's position on its tractor or trailer, starting at 0.

capacity: int | None
From the equipment's configuration, in gallons.

product_id, product_name, product_group, product_short_name: str | None
The product the reading names for the compartment.

expected_lob_volume: float
What the compartment should have held, from the loads and deliveries before the reading.

actual_lob_volume: float
The reading itself.

Responses​

Successful Response

{
  "as_of": "2026-11-11T17:36:46.036Z",
  "volume_basis": "gross",
  "row_count": 0,
  "rows": [
    {
      "equipment_id": "string",
      "equipment_name": "string",
      "equipment_type": "tractor",
      "market_id": "string",
      "market_name": "string",
      "depot_id": "string",
      "depot_name": "string",
      "driver_id": "string",
      "driver_name": "string",
      "total_volume": 0,
      "total_capacity": 0,
      "manually_adjusted": false,
      "compartments": [
        {
          "index": 0,
          "capacity": 0,
          "product_id": "string",
          "product_name": "string",
          "product_group": "string",
          "product_short_name": "string",
          "expected_lob_volume": 0,
          "actual_lob_volume": 0
        }
      ],
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "value_type": "boolean",
          "value": true
        }
      ]
    }
  ]
}
Loading...