Skip to main content

Order Optimal Supply Report Ep

POST 
/v1/order/optimal_supply_report

Orders Optimal Supply Report

Retrieves information comparing the actual supply used versus the optimal supply. Orders will only be returned if a price flag was applied and the order is complete. Orders will be selected based on a union of all filters provided. Responses limited to 3500 orders

Required Scopes (io.r)

Request​

order_numbers: list[int] | None = None
Order numbers. Filters orders to specified numbers.

order_ids: list[str] | None = None
Internal order IDs. Filters orders to specified ids.

order_date_start: datetime | None = None
The start date for filtering orders based on their order date.

order_date_end: datetime | None = None
The end date for filtering orders based on their order date.

movement_updated_start: datetime | None = None
The start date for filtering orders based on their last movement update.

movement_updated_end: datetime | None = None
The end date for filtering orders based on their last movement update.

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.)

Response​

Returns a list of price objects with the following properties:

order_number: int
Order number.

order_id: str
Internal identifier for the order.

site_number: str
Site number of the destination.

actual_component_product: str
The name of the component product that was actually used.

actual_component_product_id: str
Unique identifier for the actual component product.

optimal_component_product: str
The name of the component product that would have been optimal to use.

optimal_component_product_id: str
Unique identifier for the optimal component product.

actual_terminal: str
The terminal that was actually used.

actual_terminal_id: str
Unique identifier for the actual terminal.

optimal_terminal: str
The terminal that would have been optimal to use.

optimal_terminal_id: str
Unique identifier for the optimal terminal.

actual_supplier: str
The supplier that was actually used.

actual_supplier_id: str
Unique identifier for the actual supplier.

optimal_supplier: str
The supplier that would have been optimal to use.

optimal_supplier_id: str
Unique identifier for the optimal supplier.

actual_price_type: str
The priec type that was actually applied.

optimal_price_type: str
The price type that would have been optimal to apply.

actual_contract: str | None
The contract that was actually used.

optimal_contract: str | None
The contract that would have been optimal to use.

actual_curve_id: str
Unique identifier for the price curve that was actually used.

optimal_curve_id: str
Unique identifier for the price curve that would have been optimal to use.

actual_price_id: str
Unique identifier for the price that was actually used.

optimal_price_id: str
Unique identifier for the price that would have been optimal to use.

actual_loaded_miles: float
The loaded miles of the supply that was actually used..

optimal_loaded_miles: float
The loaded miles of the supply that would have been optimal to use.

actual_product_price: float
The price of the product that was actually used.

optimal_product_price: float
The price of the product that would have been optimal to use.

actual_freight_rate: float
The freight rate that was actually used.

optimal_freight_rate: float
The freight rate that would have been optimal to use.

actual_total_price: float
The total price that was actually used.

optimal_total_price: float
The total price that would have been optimal to use.

total_price_delta: float
The difference between the actual total price and the optimal total price.

actual_volume: float
The volume that was actually used for the component product.

optimal_volume: float
The volume that would have been optimal to use for the component product.

last_change_date : datetime = 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.)

last_updated_date: datetime
Deprecated. The date and time when the order was last updated.

reason_code: str | None
Code indicating the reason for the difference between actual and optimal.

Responses​

Successful Response

[
  {
    "order_number": 0,
    "order_id": "string",
    "site_number": "string",
    "actual_component_product": "string",
    "actual_component_product_id": "string",
    "optimal_component_product": "string",
    "optimal_component_product_id": "string",
    "actual_terminal": "string",
    "actual_terminal_id": "string",
    "optimal_terminal": "string",
    "optimal_terminal_id": "string",
    "actual_supplier": "string",
    "actual_supplier_id": "string",
    "optimal_supplier": "string",
    "optimal_supplier_id": "string",
    "actual_price_type": "string",
    "optimal_price_type": "string",
    "actual_contract": "string",
    "optimal_contract": "string",
    "actual_curve_id": "string",
    "optimal_curve_id": "string",
    "actual_price_id": "string",
    "optimal_price_id": "string",
    "actual_loaded_miles": 0,
    "optimal_loaded_miles": 0,
    "actual_product_price": 0,
    "optimal_product_price": 0,
    "actual_freight_rate": 0,
    "optimal_freight_rate": 0,
    "actual_total_price": 0,
    "optimal_total_price": 0,
    "total_price_delta": 0,
    "actual_volume": 0,
    "optimal_volume": 0,
    "last_change_date": "2025-12-17T21:49:50.690Z",
    "last_updated_date": "2025-12-17T21:49:50.690Z",
    "reason_code": "string"
  }
]
Loading...