Skip to main content

Freight Point To Point Overview V1 Ep

POST 
/v1/freight/point_to_point/overview

Point to Point Overview

Retrieves the point to point freight rates for a counterparty and ratebook, including each record's currently active rate, its next scheduled rate, and its full rate history.

counterparty_id and book_type are required and together bound the size of the response.

Required Scopes (if.r)

Request​

counterparty_id: str
Internal identifier of the counterparty to query.

book_type: RateBookType
Ratebook to query (cost or revenue).

as_of: datetime | None = None
The date to resolve the active and next scheduled rate against. Defaults to the current date.

effective_from: datetime | None = None
Only return records whose active rate is still effective on or after this date.

effective_to: datetime | None = None
Only return records whose active rate became effective on or before this date.

updated_since: datetime | None = None
Only return records changed on or after this timestamp.


Response​

id: str
Internal identifier for the point to point record.

counterparty: str / counterparty_id: str
The counterparty the record belongs to.

origin: str / origin_id: str
The origin location. origin_city and origin_state are also returned.

destination: str / destination_id: str
The destination location. destination_city and destination_state are also returned.

book_type: RateBookType
Ratebook the record belongs to.

product_group: str | None
Product group the record applies to.

unit: RateUnit | None
Unit the rate is charged in.

rate: float | None
The currently active rate as of the requested date.

effective_from: datetime | None / effective_to: datetime | None
The window the active rate applies to.

distance: float | None
Distance in miles on the active rate.

tag: str | None
Tag on the active rate.

use_surcharge: bool
Whether the freight surcharge applies.

disabled: bool
True when the record has no active rate and none scheduled.

next_scheduled_rate: object | None
The next future rate, if any, with rate, effective_from, effective_to, distance and tag.

rates: list[object]
Full rate schedule, newest first. Each entry carries rate, effective_from, effective_to, distance, tag, created_by, created_on and a status of active, scheduled or expired.

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

Responses​

Successful Response

[
  {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "counterparty": "string",
    "counterparty_id": "string",
    "book_type": "Cost",
    "origin": "string",
    "origin_id": "string",
    "destination": "string",
    "destination_id": "string",
    "unit": "trucks",
    "product_group": "Gasoline",
    "use_surcharge": true,
    "disabled": false,
    "rates": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2026-09-25T19:33:18.396Z",
        "effective_to": "2026-09-25T19:33:18.396Z",
        "rate": 0,
        "distance": 0,
        "tag": "string",
        "created_by": "string",
        "created_on": "2026-09-25T19:33:18.396Z",
        "deleted_by": "string",
        "deleted_on": "2026-09-25T19:33:18.396Z"
      }
    ],
    "rate_history": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2026-09-25T19:33:18.396Z",
        "effective_to": "2026-09-25T19:33:18.396Z",
        "rate": 0,
        "distance": 0,
        "tag": "string",
        "created_by": "string",
        "created_on": "2026-09-25T19:33:18.396Z",
        "deleted_by": "string",
        "deleted_on": "2026-09-25T19:33:18.396Z"
      }
    ],
    "updated_on": "2026-09-25T19:33:18.396Z",
    "updated_by": "string",
    "rate": 0,
    "distance": 0,
    "effective_from": "2026-09-25T19:33:18.396Z",
    "effective_to": "2026-09-25T19:33:18.396Z",
    "next_scheduled_rate": {
      "id": "5eb7cf5a86d9755df3a6c593",
      "effective_from": "2026-09-25T19:33:18.396Z",
      "effective_to": "2026-09-25T19:33:18.396Z",
      "rate": 0,
      "distance": 0,
      "tag": "string",
      "created_by": "string",
      "created_on": "2026-09-25T19:33:18.396Z",
      "deleted_by": "string",
      "deleted_on": "2026-09-25T19:33:18.396Z"
    },
    "tag": "string",
    "origin_city": "string",
    "origin_state": "string",
    "destination_city": "string",
    "destination_state": "string"
  }
]
Loading...