Optimization settings

vehicle_costnumber | nullnullable

Cost factor for a vehicle

Default value: 1000

trip_costnumber | nullnullable

Cost weight for a trip

Default value: 0

time_limit_msinteger | nullnullable

Maximum calculation type in ms

Default value: 30000

first_solution_strategies object

anyOf

null

null

First solutions strategies

string

Represents mode that solver should be uing to find the first available solution

Possible values: [AUTOMATIC, GLOBAL_CHEAPEST_ARC, LOCAL_CHEAPEST_ARC, PATH_CHEAPEST_ARC, PATH_MOST_CONSTRAINED_ARC, EVALUATOR_STRATEGY, ALL_UNPERFORMED, BEST_INSERTION, PARALLEL_CHEAPEST_INSERTION, LOCAL_CHEAPEST_INSERTION, SAVINGS, SWEEP, FIRST_UNBOUND_MIN_VALUE, CHRISTOFIDES, SEQUENTIAL_CHEAPEST_INSERTION, ADJUSTABLE_PARALLEL_CHEAPEST_INSERTION, LOGISTICS_PARALLEL_CHEAPEST_INSERTION]

max_pickup_slackinteger | nullnullable

Maximum possible slack for pickup nodes in seconds

Default value: null

max_dropoff_slackinteger | nullnullable

Maximum allowed slack for drop off nodes

Default value: null

mutually_exclusive_groupsobject[]

List of mutually-exclusive group relations. Group names are set in the groups field for bookings and nodes. Each item in the list should be a list of string group names whose bookings (or nodes) cannot be on the same vehicle at the same time. For example, [["group1", "group2"], ["group2", "group3"]] prohibits bookings with groups group1 and group2, as well as group2 and group3, from being transferred in the same vehicle at the same time, but allows simultaneous transfer of bookings with groups group1 and group3.

use_local_search_metaheuristicboolean | nullnullable

Flag to enable local search metaheuristics.

Default value: false

allow_upload_after_simulation_start_timeboolean | nullnullable

Allows to upload bookings after the simulation start time (required for On Demand optimization).

Default value: false

pipeline_typestring

Possible values: [simple_one_stage, two_stages]

Default value: simple_one_stage

geofence_definition_strategy object

oneOf

By Dropoff

By dropoff location. Both pickup and dropoff nodes will be labeled with same geofence Defined by dropoff point

Constant value: by_dropoff

By Pickup

By pickup location. Both pickup and dropoff nodes will be labeled with same geofence Defined by pickup point

Constant value: by_pickup

Independent

Both pickup and dropoff nodes may be labeled with different geofences Defined by corresponding locations

Constant value: independent

Mixed

Works like independent but if geofences are different, then Nodes are labeled with both geofences.

Constant value: mixed

algo_optimize_quantitystring

Optimizaion goal for the algorithm

Possible values: [total_distance, total_time]

use_lifo_order_checkboolean

Enables LIFO bookings check for vehicle assignments

lifo_order_check_on_all_vehiclesboolean

Use LIFO order check on all vehicles ignoring individual LIFO attribute of separate vehicles

geofence_vehicle_allocation_strategy object

oneOf

Strict

Nodes with empty geofence tag can be picked up only by empty vehicle

Constant value: strict

Flexible

Nodes with empty geofence tag can be picked up by any vehicle

Constant value: flexible

should_optimize_fail_to_board_bookingsboolean

If false, bookings with the fail_to_board status will not be reassigned to any vehicles during route calculation. If true, bookings with the fail_to_board status will still be eligible for assignment to vehicles during route calculation by setting the booking status to the prepared state. Any data stored on the booking or node during the status update to fail_to_board will persist and not be deleted.

Default value: false

Optimization settings

{
  "vehicle_cost": 1000,
  "trip_cost": 0,
  "time_limit_ms": 30000,
  "first_solution_strategies": "null",
  "max_pickup_slack": null,
  "max_dropoff_slack": null,
  "mutually_exclusive_groups": [
    {}
  ],
  "use_local_search_metaheuristic": false,
  "allow_upload_after_simulation_start_time": false,
  "pipeline_type": "simple_one_stage",
  "algo_optimize_quantity": "total_distance",
  "use_lifo_order_check": true,
  "lifo_order_check_on_all_vehicles": true,
  "should_optimize_fail_to_board_bookings": false
}