Calculation parameters

scheduling_modestring

Choose between default - Pickup and Delivery Problem (PDP) and Capacitated Vehicle Routing Problem with Time Windows (CVRPTW). CVRPTW is only suitable for scenarios with only one pickup point/DC. In this CVRPTW mode, all the pickup nodes are combined together, significantly reducing the number of nodes, which significantly improve the result. Each vehicle is limit to the maximum of one trip (or one pickup), as pickup nodes are combined. Both modes support capacity constrains.

Possible values: [prebook, prebook_cvrptw]

calculations_modestring

In sync mode, calculation results will be returned to the initial request, while in async mode, the consumer should retrieve the results by using another request with job_id as a reference.

Possible values: [sync, async]

use_vehicles_nodesboolean

Disables or enables the use of nodes representing vehicles in optimization.

allow_vehicle_lateboolean

Relaxes time constrains allowing for vehicles to arrive late to the nodes trading off more efficient routes.

Default value: false

vehicle_late_penalty_coefficientinteger

Penalty coefficient for lateness, used when allow_vehicle_late is true. The higher the penalty, the more weight is given to arrival on time.

max_possible_latenessinteger | nullnullable

Time in seconds for max possible lateness. Max lateness is not limited if this is null. Used if allow_vehicle_late is true.

dropoff_earlierboolean

If true and the assignment contains loops the algorithm will try to schedule dropoffs earlier, so the passenger will not move through their stop twice. Breaks are not rescheduled. If both dropoff_earlier and pickup_earlier are disabled (unspecified), loop detection is completely off, no analysis is performed, and no relevant actions are taken.

Default value: false

pickup_laterboolean

If true and the assignment contains loops the algorithm will try to schedule pickups later, so the passenger will not move through their stop twice. Breaks are not rescheduled. If both dropoff_earlier and pickup_earlier are disabled (unspecified), loop detection is completely off, no analysis is performed, and no relevant actions are taken.

use_mixed_time_matrixboolean

If true then the Solver will take into account each node's possible departure time when query matrix (mixed time matrix mode).

matrix_timestamp_selectionstring

If current_time then all nodes will use the current time (from API request) as departure time, if min_time or max_time then node's open or close time will be used.

Possible values: [current_time, min_time, max_time]

use_node_weights_costboolean

If true node weights are used in the cost calculation.

Default value: false

cvrptw_artificial_nodes_per_vehicleinteger

This setting is for CVRPTW mode. If a positive value is present, then vehicle cost is added to the overall cost function if the number of nodes on the path is greater than the given value. A negative value disables additional costs.

Default value: -1

use_path_equalizerboolean

Defines whether to use paths equalizer

Default value: false

path_equalizer_weightnumber

Defines weight of the additional cost element produced by variance of path lengths.

Default value: 100

calculate_cumulative_distanceboolean

Enables cumulative distance calculation. If set to true every node in the 'vehicles' section in the result will contain a 'scheduled_distance' field, which contain distance to this node.

Default value: false

exclude_unroutable_bookingboolean

If enabled, optimization bookings that have unroutable nodes will result in a no-offer situation (so no vehicle assignments will occur). The default is false, in which case if a node is unroutable, the optimization engine will use an air distance (straight line) approximation between the nodes.

Routability is determined by the underlying map, selected vehicle profile, and any temporary or permanent restrictions in place.

Default value: false

use_selective_path_equalizerboolean

Equalize paths during second stage of calculation. The system will first calculate the minimum number of vehicles required to meet the demand, and it will then balance the workload across the active vehicles based on the selected balancing method (e.g., number of bookings, total trip distance, or total trip time). The system will ensure that the number of vehicles is not increased during the balancing process.

Default value: false

Calculation parameters

{
  "scheduling_mode": "prebook",
  "calculations_mode": "sync",
  "use_vehicles_nodes": true,
  "allow_vehicle_late": false,
  "vehicle_late_penalty_coefficient": 0,
  "max_possible_lateness": 0,
  "dropoff_earlier": false,
  "pickup_later": true,
  "use_mixed_time_matrix": true,
  "matrix_timestamp_selection": "current_time",
  "use_node_weights_cost": false,
  "cvrptw_artificial_nodes_per_vehicle": -1,
  "use_path_equalizer": false,
  "path_equalizer_weight": 100,
  "calculate_cumulative_distance": false,
  "exclude_unroutable_booking": false,
  "use_selective_path_equalizer": false
}