Skip to main content

Freight Point To Point Disable V1 Ep

POST 
/v1/freight/point_to_point/disable

Deactivate a Point to Point Record

Deactivates a point to point record with effect from today, by dropping every rate scheduled from today onward and writing a zero rate in their place. Rates that have already expired are left untouched. This mirrors the Active toggle on a ratebook's Point to Point tab, which also deactivates as of today.

Required Scopes (if.w)

Request​

point_to_point_id: str
Internal identifier of the point to point record to deactivate.


Response​

Returns the updated point to point record, with all fields as described in the Point to Point Overview response. disabled will be true once no active or scheduled rate remains.

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.398Z",
      "effective_to": "2026-09-25T19:33:18.398Z",
      "rate": 0,
      "distance": 0,
      "tag": "string",
      "created_by": "string",
      "created_on": "2026-09-25T19:33:18.398Z",
      "deleted_by": "string",
      "deleted_on": "2026-09-25T19:33:18.398Z"
    }
  ],
  "rate_history": [
    {
      "id": "5eb7cf5a86d9755df3a6c593",
      "effective_from": "2026-09-25T19:33:18.398Z",
      "effective_to": "2026-09-25T19:33:18.398Z",
      "rate": 0,
      "distance": 0,
      "tag": "string",
      "created_by": "string",
      "created_on": "2026-09-25T19:33:18.398Z",
      "deleted_by": "string",
      "deleted_on": "2026-09-25T19:33:18.398Z"
    }
  ],
  "updated_on": "2026-09-25T19:33:18.399Z",
  "updated_by": "string",
  "rate": 0,
  "distance": 0,
  "effective_from": "2026-09-25T19:33:18.399Z",
  "effective_to": "2026-09-25T19:33:18.399Z",
  "next_scheduled_rate": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "effective_from": "2026-09-25T19:33:18.399Z",
    "effective_to": "2026-09-25T19:33:18.399Z",
    "rate": 0,
    "distance": 0,
    "tag": "string",
    "created_by": "string",
    "created_on": "2026-09-25T19:33:18.399Z",
    "deleted_by": "string",
    "deleted_on": "2026-09-25T19:33:18.399Z"
  },
  "tag": "string",
  "origin_city": "string",
  "origin_state": "string",
  "destination_city": "string",
  "destination_state": "string"
}
Loading...