6.2 Route Object
A route object describes the planned route 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: stops
Type: Array of stop objects.
Description: See Section x101-4850006.36.3 for further information.The following fields have been deprecated. See Section x103-4870006.56.5 for further information
- Field: cost
Type: Number.
Description: The total cost of this route. - 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: 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.) - Field: idle_time
Type: String (HH:MM).
Description: The time spent idle in the route. - 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: 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). - Field: loads
Type: If batched_loads is true, this is an array of load_kpi objects.
Description: See Section x104-4880006.66.6 for further information.

