Skip to main content

Freight Mileage Table Overview V1 Ep

POST 
/v1/freight/mileage_table/overview

Mileage Table Overview

Retrieves mileage table (base freight) rates. Each row is one effective-dated table: a full set of mileage bands for a counterparty, ratebook, freight region and product group.

A table with no freight_region_id or no product_group is the fallback used for any region or product group that has no table of its own.

Required Scopes (if.r)

Request​

Every filter you add narrows the results.

counterparty_id: str | None = None
Internal identifier of the counterparty. A carrier token only ever sees its own rates.

book_type: RateBookType | None = None
Ratebook to query (Cost or Revenue).

freight_region_id: str | None = None
product_group: str | None = None

active_on: datetime | None = None
Only return the table in effect on this date for each counterparty, ratebook, region and product group. Omit to return every table, including expired and future-dated ones.

page: int = 1
page_size: int = 100
The most you can request per page is 500. A larger page_size returns 422.


Response​

rows: list[MileageTableRow]
One page of tables, sorted by counterparty, ratebook, region, product group and then effective_from.

total: int
The number of tables that match your filters across all pages.

page: int, page_size: int
The values from your request.

MileageTableRow​

id: str
Internal identifier of the table. Send it back on upsert_many to update this table.

counterparty_id: str, counterparty: str
book_type: RateBookType
freight_region_id: str | None, freight_region_name: str | None
product_group: str | None

unit: RateUnit
Unit the rates are charged in (trucks, gallons, liters, tons). A trucks rate is a flat charge per load.

rates: list[object]
The bands, each with from_mile, to_mile and rate. A trip of d miles uses the band where from_mile < d < to_mile. A trip past the last band's to_mile has no rate.

effective_from: datetime, effective_to: datetime | None
The dates the table applies to. effective_to is exclusive, and null means open-ended.

updated_on: datetime, updated_by: str | None
When the table was last changed, and by whom.

Responses​

Successful Response

{
  "rows": [
    {
      "id": "string",
      "counterparty_id": "string",
      "counterparty": "string",
      "book_type": "Cost",
      "freight_region_id": "string",
      "freight_region_name": "string",
      "product_group": "Gasoline",
      "unit": "trucks",
      "rates": [
        {
          "from_mile": 0,
          "to_mile": 0,
          "rate": 0
        }
      ],
      "effective_from": "2026-11-11T17:36:45.997Z",
      "effective_to": "2026-11-11T17:36:45.997Z",
      "updated_on": "2026-11-11T17:36:45.997Z",
      "updated_by": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "page_size": 0
}
Loading...