6.1 Solution Object
Each solution object consists of the following fields:
- Field: routes
Type: Array of route objects.
Description: An array of route objects, each of which describes the generated plan for a single vehicle. - Field: route_kpis
Type: Array of route_kpi objects.
Description: An array of route KPI objects, each of which describes the KPIs for a single vehicle. - Field: cost
Type: Number.
Description: The total cost for all routes in the solution. - Field: revenue
Type: Number.
Description: The total revenue for all routes in the solution. - Field: profit
Type: Number.
Description: The total profit or loss for all routes in the solution. Profit is the difference between revenue and cost. - Field: distance
Type: Number.
Description: The total transit distance of all routes in the solution. - Field: delivery_distance
Type: Number.
Description: The transit distance while making deliveries in all routes in the solution. - Field: loaded_distance
Type: Number.
Description: The total transit distance travelled in all routes while the vehicles are carrying at least one order. - Field: empty_distance
Type: Number.
Description: The total transit distance travelled in all routes while the vehicles are empty. -
Field: work_time
Type: String (HH:MM).
Description: The total work time for all routes in the solution.11.Field: transit_time
Type: String (HH:MM).
Description: The total transit time for all routes in the solution.12.Field: service_time
Type: String (HH:MM) .
Description: The total service time for all routes in the solution. (See Service Time in Section x16-380002.122.12.) - Field: site_time
Type: String (HH:MM).
Description: The site time incurred in all routes in the solution. (See Site Time in Section x14-240002.102.10.) - Field: idle_time
Type: String (HH:MM).
Description: The total idle time for all routes in the solution. - Field: break_time
Type: String (HH:MM).
Description: The total break time for all routes in the solution. - Field: weight
Type: Number.
Description: The cumulative weight carried in all routes in the solution. - Field: volume
Type: Number.
Description: The cumulative volume carried in all routes in the solution. - Field: assigned_orders
Type: Number (integer).
Description: The number of orders that have been assigned to a vehicle by the optimiser. - Field: unassigned_orders
Type: Array of strings.
Description: An array containing the order identifiers of any unassigned orders. An empty array means that there are no unassigned orders. - Field: unassigned_reasons
Type: Array of unassigned reason objects.
Description: The results of the unassigned order analysis for any unassigned orders. - Field: total_orders
Type: Number (integer).
Description: The total number of orders in the scenario. This is also the length of the orders array in the scenario. - Field: used_vehicles
Type: Number (integer).
Description: The number of vehicles used in the solution. - Field: total_vehicles
Type: Number (integer).
Description: The total number of vehicles in the scenario. - Field: loads
Type: Number (integer).
Description: If batched loads is true, then the total number of loads in the solution. - Field: km_per_load
Type: Number.
Description: If batched loads is true and Use Miles is false, then this field gives the average number of kilometres per load in the solution. - Field: miles_per_load
Type: Number.
Description: If batched loads and Use Miles are both true, then this field gives the average number of miles per load in the solution. - Field: drops_per_load
Type: Number.
Description: If batched loads is true, then this field gives the average number of drops per load in the solution. -
Field: hours_per_load
Type: String (HH:MM).
Description: If batched loads is true, then this field gives the average time per load.29.Field: pickup_soft_time_window_early
Type: String (HH:MM).
Description: If there are orders with pickup soft time windows, then this field gives the total amount of time that orders were picked up early.30.Field: pickup_soft_time_window_late
Type: String (HH:MM).
Description: If there are orders with pickup soft time windows, then this field gives the total amount of time that orders were picked up late.31.Field: delivery_soft_time_window_early
Type: String (HH:MM).
Description: If there are orders with delivery soft time windows, then this field gives the total amount of time that orders were delivered early. - Field: delivery_soft_time_window_late
Type: String (HH:MM).
Description: If there are orders with delivery soft time windows, then this field gives the total amount of time that orders were delivered late. -
Field: iteration
Type: Number (integer).
Description: The iteration that generated this solution.34.Field: total_iterations
Type: Number (integer).
Description: The total number of iterations that the optimisation that generated this solution was set to run for.35.Field: errors
Type: Array of strings.
Description: A list of errors in the solution; will be null or empty if there are no errors.
Note: This field provides feedback when a solution is modified after optimisation. - Field: warnings
Type: Array of strings.
Description: A list of warnings about the solution; will be null or empty if there are no warnings. - Field: date_generated
Type: String.
Description: A string giving the day, date, time and year the solution was generated.
Example: Fri Jul 07 10:12:18 AEST 2017 - Field: scenario
Type: String.
Description: The name of the scenario from which the solution was generated. Matches the name field of the general object in the scenario object. - Field: run_time
Type: String (HH:MM:SS).
Description: The length of time the optimiser ran for. - Field: exclusive_order_summary
Type: Array of exclusive order summary objects.
Description: A summary of all exclusive orders in the scenario.

