6.2 Route Object

A route object describes the planned route for a single vehicle. It has the following fields:

1. Field: route_id
   Type: Number (integer).
   Description: An number assigned to the route by the optimiser. It is the index of the route in the routes field of a solution object.
2. Field: vehicle_id
   Type: String.
   Description: The identifier of the vehicle assigned to this route.

3. Field: stops
   Type: Array of stop objects.
   Description: See Section  6.3 for further information.

   The following fields have been deprecated and users should see Section  6.5 for further information

4. Field: cost
   Type: Number.
   Description: The total cost of this route.
5. Field: distance
   Type: Number.
   Description: The total transit distance during the route.
6. Field: loaded_distance
   Type: Number.
   Description: The total transit distance travelled in the route while the vehicle is carrying at least one order.
7. Field: empty_distance
   Type: Number.
   Description: The total transit distance travelled in the route while the vehicle is empty.
8. Field: delivery_distance
   Type: Number.
   Description: The transit distance while making deliveries as part of the route.
9. Field: work_time
   Type: String (HH:MM).
   Description: The total time elapsed from the START to the FINISH stop in the route.
10. Field: transit_time
    Type: String (HH:MM).
    Description: The time spent in transit in the route.
11. Field: service_time
    Type: String (HH:MM).
    Description: The service time incurred in the route. (See Service Time in Section  2.12.)
12. Field: site_time
    Type: String (HH:MM).
    Description: The site time incurred in the route. (See Site Time in Section  2.10.)
13. Field: idle_time
    Type: String (HH:MM).
    Description: The time spent idle in the route.
14. break_time
    Type: String (HH:MM).
    Description: The time spent on breaks in the route.
15. Field: actual_start_time
    Type: String (HH:MM).
    Description: The time the vehicle started the route.
16. Field: actual_finish_time
    Type: String (HH:MM).
    Description: The time the vehicle finished the route.
17. Field: weight
    Type: Number.
    Description: The cumulative weight carried by the vehicle in the route.
18. Field: volume
    Type: Number.
    Description: The cumulative volume carried by the vehicle in the route.
19. Field: assigned_orders
    Type: Number.
    Description: The number of orders assigned to the vehicle in the route.
20. Field: number_of_loads
    Type: Number (integer).
    Description: If batched_loads is true, this is the number of loads in the route. (See Section  2.19).
21. Field: loads
    Type: If batched_loads is true, this is an array of load_kpi objects.
    Description: See Section  6.6 for further information.