Skip to main content

Get Order Freight Ep

POST 
/v2/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[FreightTransactionDetail]
List of freight transaction details.

Show Child Attributes

id: str
Unique identifier for the freight transaction detail.

type: FreightType
Type of the freight item.

Show Freight Types

base_freight
Base freight charge.

accessorial
Accessorial charge.

surcharge
Surcharge.

manual
Manually added freight charge.

undefined
Rate unable to be found.

subtype: str | None = None
Subtype of the freight item. Used to further define the freight item.

rate: float
Rate of the freight item.

amount: float
Amount/quantity of the freight item.

total: float
Total cost of the freight item.

uom: str
Unit of measurement.

product_group: str | None = None
Product group associated with this freight item.

product_id: str | None = None
Product ID associated with this freight item.

product_name: str | None = None
Product name associated with this freight item.

legs: list[FreightLeg] = []
List of freight legs for multi-stop deliveries.

use_surcharge: bool | None = None
Whether surcharge is applied to this freight item.

manual: bool = False
Whether this is a manually added freight charge.

has_dependency: bool = False
Whether this detail needs to get recalculated if another change causes the total freight cost to change.

created_date: datetime | None = None
Date when this freight detail was created.

requires_approval: bool = False
Whether this freight item requires approval.

requires_approval_reason_code: bool = False
Whether approval reason code is required.

is_approved: bool = False
Whether this freight item has been approved.

approved_by: str | None = None
User who approved this freight item.

approved_date: datetime | None = None
Date when this freight item was approved.

approved_reason_code: str | None = None
Reason code for approval.

amount_override: float | None = None
Override value for the amount.

total_override: float | None = None
Override value for the total.

Responses​

Successful Response

[
  {
    "number": 0,
    "po": "string",
    "freight_rate": 0,
    "freight_total": 0,
    "freight_items": [
      {
        "model_type": "base",
        "type": "Base Freight",
        "subtype": "string",
        "rate": 0,
        "amount": 0,
        "total": 0,
        "uom": "string",
        "errors": [
          "string"
        ],
        "id": "string",
        "product_group": "string",
        "product_id": "string",
        "product_name": "string",
        "origin": "string",
        "origin_id": "string",
        "origin_override": "string",
        "origin_id_override": "string",
        "destination": "string",
        "destination_id": "string",
        "destination_override": "string",
        "destination_id_override": "string",
        "legs": [
          {
            "origin": "string",
            "origin_id": "string",
            "destination": "string",
            "destination_id": "string",
            "distance": 0
          }
        ],
        "use_surcharge": true,
        "manual": false,
        "has_dependency": false,
        "created_date": "2025-12-19T21:24:57.124Z",
        "requires_approval": false,
        "requires_approval_reason_code": false,
        "is_approved": false,
        "approved_by": "string",
        "approved_date": "2025-12-19T21:24:57.124Z",
        "approved_reason_code": "string",
        "amount_override": 0,
        "rate_override": 0,
        "product_id_override": "string",
        "product_name_override": "string",
        "product_group_override": "string",
        "subtype_override": "string",
        "uom_override": "string",
        "total_override": 0,
        "override_by": "string",
        "override_date": "2025-12-19T21:24:57.124Z",
        "exclude_from_invoice": false,
        "credit_rebill_metadata": {
          "impact_type": "impacted",
          "delta_amount": 0,
          "delta_base_total": 0,
          "delta_surcharge_total": 0,
          "delta_accessorial_total": 0,
          "delta_total": 0
        },
        "extra_data": {},
        "gross_volume": 0,
        "net_volume": 0,
        "bol_date": "2025-12-19T21:24:57.124Z",
        "bol_number": "string",
        "bol_number_override": "string",
        "delivery_date": "2025-12-19T21:24:57.124Z"
      }
    ]
  }
]
Loading...