6.5 Route KPI Object
A route KPI object contains the route KPIs for a single vehicle. It has the following fields:
- Field: route_id
Type: Number (integer).
Description: A number assigned to the route by the optimiser. It is the index of the route in the routes field of a solution object. - Field: vehicle_id
Type: String.
Description: The identifier of the vehicle assigned to this route. - Field: cost
Type: Number.
Description: The cost for this route. - Field: revenue
Type: Number.
Description: The revenue for this route. - Field: profit
Type: Number.
Description: The profit or loss for this route. Profit is the difference between revenue and cost. - Field: distance
Type: Number.
Description: The total transit distance during the route. - Field: loaded_distance
Type: Number.
Description: The total transit distance travelled in the route while the vehicle is carrying at least one order. - Field: time_to_finish
Type: String (HH:MM).
Description: The total time elapsed between the final DELIVERY to the FINISH stop in the route. - Field: distance_to_finish
Type: Number.
Description: The total transit distance travelled between the final DELIVERY to the FINISH stop in the route. - Field: empty_distance
Type: Number.
Description: The total transit distance travelled in the route while the vehicle is empty. - Field: delivery_distance
Type: Number.
Description: The transit distance while making deliveries as part of the route. - Field: work_time
Type: String (HH:MM).
Description: The total time elapsed from the START to the FINISH stop in the route. - Field: transit_time
Type: String (HH:MM).
Description: The time spent in transit in the route. - Field: service_time
Type: String (HH:MM).
Description: The service time incurred in the route. (See Service Time in Section x16-380002.122.12.) -
Field: site_time
Type: String (HH:MM).
Description: The site time incurred in the route. (See Site Time in Section x14-240002.102.10.)16.Field: idle_time
Type: String (HH:MM).
Description: The time spent idle in the route.17.Field: break_time
Type: String (HH:MM).
Description: The time spent on breaks in the route. - Field: actual_start_time
Type: String (HH:MM).
Description: The time the vehicle started the route. - Field: actual_finish_time
Type: String (HH:MM).
Description: The time the vehicle finished the route. - Field: weight
Type: Number.
Description: The cumulative weight carried by the vehicle in the route. - Field: volume
Type: Number.
Description: The cumulative volume carried by the vehicle in the route. - Field: assigned_orders
Type: Number.
Description: The number of orders assigned to the vehicle in the route. - Field: pickup_soft_time_window_early
Type: String (HH:MM).
Description: If there are orders with pickup soft time windows, then this the total amount of time that orders were picked up early in the route. - Field: pickup_soft_time_window_late
Type: String (HH:MM).
Description: If there are orders with pickup soft time windows, then this is the total amount of time that orders were picked up late in the route. - Field: delivery_soft_time_window_early
Type: String (HH:MM).
Description: If there are orders with delivery soft time windows, then this is the total amount of time that orders were delivered early in the route. -
Field: delivery_soft_time_window_late
Type: String (HH:MM).
Description: If there are orders with delivery soft time windows, then this is the total amount of time that orders were delivered late in the route.27.Field: number_of_loads
Type: Number (integer).
Description: If batched_loads is true, this is the number of loads in the route. (See Section x26-510002.222.22).28.Field: load_kpis
Type: If batched_loads is true, this is an array of load_kpi objects.
Description: See Section x104-4880006.66.6 for further information.

