Skip to main content

Get Order Freight Ep

POST 
/v1/order/freight

Freight Overview

Returns the freight information for completed orders. The freight items returned are the actual freight line items calculated based on the BOLs and drops for the order. The freight values shown in the order UI are estimated prior to the completion of the order and may not exactly match.

Required Scopes (io.r)

Request​

order_numbers: list[int] | None = None
List of unique order numbers. If provided, the endpoint will process the integration for these specific order numbers.

order_ids: list[PydanticObjectId] | None = None
List of internal order IDs. If provided, the endpoint will process the integration for these specific order IDs.

last_change_date: datetime | None = None
The last change date of the order. Types of changes that will update this date:

  • Drop / BOL added or edited
  • Order modified (location, supply, etc.)
  • Order Creation
  • Order Completion
  • Order Assignment Change (Driver, Carrier, etc.)
note

Only returns information for completed orders. Endpoint is limited to returning 3500 orders. If no filters are provided the last 3500 based on creation time will be returned


Response​

number: int
Unique order number.

po: str | None = None
Purchase order number.

freight_rate: float
Rate of freight.

freight_total: float
Total freight cost.

freight_items: list[FreightItem]
List of freight items.

Show Child Attributes

rate: float
Rate of the freight item.

quantity: float
Quantity of the freight item.

total: float
Total cost of the freight item.

unit: RateUnit
Unit of the freight item.

Show Rate Units

trucks
Fixed rate for full single truck.

gallons
Rate per gallon of product.

liters
Rate per liter of product.

percent
Rate as a percentage of the total freight.

stops
Rate per stop. Usually the number of terminals + sites visited.

type: FreightType
Type of the freight item.

Show Freight Types

freight_rate
Rate defined by freight table.

accessorial
Accessorial charge.

surcharge
Surcharge.

point_to_point
Rate defined by point to point table.

undefined
Rate unable to be found.

sub_type: str | None = None
Subtype of the freight item. Used to further define the freight item. Typically used for accessorial charges.

product_group: str | None = None
Product group of the freight item. Typically Gasoline or Diesel.

legs: list[Leg]
List of legs for the freight item.

Show Child Attributes

origin: str
Origin of the leg.

destination: str
Destination of the leg.

origin_id: str
Unique identifier for the origin.

destination_id: str
Unique identifier for the destination.

distance: float
Calculated distance between the origin and destination in miles.

Responses​

Successful Response

[
  {
    "number": 0,
    "po": "string",
    "freight_rate": 0,
    "freight_total": 0,
    "freight_items": [
      {
        "id": "string",
        "rate": 0,
        "quantity": 0,
        "unit": "string",
        "type": "Base Freight",
        "sub_type": "string",
        "product_group": "string",
        "legs": [
          {
            "origin": "string",
            "origin_id": "string",
            "destination": "string",
            "destination_id": "string",
            "distance": 0
          }
        ],
        "manual": true,
        "use_surcharge": true,
        "total": 0
      }
    ]
  }
]
Loading...