- Request
- Query parameters
- Body
- MVRPRequest_locations_item
- SolverOptionsMVRP
- MVRPRequest_vehicles_item
- DepotLocation
- MVRPRequest_depots_item
- InitialRoute
- MVRPRequest_zones_item
- Coordinate
- MVRPRequest_locations_optional_tags_item
- MVRPRequest_locations_penalty
- MVRPRequest_locations_shipment_size
- MVRPRequest_locations_time_windows_item
- MVRPRequest_locations_transit_time
- SolverOptionsMVRP_balanced_groups_item
- SolverOptionsMVRP_location_groups_item
- SolverOptionsMVRP_penalty
- SolverOptionsMVRP_points_throughputs_item
- SolverOptionsMVRP_template_rest_schedules_item
- MVRPRequest_vehicles_capacity
- MVRPRequest_vehicles_close_locations_item
- vehicles_cost_0
- MVRPRequest_vehicles_fixed_work_breaks_item
- MVRPRequest_vehicles_penalty
- MVRPRequest_vehicles_planned_route
- MVRPRequest_vehicles_rest_schedule
- MVRPRequest_vehicles_shifts_item
- MVRPRequest_vehicles_specs
- MVRPRequest_vehicles_trailer
- MVRPRequest_vehicles_visited_locations_item
- MVRPRequest_vehicles_walking_courier
- DepotLocation_package_throughput
- DepotLocation_penalty
- DepotLocation_throughput
- DepotLocation_time_windows_item
- MVRPRequest_depots_package_throughput
- MVRPRequest_depots_penalty
- MVRPRequest_depots_throughput
- MVRPRequest_depots_time_windows_item
- InitialRouteNode
- InitialRouteShift
- MVRPRequest_zones_geometry
- locations_penalty_delivery_deadline
- locations_penalty_early
- locations_penalty_late
- locations_penalty_out_of_time
- locations_shipment_size_volume
- SolverOptionsMVRP_balanced_groups_penalty
- SolverOptionsMVRP_penalty_drop_penalty_percentage
- SolverOptionsMVRP_penalty_multiorders
- SolverOptionsMVRP_points_throughputs_penalty
- SolverOptionsMVRP_points_throughputs_point
- SolverOptionsMVRP_points_throughputs_throughput
- template_rest_schedules_breaks_0_item
- vehicles_capacity_limits
- vehicles_capacity_volume
- vehicles_penalty_arrival_after_start
- vehicles_penalty_min_stop_weight
- vehicles_planned_route_locations_item
- rest_schedule_breaks_0_item
- shifts_penalty
- vehicles_trailer_capacity
- vehicles_trailer_cost
- vehicles_trailer_max_capacity_difference
- vehicles_trailer_rolling_time
- vehicles_walking_courier_capacity
- vehicles_walking_courier_cost
- DepotLocation_penalty_early
- DepotLocation_penalty_late
- DepotLocation_penalty_out_of_time
- DepotLocation_penalty_package_throughput
- DepotLocation_penalty_throughput
- DepotLocation_throughput_vehicle_count_0_item
- depots_penalty_early
- depots_penalty_late
- depots_penalty_out_of_time
- depots_penalty_package_throughput
- depots_penalty_throughput
- throughput_vehicle_count_0_item
- InitialRouteNodeDepot
- InitialRouteNodeLocation
- InitialRouteNodeWorkBreak
- InitialRouteNodeCourierPosition
- points_throughputs_penalty_throughput
- _penalty
- shifts_penalty_early
- shifts_penalty_late
- shifts_penalty_max_mileage
- shifts_penalty_out_of_time
- shifts_penalty_stop_excess
- shifts_penalty_stop_lack
- shifts_penalty_unique_stop_lack
- trailer_capacity_limits
- trailer_capacity_volume
- InitialRouteNodeValue
- InitialRouteNodeWorkBreak_value
- InitialRouteNodeCourierPosition_value
- penalty_early
- penalty_late
- SplitInfo
- UnfeasibleReasons_0
- UnfeasibleReasons_1
- UnfeasibleReasons_2
- UnfeasibleReasons_3
- UnfeasibleReasons_4
- UnfeasibleReasons_5
- UnfeasibleReasons_6
- UnfeasibleReasons_7
- UnfeasibleReasons_8
- UnfeasibleReasons_incompatibilities_item_1
- UnfeasibleReasons_incompatibilities_item
- incompatibilities_types_item
- incompatibilities_zones_item
- Responses
- 202 Accepted
- 400 Bad Request
- 403 Forbidden
- 500 Internal Server Error
- 503 Service Unavailable
Adds a task
Creates a new MVRP task. Use "GET /api/v1/vrs/result/mvrp/<task_id>" to get task status.
Request
POST
https://courier.yandex.ru/api/v1/vrs/add/mvrp
Query parameters
|
Name |
Description |
|
company_id |
Type: integer<int64> Task company id. |
|
lang |
Type: string Response locale in RFC-3066 format. |
|
parent_task_id |
Type: string Parent task id. |
|
taxi_types |
Type: string<list_of_taxi_types> Comma-separated list of taxi types that would be used for routing (e.g. |
Body
application/json
{
"initial_routes": [
[
{
"route": [
{
"arrival_time_s": 0,
"actual_arrival_time_s": 0,
"departure_time_s": 0,
"actual_departure_time_s": 0,
"actual_service_start_time_s": 0,
"waiting_duration_s": 0,
"multi_order": false,
"load_to_head": [
0,
"string"
],
"load_to_trailer": [
0,
"string"
],
"node": {
"type": "depot",
"value": {
"fixed_position": false,
"undroppable": false,
"fixed_run": false,
"fixed_shift": false,
"fixed_vehicle": false,
"keep_in_vehicle": false,
"id": 0,
"pickup_id": 0,
"pickup_ids": [
0,
"string"
],
"delivered_orders": [
0,
"string"
],
"picked_orders": [
0,
"string"
],
"service_waiting_duration_s": 0,
"total_service_duration_s": 0,
"actual_total_service_duration_s": 0,
"added_shared_service_duration_s": 0,
"loaded_orders": [
0,
"string"
],
"delivery_deadline": "string",
"trailer_used": false,
"trailer_decoupled": false,
"anchor_mode": "Decoupling",
"parking_mode": "ParkingBegin",
"parking_type": "trailer",
"zones": [
"string"
],
"split_info": {
"parts_count": 0,
"part_id": 0,
"order_ratio": 0,
"weight_kg": 0,
"units": 0,
"volume_cbm": 0
},
"unfeasible_reasons": [
{
"type": "OVERLOAD_WEIGHT",
"custom_type": "string",
"text": "string",
"overload": 0
},
{
"type": "FAILED_HARD_TIME_WINDOW",
"text": "string",
"late_duration_s": 0
},
{
"type": "REQUIRED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "EXCLUDED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "TRANSIT_TIME_VIOLATION",
"text": "string",
"overrun_s": 0
},
{
"type": "INCOMPATIBLE_LOAD_TYPES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"types": [
{
"other_type": "string",
"self_type": "string"
}
]
}
]
},
{
"type": "INCOMPATIBLE_ZONES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"zones": [
{
"other_zone": "string",
"self_zone": "string"
}
]
}
]
},
{
"type": "ALLOWED_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "FORBIDDEN_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{}
]
}
}
}
],
"vehicle_id": 0,
"shift": {
"id": "string",
"balanced_group_id": "string",
"start": {
"arrival_time_s": 0,
"actual_arrival_time_s": 0,
"departure_time_s": 0,
"actual_departure_time_s": 0,
"actual_service_start_time_s": 0,
"waiting_duration_s": 0,
"multi_order": false,
"load_to_head": [
0,
"string"
],
"load_to_trailer": [
0,
"string"
],
"node": {
"type": "depot",
"value": {
"fixed_position": false,
"undroppable": false,
"fixed_run": false,
"fixed_shift": false,
"fixed_vehicle": false,
"keep_in_vehicle": false,
"id": 0,
"pickup_id": 0,
"pickup_ids": [
0,
"string"
],
"delivered_orders": [
0,
"string"
],
"picked_orders": [
0,
"string"
],
"service_waiting_duration_s": 0,
"total_service_duration_s": 0,
"actual_total_service_duration_s": 0,
"added_shared_service_duration_s": 0,
"loaded_orders": [
0,
"string"
],
"delivery_deadline": "string",
"trailer_used": false,
"trailer_decoupled": false,
"anchor_mode": "Decoupling",
"parking_mode": "ParkingBegin",
"parking_type": "trailer",
"zones": [
"string"
],
"split_info": {
"parts_count": 0,
"part_id": 0,
"order_ratio": 0,
"weight_kg": 0,
"units": 0,
"volume_cbm": 0
},
"unfeasible_reasons": [
{
"type": "OVERLOAD_WEIGHT",
"custom_type": "string",
"text": "string",
"overload": 0
},
{
"type": "FAILED_HARD_TIME_WINDOW",
"text": "string",
"late_duration_s": 0
},
{
"type": "REQUIRED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "EXCLUDED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "TRANSIT_TIME_VIOLATION",
"text": "string",
"overrun_s": 0
},
{
"type": "INCOMPATIBLE_LOAD_TYPES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"types": [
{
"other_type": "string",
"self_type": "string"
}
]
}
]
},
{
"type": "INCOMPATIBLE_ZONES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"zones": [
{
"other_zone": "string",
"self_zone": "string"
}
]
}
]
},
{
"type": "ALLOWED_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "FORBIDDEN_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{}
]
}
}
},
"end": {
"arrival_time_s": 0,
"actual_arrival_time_s": 0,
"departure_time_s": 0,
"actual_departure_time_s": 0,
"actual_service_start_time_s": 0,
"waiting_duration_s": 0,
"multi_order": false,
"load_to_head": [
0,
"string"
],
"load_to_trailer": [
0,
"string"
],
"node": {
"type": "depot",
"value": {
"fixed_position": false,
"undroppable": false,
"fixed_run": false,
"fixed_shift": false,
"fixed_vehicle": false,
"keep_in_vehicle": false,
"id": 0,
"pickup_id": 0,
"pickup_ids": [
0,
"string"
],
"delivered_orders": [
0,
"string"
],
"picked_orders": [
0,
"string"
],
"service_waiting_duration_s": 0,
"total_service_duration_s": 0,
"actual_total_service_duration_s": 0,
"added_shared_service_duration_s": 0,
"loaded_orders": [
0,
"string"
],
"delivery_deadline": "string",
"trailer_used": false,
"trailer_decoupled": false,
"anchor_mode": "Decoupling",
"parking_mode": "ParkingBegin",
"parking_type": "trailer",
"zones": [
"string"
],
"split_info": {
"parts_count": 0,
"part_id": 0,
"order_ratio": 0,
"weight_kg": 0,
"units": 0,
"volume_cbm": 0
},
"unfeasible_reasons": [
{
"type": "OVERLOAD_WEIGHT",
"custom_type": "string",
"text": "string",
"overload": 0
},
{
"type": "FAILED_HARD_TIME_WINDOW",
"text": "string",
"late_duration_s": 0
},
{
"type": "REQUIRED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "EXCLUDED_TAGS_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "TRANSIT_TIME_VIOLATION",
"text": "string",
"overrun_s": 0
},
{
"type": "INCOMPATIBLE_LOAD_TYPES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"types": [
{
"other_type": "string",
"self_type": "string"
}
]
}
]
},
{
"type": "INCOMPATIBLE_ZONES_VIOLATION",
"text": "string",
"incompatibilities": [
{
"incompatible_order_id": 0,
"zones": [
{
"other_zone": "string",
"self_zone": "string"
}
]
}
]
},
{
"type": "ALLOWED_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{
"type": "FORBIDDEN_ZONES_VIOLATION",
"text": "string",
"tags": [
"string"
]
},
{}
]
}
}
}
},
"immutable": false,
"fixed_order": false
}
]
],
"depot": {
"id": 0,
"preset_id": "string",
"ref": "string",
"point": {
"lat": 0,
"lon": 0
},
"service_duration_s": 0,
"hard_window": false,
"title": "string",
"description": "string",
"address": "string",
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
],
"type": "depot",
"flexible_start_time": false,
"crossdock_safety_waiting_duration_s": 3600,
"finish_service_duration_s": 0,
"preliminary_service_duration_s": 0,
"time_windows_loading": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
]
},
"time_windows_refilling": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
]
},
"time_windows_unloading": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
]
},
"package_throughput": {
"kg_per_hour": 0,
"units_per_hour": 0
},
"throughput": {
"kg_per_hour": 0,
"units_per_hour": 0,
"vehicle_count": [
{
"time_window": "string",
"value": 0
}
]
},
"penalty": {
"package_throughput": {
"fixed": 1000,
"kg": 50,
"unit": 100
},
"throughput": {
"fixed": 1000,
"kg": 50,
"unit": 100,
"vehicle": 100000
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
},
"out_of_time": {
"fixed": 1000,
"minute": 17
}
}
},
"locations": [
{
"id": 0,
"ref": "string",
"preset_id": "string",
"point": {
"lat": 0,
"lon": 0
},
"service_duration_s": 0,
"hard_window": false,
"title": "string",
"description": "string",
"address": "string",
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
],
"shared_service_duration_s": 0,
"client_service_duration_s": 0,
"parking_service_duration_s": 0,
"depot_duration_s": 0,
"crossdock_service_duration_s": 0,
"required_tags": [
"string"
],
"optional_tags": [
{
"tag": "string",
"value": 0
}
],
"load_types": [
"string"
],
"type": "depot",
"crossdock_mode": "deny",
"may_drop_in_crossdock": true,
"client_id": 0,
"delivery_to": 0,
"delivery_to_any": [
0,
"string"
],
"phone": "string",
"shared_with_company_ids": [
0
],
"depot_ready_time": "string",
"depot_expiring_time": "string",
"delivery_deadline": "string",
"comments": "string",
"use_in_proximity": true,
"allow_trailers": false,
"max_total_vehicles": 0,
"sequence_order": 0,
"in_lifo_order": false,
"pickup_from_any": false,
"depot_id": [
0,
"string"
],
"custom_value": 0,
"transit_time": {
"limit_s": 0,
"hard_limit_s": 0
},
"shipment_size": {
"weight_kg": 0,
"units": 0,
"volume_cbm": 0,
"custom": 0,
"volume": {
"align": "all_axes",
"depth_m": 0,
"height_m": 0,
"type": "bulk",
"width_m": 0
}
},
"penalty": {
"transit_time": {},
"drop": 1000000,
"delivery_deadline": {
"fixed": 1000,
"minute": 17
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
},
"out_of_time": {
"fixed": 1000,
"minute": 17
}
}
}
],
"zones": [
{
"id": "string",
"geometry": {
"coordinates": [
[
[
0
]
]
],
"type": "string"
}
}
],
"options": {
"preset_id": "string",
"quality": "low",
"date": "string",
"time_zone": 0,
"absolute_time": false,
"routing_mode": "driving",
"weighted_drop_penalty": false,
"restart_on_drop": false,
"minimize_lateness_risk": false,
"penalize_late_service": false,
"ignore_min_stops_for_unused": false,
"ignore_zones": false,
"post_optimization": false,
"load_when_ready": false,
"critical_lateness_risk_probability": 20,
"matrix_router": "main",
"incompatible_load_types": [
[
"string"
]
],
"incompatible_zones": [
[
"string"
]
],
"proximity_factor": 0,
"global_proximity_factor": 0,
"max_drop_penalty_percentage": 100,
"merge_multiorders": false,
"wait_in_multiorders": true,
"balanced_groups": [
{
"id": "string",
"penalty": {
"hour": 200,
"stop": 100
}
}
],
"points_throughputs": [
{
"throughput": {
"kg_per_hour": 0,
"units_per_hour": 0,
"vehicle_count": [
{
"time_window": "string",
"value": 0
}
]
},
"penalty": {
"throughput": {
"fixed": 1000,
"kg": 50,
"unit": 100,
"vehicle": 100000
}
},
"point": {
"lat": 0,
"lon": 0
}
}
],
"location_groups": [
{
"location_ids": [
0,
"string"
],
"title": "string",
"solid": false,
"dependent": false
}
],
"avoid_tolls": false,
"fix_planned_shifts": false,
"template_rest_schedules": [
{
"breaks": [
{
"work_time_range_till_rest": "string",
"work_time_range_from_start": "string",
"continuous_travel_time_range": "string",
"travel_time_range": "string",
"rest_duration_s": 0,
"route_duration_s": 0,
"necessary_route_duration_s": 0,
"type": "string",
"before_first_location": false,
"after_last_location": false,
"merge_with_types": [
"string"
],
"repeatable": false,
"penalty": {
"early": {
"fixed": 1000,
"minute": 17
},
"late": {
"fixed": 1000,
"minute": 17
}
}
}
],
"id": "string"
}
],
"enable_vehicle_classes": true,
"close_locations_during_post_optimization_only": false,
"penalty": {
"multiorders": {
"per_extra_point": 0,
"per_extra_vehicle": 0,
"per_extra_visit": 0
},
"drop_penalty_percentage": {
"fixed": 1000,
"per_percent": 50
}
}
},
"vehicles": [
{
"id": 0,
"preset_id": "string",
"depot_id": [
0,
"string"
],
"starting_depot_id": [
0,
"string"
],
"ending_depot_id": [
0,
"string"
],
"middle_depot_id": [
0,
"string"
],
"cost": {
"fixed": 3000,
"run": 0,
"hour": 100,
"km": 8,
"tonne_km": 0,
"location": 0
},
"ref": "string",
"visited_locations": [
{
"id": 0,
"shift_id": "string",
"wait_if_early": true,
"delivered_orders": [
0,
"string"
],
"picked_orders": [
0,
"string"
],
"is_middle_depot": false,
"anchor_mode": "Decoupling",
"time": "string"
}
],
"fixed_work_breaks": [
{
"work_duration_s": 0,
"shift_id": "string"
}
],
"tags": [
"string"
],
"excluded_tags": [
"string"
],
"allowed_zones": [
"string"
],
"forbidden_zones": [
"string"
],
"incompatible_load_types": [
[
"string"
]
],
"crossdock_mode": "deny",
"visit_depot_at_start": true,
"allow_different_depots_in_route": false,
"return_to_depot": true,
"start_at": 0,
"finish_at": 0,
"global_proximity_attraction_point": 0,
"shifts": [
{
"id": "string",
"preset_id": "string",
"balanced_group_id": "string",
"time_window": "string",
"hard_time_window": "string",
"max_duration_s": 172800,
"hard_max_duration_s": 2592000,
"max_mileage_km": 0,
"hard_window": false,
"service_duration_s": 0,
"minimal_stops": 0,
"minimal_unique_stops": 0,
"maximal_stops": 0,
"max_runs": 1,
"penalty": {
"max_mileage": {
"fixed": 1000,
"km": 100
},
"stop_excess": {
"fixed": 0,
"per_stop": 0
},
"unique_stop_lack": {
"fixed": 0,
"per_stop": 0
},
"stop_lack": {
"fixed": 0,
"per_stop": 0
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
},
"out_of_time": {
"fixed": 1000,
"minute": 17
}
}
}
],
"travel_time_multiplier": 1,
"service_duration_multiplier": 1,
"shared_service_duration_multiplier": 1,
"depot_extra_service_duration_s": 0,
"max_runs": 1,
"max_middle_depots": 1,
"routing_mode": "driving",
"imei": 0,
"phone": "string",
"rest_schedule_id": "string",
"fixed_planned_route": false,
"min_stop_weight": 0,
"close_locations": [
{
"routing_mode": "driving",
"search_radius_m": 0,
"soft_search_radius_m": 0,
"duration_till_service_s": {
"value": 1000000000,
"penalty": 0
},
"distance_till_service_m": {
"value": 1000000000,
"penalty": 0
}
}
],
"walking_courier": {
"restrictions": {
"max_walking_edge_distance_m": {
"value": 1000000000,
"penalty": 0
}
},
"cost": {
"hour": 0,
"km": 0
},
"capacity": {
"units": 1000000000
}
},
"penalty": {
"arrival_after_start": {
"average_h": 0,
"as_soon_as_possible": false
},
"min_stop_weight": {
"fixed": 1000,
"kg": 50
}
},
"trailer": {
"decoupling_time_s": 0,
"coupling_time_s": 0,
"rolling_cost": 0,
"rolling_time": {
"fixed_time_s": 0,
"s_per_kg": 0,
"s_per_m3": 0,
"s_per_unit": 0
},
"cost": {
"fixed": 3000,
"run": 0,
"hour": 100,
"km": 8,
"tonne_km": 0,
"location": 0
},
"max_capacity_difference": {
"volume_cbm": 0,
"weight_kg": 0,
"units": 0,
"custom": 0
},
"capacity": {
"weight_kg": 1000000000,
"units": 1000000000,
"custom": 0,
"volume": {
"depth_m": 1000,
"height_m": 1000,
"width_m": 1000
},
"limits": {
"units_perc": 100,
"volume_perc": 100,
"weight_perc": 100
}
}
},
"rest_schedule": {
"breaks": [
{
"work_time_range_till_rest": "string",
"work_time_range_from_start": "string",
"continuous_travel_time_range": "string",
"travel_time_range": "string",
"rest_duration_s": 0,
"route_duration_s": 0,
"necessary_route_duration_s": 0,
"type": "string",
"before_first_location": false,
"after_last_location": false,
"merge_with_types": [
"string"
],
"repeatable": false,
"penalty": {
"early": {
"fixed": 1000,
"minute": 17
},
"late": {
"fixed": 1000,
"minute": 17
}
}
}
]
},
"specs": {
"height": 0,
"width": 0,
"length": 0,
"max_weight": 0,
"max_weight_kg": 0
},
"planned_route": {
"start_time": "string",
"locations": [
{
"id": 0,
"shift_id": "string",
"wait_if_early": true,
"loaded_orders": [
0,
"string"
],
"delivered_orders": [
0,
"string"
],
"picked_orders": [
0,
"string"
],
"delivery_in_current_run": false,
"is_middle_depot": false,
"anchor_mode": "Decoupling"
}
],
"work_breaks": [
{
"work_duration_s": 0,
"shift_id": "string"
}
],
"planned_runs_first": false
},
"capacity": {
"weight_kg": 1000000000,
"units": 1000000000,
"custom": 0,
"volume": {
"width_m": 1000,
"depth_m": 1000,
"height_m": 1000
},
"limits": {
"volume_perc": 100,
"weight_perc": 100,
"units_perc": 100
}
}
}
],
"depots": [
{
"id": 0,
"preset_id": "string",
"ref": "string",
"point": {
"lat": 0,
"lon": 0
},
"service_duration_s": 0,
"hard_window": false,
"title": "string",
"description": "string",
"address": "string",
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"time_window": "string",
"hard_time_window": "string"
}
],
"type": "depot",
"flexible_start_time": false,
"crossdock_safety_waiting_duration_s": 3600,
"finish_service_duration_s": 0,
"preliminary_service_duration_s": 0,
"time_windows_loading": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
]
},
"time_windows_refilling": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
]
},
"time_windows_unloading": {
"time_window": "string",
"hard_time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
]
},
"package_throughput": {
"kg_per_hour": 0,
"units_per_hour": 0
},
"throughput": {
"kg_per_hour": 0,
"units_per_hour": 0,
"vehicle_count": [
{
"time_window": "string",
"value": 0
}
]
},
"penalty": {
"package_throughput": {
"fixed": 1000,
"kg": 50,
"unit": 100
},
"throughput": {
"fixed": 1000,
"kg": 50,
"unit": 100,
"vehicle": 100000
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
},
"out_of_time": {
"fixed": 1000,
"minute": 17
}
}
}
]
}
|
Name |
Description |
|
locations* |
Type: MVRPRequest_locations_item[] List of locations. Min items: |
|
options* |
Type: SolverOptionsMVRP Solver options. It is forbidden to specify options that are not present in the list below. |
|
vehicles* |
Type: MVRPRequest_vehicles_item[] List of vehicles, available for route planning. Min items: |
|
depot |
Type: DepotLocation A depot, by default start and finish point for a vehicle on route. |
|
depots |
Type: MVRPRequest_depots_item[] List of depots. Fields |
|
initial_routes |
Type: InitialRoute[][] List of routes in old response, which has to be loaded into solver. |
|
zones |
Type: MVRPRequest_zones_item[] |
MVRPRequest_locations_item
Location of order to deliver from depot.
|
Name |
Description |
|
point* |
Type: Coordinate WGS84 coordinate of a location. More information |
|
address |
Type: string Address of the location. |
|
allow_trailers |
Type: boolean When Default: |
|
client_id |
Type: integer or string Defines |
|
client_service_duration_s |
Type: number Duration of service at a location, which can be shared among the other orders of the same client (by client_id) at exactly the same location. Default: Min value: Max value: |
|
comments |
Type: string Comments. |
|
crossdock_mode |
Type: string Defines whether it is allowed to deliver this order through a cross-dock depot. * Default: Enum: |
|
crossdock_service_duration_s |
Type: number Time spent at a crossdock location during the unloading of this order. More information Default: Min value: Max value: |
|
custom_value |
Type: number A custom numeric value, associated with location (E.g. the reward for the courier for visiting this location). May be used as a component in vehicle cost function. |
|
delivery_deadline |
Type: string Time by which the |
|
delivery_to |
Type: integer or string Defines |
|
delivery_to_any |
Type: (integer or string)[] A list of |
|
depot_duration_s |
Type: number Time spent at a depot during handling of this location (goods loading, document collection, etc.). More information Default: Min value: Max value: |
|
depot_expiring_time |
Type: string Time by which the order must be taken from the depot, in |
|
depot_id |
Type: integer or string or array |
|
depot_ready_time |
Type: string Time when the order is ready to be taken from any depot, in |
|
description |
Type: string Location description. |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
|
hard_window |
Type: boolean Restricts time window relaxation during route planning. If location cannot be visited within a specified time window, it will be excluded from the route and added to Default: |
|
id |
Type: integer or string Location ID. All locations IDs in task must be unique and have the same type: integer or string. More information |
|
in_lifo_order |
Type: boolean Orders with this field set to Default: |
|
load_types |
Type: string[] Defines types of location load. mustn |
|
max_total_vehicles |
Type: integer Maximal number of vehicles that can be served by an anchor location. Unlimited by default. More information |
|
may_drop_in_crossdock |
Type: boolean May drop pickup order in crossdock location Default: |
|
optional_tags |
Type: MVRPRequest_locations_optional_tags_item[] List of tags which are not required for a vehicle to serve the location, but they can decrease or increase the route cost if satisfied. More information |
|
parking_service_duration_s |
Type: number Duration of parking at location. If the order is delivered using Default: Min value: Max value: |
|
penalty |
Type: MVRPRequest_locations_penalty Penalties for non-completion and time window failure. More information |
|
phone |
Type: string Phone number of delivery receiver. |
|
pickup_from_any |
Type: boolean Delivery-orders that have this field set to Default: |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for location properties. |
|
ref |
Type: string Location reference. |
|
required_tags |
Type: string[] List of tags a vehicle must have to arrive at the location. More information |
|
sequence_order |
Type: integer All locations in vehicle route with specified sequence_order option have to be visited in non-decreasing order of its values. More information |
|
service_duration_s |
Type: number Duration of service at location. Service duration can include any operations at location, such as loading or unloading items from a vehicle, or any other time associated with a location (apart from waiting, which is time after arrival and before service).More information Default: Min value: Max value: |
|
shared_service_duration_s |
Type: number Duration of service at a location, which can be shared among the other orders at exactly the same location. Shared service duration can include such operations as parking of a car, delivering documents, etc. More information Default: Min value: Max value: |
|
shared_with_company_ids |
Type: integer[] IDs of the companies that can access the order information. Min value: |
|
shipment_size |
Type: MVRPRequest_locations_shipment_size Shipment size (dimensions and/or weight). More information |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: MVRPRequest_locations_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
title |
Type: string Location title. |
|
transit_time |
Type: MVRPRequest_locations_transit_time Restrictions on the time the order spends inside a vehicle |
|
type |
Type: string Defines a type of service at the location: Default: Enum: |
|
use_in_proximity |
Type: boolean When Default: |
SolverOptionsMVRP
Solver options. It is forbidden to specify options that are not present in the list below.
|
Name |
Description |
|
time_zone* |
Type: number or string |
|
absolute_time |
Type: boolean Use ISO 8601 format (YYYY-MM-DDTHH:MM:SS+HH:MM) for Default: |
|
avoid_tolls |
Type: boolean Do not use toll roads if possible (only for Default: |
|
balanced_groups |
Type: SolverOptionsMVRP_balanced_groups_item[] Each item in this array defines a balanced group of routes. Each route in a group corresponds to a single vehicle shift. Shifts are linked with groups by |
|
close_locations_during_post_optimization_only |
Type: boolean Apply penalties defined in Default: |
|
critical_lateness_risk_probability |
Type: number If a probability of being late on a location is greater or equal than a specified value, than the location is accounted in Default: Min value: Max value: |
|
date |
Type: string Starting date for all routes ( Pattern: |
|
enable_vehicle_classes |
Type: boolean When true, solver will classify vehicles based on given vehicle specs to calculate more accurate distances between locations. Can be set to false to reduce size of the task and avoid "The task is too big" error. Default: |
|
fix_planned_shifts |
Type: boolean Fix shifts of locations from planned routes. Default: |
|
global_proximity_factor |
Type: number Level of location proximity influence on vehicle routes. Recommended values are from Default: Min value: Max value: |
|
ignore_min_stops_for_unused |
Type: boolean Ignore Default: |
|
ignore_zones |
Type: boolean Ignore all zone-related options in vehicles and locations. More information Default: |
|
incompatible_load_types |
Type: string[][] Each item in this array defines list of location load types, that should not be handled within the same vehicle run. More information |
|
incompatible_zones |
Type: string[][] Each item in this array defines list of location zones, that should not be visited within the same vehicle run. More information Min length: Max length: |
|
load_when_ready |
Type: boolean Start load orders in depot when they are ready (in order of Default: |
|
location_groups |
Type: SolverOptionsMVRP_location_groups_item[] Each item in this array defines a group of locations which should be assigned to the same vehicle shift. Some locations from the group might get dropped. Each location can be referenced by only one location group. More information |
|
matrix_router |
Type: string Matrix router to be used for route planning * Default: Enum: |
|
max_drop_penalty_percentage |
Type: number Maximal relation of drop penalty to the sum of drop penalties in all orders. More information Default: Min value: Max value: |
|
merge_multiorders |
Type: boolean If possible merge those orders which have the same coordinates, i.e. serve them by a single vehicle. More information Default: |
|
minimize_lateness_risk |
Type: boolean Compute and minimize the probability of being late to locations. In other words, avoid routes such that the estimated time of arrival is close to the end of a time window. More information Default: |
|
penalize_late_service |
Type: boolean This option determines whether to penalize for late arrivals or late service. * When Default: |
|
penalty |
Type: SolverOptionsMVRP_penalty Penalties for global solution limitations violation. |
|
points_throughputs |
Type: SolverOptionsMVRP_points_throughputs_item[] Each item in this array defines point throughput. |
|
post_optimization |
Type: boolean Use post optimization: restart algorithm in the last 10% operations with disabled global proximity and balancing. More information Default: |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for task options. |
|
proximity_factor |
Type: number Level of location proximity influence on vehicle routes. Recommended values are from Default: Min value: Max value: |
|
quality |
Type: string Solution quality: * Default: Enum: |
|
restart_on_drop |
Type: boolean Restart to optimize only non-dropped orders, in case we haven't find solutions without drops. Enable this option if drops are expected and acceptable for your business scenario. Default: |
|
routing_mode |
Type: string Transportation method. More information * Default: Enum: |
|
template_rest_schedules |
Type: SolverOptionsMVRP_template_rest_schedules_item[] List of rest schedule templates. More information |
|
wait_in_multiorders |
Type: boolean Allows to wait in multiorders. More information Default: |
|
weighted_drop_penalty |
Type: boolean Compute drop penalty according to shipment weight and volume. It helps optimization when vehicles are highly loaded. Specified location drop penalties are ignored in this case. More information Default: |
MVRPRequest_vehicles_item
Vehicle specification.
|
Name |
Description |
|
id* |
Type: integer or string Vehicle ID. All vehicle IDs in task must be unique and have the same type: integer or string. More information |
|
allow_different_depots_in_route |
Type: boolean Vehicle is allowed to visit depots with different ids in the same route Default: |
|
allowed_zones |
Type: string[] List of zones, which can be visited by vehicle. More information |
|
capacity |
Type: MVRPRequest_vehicles_capacity Vehicle capacity. More information |
|
close_locations |
|
|
cost |
Type: vehicles_cost_0 or string |
|
crossdock_mode |
Type: string Defines whether this machine is allowed to deliver orders to the cross-dock depot. More information * Default: Enum: |
|
depot_extra_service_duration_s |
Type: number Additional time required to load this vehicle in the depot. Default: Min value: Max value: |
|
depot_id |
Type: integer or string or array |
|
ending_depot_id |
Type: integer or string or array |
|
excluded_tags |
Type: string[] List of excluding vehicle tags, checked for compatibility with location tags (POSIX-extended regular expression are used). More information |
|
finish_at |
Type: integer or string Defines |
|
fixed_planned_route |
Type: boolean If Default: |
|
fixed_work_breaks |
Type: MVRPRequest_vehicles_fixed_work_breaks_item[] This list can be used for setting the duration of work before each break for several first breaks in each shift (or the whole route, if no shifts are present). If the list of shifts (see |
|
forbidden_zones |
Type: string[] List of zones, which can not be visited by vehicle. More information |
|
global_proximity_attraction_point |
Type: integer or string Defines |
|
imei |
Type: integer The number of the GPS tracker. |
|
incompatible_load_types |
Type: string[][] Each item in this array defines list of location load types, that should not be handled within the same vehicle run (overrides |
|
max_middle_depots |
Type: integer Maximal number of middle depots (i.e. depots which do not break the run) in the route Default: |
|
max_runs |
Type: integer Maximal number of the vehicle runs from the depot to locations in all shifts. More information Default: |
|
middle_depot_id |
Type: integer or string or array |
|
min_stop_weight |
Type: number Minimal total weight of all orders in one point. More information Default: |
|
penalty |
Type: MVRPRequest_vehicles_penalty Penalties for vehicle limitations violation. |
|
phone |
Type: string Phone number of the courier. |
|
planned_route |
Type: MVRPRequest_vehicles_planned_route A planned vehicle route, should be used to assign already chosen locations to vehicles. These locations will not be dropped even if some strict constraint(s) is violated and will be served by the vehicle. The order of locations provided in this option can be changed for optimization of final route. By default shifts assigned to planned locations can be changed as well. They can be fixed with |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for vehicle properties. |
|
ref |
Type: string Vehicle reference number. |
|
rest_schedule |
Type: MVRPRequest_vehicles_rest_schedule Schedule of rest breaks. More information |
|
rest_schedule_id |
Type: string ID of a rest schedule template used in this vehicle. |
|
return_to_depot |
Type: boolean If true, the vehicle returns to its Default: |
|
routing_mode |
Type: string Transportation method. If present, overrides Enum: |
|
service_duration_multiplier |
Type: number Service duration adjustment coefficient for slow or fast workers. More information Default: Min value: |
|
shared_service_duration_multiplier |
Type: number Shared service duration adjustment coefficient for slow or fast workers. More information Default: Min value: |
|
shifts |
Type: MVRPRequest_vehicles_shifts_item[] List of vehicle shifts. More information |
|
specs |
Type: MVRPRequest_vehicles_specs Vehicle specification. More information |
|
start_at |
Type: integer or string Defines |
|
starting_depot_id |
Type: integer or string or array |
|
tags |
Type: string[] List of vehicle tags, checked for compatibility with location tags (POSIX-extended regular expression are used). More information |
|
trailer |
Type: MVRPRequest_vehicles_trailer Trailer specification. More information |
|
travel_time_multiplier |
Type: number Travel duration adjustment coefficient for slow or fast vehicles. More information Default: Min value: |
|
visit_depot_at_start |
Type: boolean If true, the first route of the vehicle will go through the
Default: |
|
visited_locations |
Type: MVRPRequest_vehicles_visited_locations_item[] List of locations to be visited by a vehicle in exact order as fixed part of the route without optimizations, with optional times of departure from some locations. If the work breaks between visited locations need to be precisely scheduled, use |
|
walking_courier |
Type: MVRPRequest_vehicles_walking_courier Description of a pedestrian courier. |
DepotLocation
A depot, by default start and finish point for a vehicle on route.
|
Name |
Description |
|
point* |
Type: Coordinate WGS84 coordinate of a location. More information |
|
address |
Type: string Address of the location. |
|
crossdock_safety_waiting_duration_s |
Type: number The duration of the minimum time interval between the moment the order arrives at the cross-dock depot and the moment when it can be picked up from there by a vehicle for delivery. This interval is needed so that there is a reserve of time in case the vehicle that brings the orders is late. Default: Min value: Max value: |
|
description |
Type: string Location description. |
|
finish_service_duration_s |
Type: number Duration of service at a depot in the end of a route. Finish service duration can include any operations at depot, e.g. unloading items, documents collection etc. More information Default: Min value: Max value: |
|
flexible_start_time |
Type: boolean By default vehicle start time is equal to either depot, or garage, or shift start time. When this option is set to true, vehicles can start earlier or later than the default start time. In this case the optimal start time will be computed according to cost minimization. More information Also when Default: |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
|
hard_window |
Type: boolean Restricts time window relaxation during route planning. When true, vehicles are allowed to return to depot only within the specified time window. More information Default: |
|
id |
Type: integer or string Location ID. All locations IDs in task must be unique and have the same type: integer or string. More information |
|
package_throughput |
Type: DepotLocation_package_throughput Restriction on packaging speed in depot. |
|
penalty |
Type: DepotLocation_penalty Penalties for depot time window or throughput failure. More information |
|
preliminary_service_duration_s |
Type: number Duration of preliminary service at depot. This duration can include any operations that can be done before loading the vehicle. These operations will be done before Default: Min value: Max value: |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for depot properties. |
|
ref |
Type: string Location reference. |
|
service_duration_s |
Type: number Duration of service at location. Service duration can include any operations at location, such as loading or unloading items from a vehicle, or any other time associated with a location (apart from waiting, which is time after arrival and before service).More information Default: Min value: Max value: |
|
throughput |
Type: DepotLocation_throughput Depot throughput limit. More information |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: DepotLocation_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
time_windows_loading |
Type: any Time windows when the vehicle is allowed to leave the depot on the 1st run |
|
time_windows_refilling |
Type: any Time windows when the vehicle is allowed to visit a depot (or middle depot) for additional loading |
|
time_windows_unloading |
Type: any Time windows when the vehicle is allowed to return to the depot on the last run |
|
title |
Type: string Location title. |
|
type |
Type: string Defines a type of depot: Default: Enum: |
MVRPRequest_depots_item
A depot, by default start and finish point for a vehicle on route.
|
Name |
Description |
|
point* |
Type: Coordinate WGS84 coordinate of a location. More information |
|
address |
Type: string Address of the location. |
|
crossdock_safety_waiting_duration_s |
Type: number The duration of the minimum time interval between the moment the order arrives at the cross-dock depot and the moment when it can be picked up from there by a vehicle for delivery. This interval is needed so that there is a reserve of time in case the vehicle that brings the orders is late. Default: Min value: Max value: |
|
description |
Type: string Location description. |
|
finish_service_duration_s |
Type: number Duration of service at a depot in the end of a route. Finish service duration can include any operations at depot, e.g. unloading items, documents collection etc. More information Default: Min value: Max value: |
|
flexible_start_time |
Type: boolean By default vehicle start time is equal to either depot, or garage, or shift start time. When this option is set to true, vehicles can start earlier or later than the default start time. In this case the optimal start time will be computed according to cost minimization. More information Also when Default: |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
|
hard_window |
Type: boolean Restricts time window relaxation during route planning. When true, vehicles are allowed to return to depot only within the specified time window. More information Default: |
|
id |
Type: integer or string Location ID. All locations IDs in task must be unique and have the same type: integer or string. More information |
|
package_throughput |
Type: MVRPRequest_depots_package_throughput Restriction on packaging speed in depot. |
|
penalty |
Type: MVRPRequest_depots_penalty Penalties for depot time window or throughput failure. More information |
|
preliminary_service_duration_s |
Type: number Duration of preliminary service at depot. This duration can include any operations that can be done before loading the vehicle. These operations will be done before Default: Min value: Max value: |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for depot properties. |
|
ref |
Type: string Location reference. |
|
service_duration_s |
Type: number Duration of service at location. Service duration can include any operations at location, such as loading or unloading items from a vehicle, or any other time associated with a location (apart from waiting, which is time after arrival and before service).More information Default: Min value: Max value: |
|
throughput |
Type: MVRPRequest_depots_throughput Depot throughput limit. More information |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: MVRPRequest_depots_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
time_windows_loading |
Type: any Time windows when the vehicle is allowed to leave the depot on the 1st run |
|
time_windows_refilling |
Type: any Time windows when the vehicle is allowed to visit a depot (or middle depot) for additional loading |
|
time_windows_unloading |
Type: any Time windows when the vehicle is allowed to return to the depot on the last run |
|
title |
Type: string Location title. |
|
type |
Type: string Defines a type of depot: Default: Enum: |
InitialRoute
|
Name |
Description |
|
route* |
Type: InitialRouteNode[] Sequence of route nodes, comprising a route. |
|
vehicle_id* |
Type: integer or string Vehicle ID. All vehicle IDs in task must be unique and have the same type: integer or string. More information |
|
fixed_order |
Type: boolean Locations, specified in initial_routes, cannot be reordered Default: |
|
immutable |
Type: boolean A route, specified in initial_routes, is used without changes. Default: |
|
shift |
Type: InitialRouteShift |
MVRPRequest_zones_item
|
Name |
Description |
|
geometry* |
|
|
id* |
Type: string Zone id |
Coordinate
WGS84 coordinate of a location. More information
|
Name |
Description |
|
lat* |
Type: number Min value: Max value: |
|
lon* |
Type: number Min value: Max value: |
MVRPRequest_locations_optional_tags_item
An optional tag with bonus or penalty.
|
Name |
Description |
|
tag* |
Type: string An arbitrary tag. |
|
value* |
Type: number Value of the tag. When location is served by a vehicle with a matching tag in |
MVRPRequest_locations_penalty
Penalties for non-completion and time window failure. More information
|
Name |
Description |
|
delivery_deadline |
Type: locations_penalty_delivery_deadline Penalty components for late deliveries from |
|
drop |
Type: number Penalty for not delivering an order. More information Default: |
|
early |
Type: locations_penalty_early Penalty components for early service (used instead of |
|
late |
Type: locations_penalty_late Penalty components for late visits (used instead of |
|
out_of_time |
Type: locations_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
transit_time |
Type: any Penalty components for exceeding transit time |
MVRPRequest_locations_shipment_size
Shipment size (dimensions and/or weight). More information
|
Name |
Description |
|
custom |
Type: number Size of shipment in custom units. Sizes in custom units are defined in format Default: Min value: |
|
units |
Type: number Size of shipment in custom units. Default: Min value: Max value: |
|
volume |
Type: locations_shipment_size_volume Shipment dimensions and type. |
|
volume_cbm |
Type: number Explicit volume, cubic meters. By default, the value is taken from "volume", if nothing is specified here. Min value: |
|
weight_kg |
Type: number Weight of shipment, kilograms. Default: Min value: Max value: |
MVRPRequest_locations_time_windows_item
|
Name |
Description |
|
time_window* |
Type: string Allowed time window to visit location, in |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
MVRPRequest_locations_transit_time
Restrictions on the time the order spends inside a vehicle
|
Name |
Description |
|
hard_limit_s |
Type: number Hard time limit, values above it are unacceptable Min value: Max value: |
|
limit_s |
Type: number Soft time limit, values above it are acceptable but they will be penalized Min value: Max value: |
SolverOptionsMVRP_balanced_groups_item
A group of balanced routes.
|
Name |
Description |
|
id* |
Type: string A unique ID of a balanced group of routes. |
|
penalty |
Type: SolverOptionsMVRP_balanced_groups_penalty Penalties for imbalanced routes. |
SolverOptionsMVRP_location_groups_item
A group of locations which should be assigned to the same vehicle shift.
|
Name |
Description |
|
location_ids* |
Type: (integer or string)[] Reference to a location specified in |
|
dependent |
Type: boolean When true, either all or none of the locations in group will be served. Default: |
|
solid |
Type: boolean When true, all assigned locations in group will be served consecutively, but their order is not fixed. Default: |
|
title |
Type: string |
SolverOptionsMVRP_penalty
Penalties for global solution limitations violation.
|
Name |
Description |
|
drop_penalty_percentage |
Type: SolverOptionsMVRP_penalty_drop_penalty_percentage Penalty components for |
|
multiorders |
Type: SolverOptionsMVRP_penalty_multiorders Penalty components for extra visits to multiorder poins. |
SolverOptionsMVRP_points_throughputs_item
Point's throughput.
|
Name |
Description |
|
penalty |
|
|
point |
Type: SolverOptionsMVRP_points_throughputs_point WGS84 coordinate of a location. More information |
|
throughput |
Type: SolverOptionsMVRP_points_throughputs_throughput Point throughput limit. |
SolverOptionsMVRP_template_rest_schedules_item
Template schedule of rest breaks.
|
Name |
Description |
|
breaks* |
Type: array |
|
id* |
Type: string A unique ID of a template. |
MVRPRequest_vehicles_capacity
Vehicle capacity. More information
|
Name |
Description |
|
custom |
Type: number Amount of custom units a vehicle is able to carry. Capacities in custom units are defined in format Min value: |
|
limits |
Type: vehicles_capacity_limits Vehicle load limits. |
|
units |
Type: number Amount of custom units a vehicle is able to carry. Default: Min value: |
|
volume |
Type: vehicles_capacity_volume Vehicle dimensions. |
|
weight_kg |
Type: number Weight a vehicle is able to carry, kilograms. Default: Min value: |
MVRPRequest_vehicles_close_locations_item
|
Name |
Description |
|
distance_till_service_m |
Type: any |
|
duration_till_service_s |
Type: any |
|
routing_mode |
Type: string Transportation method is used to determine close locations. This parameter can be used only if the Enum: |
|
search_radius_m |
Type: number Maximum distance between two locations in meters at which locations on which the restriction is applied. Default: Min value: Max value: |
|
soft_search_radius_m |
Type: number If value is greater than the corresponding value of the Default: Min value: Max value: |
vehicles_cost_0
Vehicle cost. More information
|
Name |
Description |
|
fixed |
Type: number Cost per fact of vehicle use (cost occurred if vehicle is included in route). Default: Min value: |
|
hour |
Type: number Cost of using vehicle per hour. It should not be zero or very small, otherwise you may get routes which are not optimal in terms of time. Default: Min value: |
|
km |
Type: number Cost of using vehicle per kilometer. It should not be zero or very small, otherwise you may get routes which are not optimal in terms of distance. Default: Min value: |
|
location |
Type: number Cost of using vehicle per location (default 0). Default: Min value: |
|
run |
Type: number Cost per single vehicle run from depot to locations. Default: Min value: |
|
tonne_km |
Type: number Cost of carrying one tonne for one kilometer (default 0). Default: Min value: |
MVRPRequest_vehicles_fixed_work_breaks_item
|
Name |
Description |
|
work_duration_s* |
Type: number Duration of continuous work before the break, seconds. Min value: Max value: |
|
shift_id |
Type: string Unique identifier of a shift. |
MVRPRequest_vehicles_penalty
Penalties for vehicle limitations violation.
|
Name |
Description |
|
arrival_after_start |
Type: vehicles_penalty_arrival_after_start Penalty components for arrived after start of timewindow |
|
min_stop_weight |
Type: vehicles_penalty_min_stop_weight Penalty components for insufficient total orders weight in point. |
MVRPRequest_vehicles_planned_route
A planned vehicle route, should be used to assign already chosen locations to vehicles. These locations will not be dropped even if some strict constraint(s) is violated and will be served by the vehicle. The order of locations provided in this option can be changed for optimization of final route. By default shifts assigned to planned locations can be changed as well. They can be fixed with fix_planned_shifts solver option. More information
|
Name |
Description |
|
locations* |
Type: vehicles_planned_route_locations_item[] A planned order of locations in a vehicle route including all shifts and multiple runs. If the list of shifts (see |
|
planned_runs_first |
Type: boolean It is necessary to visit all depots, listed in Default: |
|
start_time |
Type: string Route start time, in |
|
work_breaks |
Type: MVRPRequest_vehicles_fixed_work_breaks_item[] Planned work breaks for a vehicle route including all shifts and multiple runs. If the list of shifts (see |
MVRPRequest_vehicles_rest_schedule
Schedule of rest breaks. More information
|
Name |
Description |
|
breaks* |
Type: array |
MVRPRequest_vehicles_shifts_item
Vehicle shift.
|
Name |
Description |
|
id* |
Type: string Unique identifier of a shift. |
|
time_window* |
Type: string Allowed time window to visit location, in |
|
balanced_group_id |
Type: string ID of a corresponding balanced group of routes (see the option |
|
hard_max_duration_s |
Type: number Hard limit on the maximum shift duration in seconds. If both Default: Min value: Max value: |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
|
hard_window |
Type: boolean Restricts time window relaxation during route planning. When true, vehicles are allowed to finish a shift only within the specified time window. More information Default: |
|
max_duration_s |
Type: number Maximal duration of a shift in seconds. If a planned shift duration is greater than specified, the shift out of time penalties are applied. Default: Min value: Max value: |
|
max_mileage_km |
Type: number Maximal mileage of the vehicle during the shift in kilometers. If a planned mileage is greater than this value, the penalties from a shift parameter Min value: |
|
max_runs |
Type: integer Maximal number of the vehicle runs from the depot to locations in shift. Default: |
|
maximal_stops |
Type: integer Maximal number of shift stops, if the final stop count is greater than this value, Default: Min value: |
|
minimal_stops |
Type: integer Minimal number of shift stops, if the final stop count is less than this value, Default: Min value: |
|
minimal_unique_stops |
Type: integer Minimal number of shift stops with unique coordinates, if the final stop count is less than this value, Default: Min value: |
|
penalty |
Type: shifts_penalty Penalties for shift constraints violation. |
|
preset_id |
Type: string Preset ID (preset.number from reference-book) for vehicle shift properties. |
|
service_duration_s |
Type: number Duration of service in between shifts (in seconds). It can include any operations needed to finish the shift, such as time to change a driver, exchange papers etc (default: 0). Default: Min value: Max value: |
MVRPRequest_vehicles_specs
Vehicle specification. More information
|
Name |
Description |
|
height |
Type: number Height of the vehicle, meters. Min value: |
|
length |
Type: number Length of the vehicle, meters. Min value: |
|
max_weight |
Type: number Maximum weight of the vehicle, tons. Min value: |
|
max_weight_kg |
Type: number Maximum weight of the vehicle, kilograms. When solving the problem, the characteristic will be rounded up to tons.If both characteristics are set Min value: |
|
width |
Type: number Width of the vehicle, meters. Min value: |
MVRPRequest_vehicles_trailer
Trailer specification. More information
|
Name |
Description |
|
capacity |
Type: vehicles_trailer_capacity Trailer capacity. |
|
cost |
Type: vehicles_trailer_cost Trailer cost. |
|
coupling_time_s |
Type: number Extra time to couple the trailer, seconds. Default: Min value: Max value: |
|
decoupling_time_s |
Type: number Extra time to decouple the trailer, seconds. Default: Min value: Max value: |
|
max_capacity_difference |
Type: vehicles_trailer_max_capacity_difference The maximum difference between the loading of the trailer and the head. |
|
rolling_cost |
Type: number Penalty for each rolling of goods from the trailer to the head. Default: Min value: |
|
rolling_time |
Type: vehicles_trailer_rolling_time Time for loading shipments from trailer to head. In case multiple types of time are specified, the one that takes the most time is chosen. In case none of them is specified, only fixed loading time is used. |
MVRPRequest_vehicles_visited_locations_item
|
Name |
Description |
|
id* |
Type: integer or string Reference to a location specified in |
|
anchor_mode |
Type: string Default: Enum: |
|
delivered_orders |
Type: (integer or string)[] List of IDs of orders delivered to the crossdock for delivery to the destination. |
|
is_middle_depot |
Type: boolean Location is a middle depot. Default: |
|
picked_orders |
Type: (integer or string)[] A list of IDs of pickup orders picked up in the crossdock. |
|
shift_id |
Type: string Unique identifier of a shift. |
|
time |
Type: string Time of departure from a location, in |
|
wait_if_early |
Type: boolean This option determines what happens if a vehicle arrives to the planned location early. When Default: |
MVRPRequest_vehicles_walking_courier
Description of a pedestrian courier.
|
Name |
Description |
|
capacity |
Type: vehicles_walking_courier_capacity Capacity of a courier |
|
cost |
Type: vehicles_walking_courier_cost Courier work cost. |
|
restrictions |
Type: any |
DepotLocation_package_throughput
Restriction on packaging speed in depot.
|
Name |
Description |
|
kg_per_hour |
Type: number Depot package throughput, kilograms per hour. Min value: |
|
units_per_hour |
Type: number Depot package throughput, units per hour. Min value: |
DepotLocation_penalty
Penalties for depot time window or throughput failure. More information
|
Name |
Description |
|
early |
Type: DepotLocation_penalty_early Penalty components for early service (used instead of |
|
late |
Type: DepotLocation_penalty_late Penalty components for late visits (used instead of |
|
out_of_time |
Type: DepotLocation_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
package_throughput |
Type: DepotLocation_penalty_package_throughput Penalty components for package throughput exceeding. |
|
throughput |
Type: DepotLocation_penalty_throughput Penalty components for throughput exceeding. |
DepotLocation_throughput
Depot throughput limit. More information
|
Name |
Description |
|
kg_per_hour |
Type: number Depot throughput, kilograms per hour. Min value: |
|
units_per_hour |
Type: number Depot throughput, custom units per hour. Min value: |
|
vehicle_count |
Type: array or number |
DepotLocation_time_windows_item
|
Name |
Description |
|
time_window* |
Type: string Allowed time window to visit location, in |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
MVRPRequest_depots_package_throughput
Restriction on packaging speed in depot.
|
Name |
Description |
|
kg_per_hour |
Type: number Depot package throughput, kilograms per hour. Min value: |
|
units_per_hour |
Type: number Depot package throughput, units per hour. Min value: |
MVRPRequest_depots_penalty
Penalties for depot time window or throughput failure. More information
|
Name |
Description |
|
early |
Type: depots_penalty_early Penalty components for early service (used instead of |
|
late |
Type: depots_penalty_late Penalty components for late visits (used instead of |
|
out_of_time |
Type: depots_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
package_throughput |
Type: depots_penalty_package_throughput Penalty components for package throughput exceeding. More information |
|
throughput |
Type: depots_penalty_throughput Penalty components for throughput exceeding. More information |
MVRPRequest_depots_throughput
Depot throughput limit. More information
|
Name |
Description |
|
kg_per_hour |
Type: number Depot throughput, kilograms per hour. Min value: |
|
units_per_hour |
Type: number Depot throughput, custom units per hour. Min value: |
|
vehicle_count |
Type: array or number |
MVRPRequest_depots_time_windows_item
|
Name |
Description |
|
time_window* |
Type: string Allowed time window to visit location, in |
|
hard_time_window |
Type: string Allowed hard time window to visit location, in |
InitialRouteNode
Route node, contains information about a visited location or a work break, transit information and arrival time.
|
Name |
Description |
|
actual_arrival_time_s |
Type: number or string Actual arrival time at the location. |
|
actual_departure_time_s |
Type: number or string Actual time of departure from the location. |
|
actual_service_start_time_s |
Type: number or string Actual time of service start in the location. |
|
arrival_time_s |
Type: number or string Arrival time at the location. Arrival happened before the start of the time window, will incur waiting time. |
|
departure_time_s |
Type: number or string Time of departure from the location. |
|
load_to_head |
Type: (integer or string)[] List of orders that should be loaded to the head of the vehicle at depot or anchor location, in case trailers are used. Orders are listed in the order of serving. |
|
load_to_trailer |
Type: (integer or string)[] List of orders that should be loaded to the trailer of the vehicle at depot, in case trailers are used. Orders are listed in the order of serving. |
|
multi_order |
Type: boolean An order is one of several orders at exactly the same location which are served together. Arrival time is the same for all orders in the group, also the orders share Default: |
|
node |
Type: InitialRouteNodeDepot or InitialRouteNodeLocation or InitialRouteNodeWorkBreak or InitialRouteNodeCourierPosition Route component. |
|
waiting_duration_s |
Type: number Waiting duration, time spent at location after arrival and before the start of the time window, seconds. |
InitialRouteShift
|
Name |
Description |
|
id* |
Type: string Unique identifier of a shift. |
|
balanced_group_id |
Type: string ID of a corresponding balanced group of routes (see the option |
|
end |
Type: InitialRouteNode Route node, contains information about a visited location or a work break, transit information and arrival time. |
|
start |
Type: InitialRouteNode Route node, contains information about a visited location or a work break, transit information and arrival time. |
MVRPRequest_zones_geometry
|
Name |
Description |
|
coordinates |
Type: number[][][] Always consists of two elements: longitude and lattitude |
|
type |
Type: string Always equals |
locations_penalty_delivery_deadline
Penalty components for late deliveries from pickup locations to depots. Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the depot is visited after the deadline. Default: |
|
minute |
Type: number Penalty for each minute of lateness, when the depot is visited after the deadline. Default: |
locations_penalty_early
Penalty components for early service (used instead of out_of_time penalty). More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location starts being served before the start of the time window. Default: |
|
minute |
Type: number Penalty for each minute of early arrival when the location starts being served before the start of the time window. Default: |
locations_penalty_late
Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited after the end of the time window. Default: |
|
minute |
Type: number Penalty for each minute of lateness, when the location is visited after the end of the time window. Default: |
locations_penalty_out_of_time
Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited outside of the time window. See the specifications of Default: |
|
minute |
Type: number Penalty for each minute of lateness or early arrival when the location is visited outside of the time window. See the specifications of Default: |
locations_shipment_size_volume
Shipment dimensions and type.
|
Name |
Description |
|
depth_m* |
Type: number Depth, meters. Default: Min value: Max value: |
|
height_m* |
Type: number Height, meters. Default: Min value: Max value: |
|
width_m* |
Type: number Width, meters. Default: Min value: Max value: |
|
align |
Type: string Defines allowed container alignment for
Default: Enum: |
|
type |
Type: string Container type:
Default: Enum: |
SolverOptionsMVRP_balanced_groups_penalty
Penalties for imbalanced routes.
|
Name |
Description |
|
hour* |
Type: number Penalty per hour of root-sum-square deviation of a route duration from an average duration of a balanced group of routes. Default: Min value: |
|
stop* |
Type: number Penalty per each missing or extra stop of root-sum-square deviation of a route stop count from an average number of stops in a balanced group of routes. Default: Min value: |
SolverOptionsMVRP_penalty_drop_penalty_percentage
Penalty components for max_drop_penalty_percentage violation.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if drop penalty ratio is too high. Default: |
|
per_percent |
Type: number Penalty for each exceeding percent of drop penalty percentage. Default: |
SolverOptionsMVRP_penalty_multiorders
Penalty components for extra visits to multiorder poins.
|
Name |
Description |
|
per_extra_point |
Type: number Penalty for every point where vehicles/couriers arrive more than once. Default: Min value: |
|
per_extra_vehicle |
Type: number Penalty for every extra vehicle/courier that arrives at multi-order points. Default: Min value: |
|
per_extra_visit |
Type: number Penalty for each extra visit to multi-order points. Default: Min value: |
SolverOptionsMVRP_points_throughputs_penalty
|
Name |
Description |
|
throughput |
Type: points_throughputs_penalty_throughput Penalty components for throughput exceeding. More information |
SolverOptionsMVRP_points_throughputs_point
WGS84 coordinate of a location. More information
|
Name |
Description |
|
lat* |
Type: number Min value: Max value: |
|
lon* |
Type: number Min value: Max value: |
SolverOptionsMVRP_points_throughputs_throughput
Point throughput limit.
|
Name |
Description |
|
kg_per_hour |
Type: number Point throughput, kilograms per hour. Min value: |
|
units_per_hour |
Type: number Point throughput, custom units per hour. Min value: |
|
vehicle_count |
Type: array or number |
template_rest_schedules_breaks_0_item
Work break.
|
Name |
Description |
|
rest_duration_s* |
Type: number Duration of rest, seconds. Min value: Max value: |
|
after_last_location |
Type: boolean When true, work break will be put after the last location. If possible it will be merged with the first work break of type listed in Default: |
|
before_first_location |
Type: boolean When true, work break will be put before the first location. If possible it will be merged with the last work break of type listed in Default: |
|
continuous_travel_time_range |
Type: string Minimal and maximal duration of continuous travel time before rest, format: |
|
merge_with_types |
Type: string[] Types of work breaks this work break can be merged with. This field can only be used with |
|
necessary_route_duration_s |
Type: number Minimal duration of route needed to make work break necessary, seconds. Min value: Max value: |
|
penalty |
Type: _penalty Penalties applied for violations of work break conditions. |
|
repeatable |
Type: boolean When true, this work break will be repeated until the end of route. Can only be true for the last break in the chain. Default: |
|
route_duration_s |
Type: number Minimal duration of route needed to use work break, seconds. Min value: Max value: |
|
travel_time_range |
Type: string Minimal and maximal duration of travel before rest, format: |
|
type |
Type: string Type of work break. Used in |
|
work_time_range_from_start |
Type: string Minimal and maximal duration of time from start of route until rest, format: |
|
work_time_range_till_rest |
Type: string Minimal and maximal duration of work before rest, format: |
vehicles_capacity_limits
Vehicle load limits.
|
Name |
Description |
|
units_perc |
Type: number Upper limit of total shipments size in custom units as a percentage of a vehicle capacity Default: Min value: |
|
volume_perc |
Type: number Upper limit of total shipments volume as a percentage of vehicle load bay volume. For container fitting purposes it is assumed that each dimension is multiplied by the cubic root of Default: Min value: |
|
weight_perc |
Type: number Upper limit of total shipments weight as a percentage of total weight the vehicle is allowed to carry. Default: Min value: |
vehicles_capacity_volume
Vehicle dimensions.
|
Name |
Description |
|
depth_m* |
Type: number Depth, meters. Default: Min value: Max value: |
|
height_m* |
Type: number Height, meters. Default: Min value: Max value: |
|
width_m* |
Type: number Width, meters. Default: Min value: Max value: |
vehicles_penalty_arrival_after_start
Penalty components for arrived after start of timewindow
|
Name |
Description |
|
as_soon_as_possible |
Type: boolean Option for arrive as soon as possible even it includes added wait in route Default: |
|
average_h |
Type: number Penalty for average arrived after start of timewindow Default: |
vehicles_penalty_min_stop_weight
Penalty components for insufficient total orders weight in point.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if total orders weight is too low. Default: |
|
kg |
Type: number Penalty for each lacking kg of total orders weight. Default: |
vehicles_planned_route_locations_item
|
Name |
Description |
|
id* |
Type: integer or string Reference to a location specified in |
|
anchor_mode |
Type: string Default: Enum: |
|
delivered_orders |
Type: (integer or string)[] List of IDs of orders delivered to the crossdock for delivery to the destination. |
|
delivery_in_current_run |
Type: boolean All orders, loaded in this location, have to be delivered in current run. Default: |
|
is_middle_depot |
Type: boolean Location is a middle depot. Default: |
|
loaded_orders |
Type: (integer or string)[] Ids of |
|
picked_orders |
Type: (integer or string)[] A list of IDs of pickup orders picked up in the crossdock. |
|
shift_id |
Type: string Unique identifier of a shift. |
|
wait_if_early |
Type: boolean This option determines what happens if a vehicle arrives to the planned location early. When Default: |
rest_schedule_breaks_0_item
Work break.
|
Name |
Description |
|
rest_duration_s* |
Type: number Duration of rest, seconds. Min value: Max value: |
|
after_last_location |
Type: boolean When true, work break will be put after the last location. If possible it will be merged with the first work break of type listed in Default: |
|
before_first_location |
Type: boolean When true, work break will be put before the first location. If possible it will be merged with the last work break of type listed in Default: |
|
continuous_travel_time_range |
Type: string Minimal and maximal duration of continuous travel time before rest, format: |
|
merge_with_types |
Type: string[] Types of work breaks this work break can be merged with. This field can only be used with |
|
necessary_route_duration_s |
Type: number Minimal duration of route needed to make work break necessary, seconds. Min value: Max value: |
|
penalty |
Type: _penalty Penalties applied for violations of work break conditions. |
|
repeatable |
Type: boolean When true, this work break will be repeated until the end of route. Can only be true for the last break in the chain. Default: |
|
route_duration_s |
Type: number Minimal duration of route needed to use work break, seconds. Min value: Max value: |
|
travel_time_range |
Type: string Minimal and maximal duration of travel before rest, format: |
|
type |
Type: string Type of work break. Used in |
|
work_time_range_from_start |
Type: string Minimal and maximal duration of time from start of route until rest, format: |
|
work_time_range_till_rest |
Type: string Minimal and maximal duration of work before rest, format: |
shifts_penalty
Penalties for shift constraints violation.
|
Name |
Description |
|
early |
Type: shifts_penalty_early Penalty components for shifts started too early (used instead of |
|
late |
Type: shifts_penalty_late Penalty components for shifts finished too late (used instead of |
|
max_mileage |
Type: shifts_penalty_max_mileage Penalties applied for violating shift's |
|
out_of_time |
Type: shifts_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
stop_excess |
Type: shifts_penalty_stop_excess Penalties applied for violating shift's |
|
stop_lack |
Type: shifts_penalty_stop_lack Penalties applied for violating shift's |
|
unique_stop_lack |
Type: shifts_penalty_unique_stop_lack Penalties applied for violating shift's |
vehicles_trailer_capacity
Trailer capacity.
|
Name |
Description |
|
custom |
Type: number Amount of custom units a trailer is able to carry. Capacities in custom units are defined in format Min value: |
|
limits |
Type: trailer_capacity_limits Trailer load limits. |
|
units |
Type: number Amount of custom units a trailer is able to carry. Default: Min value: |
|
volume |
Type: trailer_capacity_volume Trailer dimensions. |
|
weight_kg |
Type: number Weight a trailer is able to carry, kilograms. Default: Min value: |
vehicles_trailer_cost
Trailer cost.
|
Name |
Description |
|
fixed |
Type: number Cost per fact of trailer use (cost occurred if trailer is used in route). Default: Min value: |
|
hour |
Type: number Cost of using trailer per hour. Default: Min value: |
|
km |
Type: number Cost of using trailer per kilometer. Default: Min value: |
|
location |
Type: number Cost of using trailer per location (default 0). Default: Min value: |
|
run |
Type: number Cost per single vehicle run from depot to locations. Default: Min value: |
|
tonne_km |
Type: number Cost of carrying one tonne for one kilometer (default 0). Default: Min value: |
vehicles_trailer_max_capacity_difference
The maximum difference between the loading of the trailer and the head.
|
Name |
Description |
|
custom |
Type: number A maximum allowable difference in the loaded amount of custom units between the trailer and the head. The difference in custom units are defined in format |
|
units |
Type: number The maximum allowable difference in the loaded amount of custom units between the trailer and the head. |
|
volume_cbm |
Type: number The maximum allowable difference in the loaded volume between the trailer and the head, cubic meters. |
|
weight_kg |
Type: number The maximum allowable difference in the loaded weight between the trailer and the head, kilograms. |
vehicles_trailer_rolling_time
Time for loading shipments from trailer to head. In case multiple types of time are specified, the one that takes the most time is chosen. In case none of them is specified, only fixed loading time is used.
|
Name |
Description |
|
fixed_time_s |
Type: number Fixed time spent each time a trailer is loaded or unloaded, seconds. Default: Min value: Max value: |
|
s_per_kg |
Type: number Loading time per kg, seconds. Default: Min value: Max value: |
|
s_per_m3 |
Type: number Loading time per cubic meter, seconds. Default: Min value: Max value: |
|
s_per_unit |
Type: number Loading time per unit, seconds. Default: Min value: Max value: |
vehicles_walking_courier_capacity
Capacity of a courier
|
Name |
Description |
|
units |
Type: number Amount of custom units a courier is able to carry. Default: Min value: |
vehicles_walking_courier_cost
Courier work cost.
|
Name |
Description |
|
hour |
Type: number Cost per hour of courier walking routes. Default: Min value: |
|
km |
Type: number Cost per kilometer walked by courier. Default: Min value: |
DepotLocation_penalty_early
Penalty components for early service (used instead of out_of_time penalty).
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a vehicle starts serving the depot before the start of the time window. The penalty is applied for any early service, including opening the depot, unloading or uploading the vehicle at the depot or closing the depot. It is applied once for each visit of a depot during which the depot was served early. Default: |
|
minute |
Type: number Penalty for each minute of early service of the depot. Applied in the same cases as the Default: |
DepotLocation_penalty_late
Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied for each visit of the depot after the end of the time window. Starting from a depot is counted for a visit. Default: |
|
minute |
Type: number Penalty for each minute of lateness for every visit of the depot after the end of the time window. Default: |
DepotLocation_penalty_out_of_time
Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the depot is visited outside of the time window. See the specifications of Default: |
|
minute |
Type: number Penalty for each minute of being outside of the time window of the depot. See the specifications of Default: |
DepotLocation_penalty_package_throughput
Penalty components for package throughput exceeding.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if throughput is exceeded. Default: |
|
kg |
Type: number Penalty for each extra kg of throughput exceeding. Default: |
|
unit |
Type: number Penalty for each extra custom unit of throughput exceeding ( Default: |
DepotLocation_penalty_throughput
Penalty components for throughput exceeding.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if throughput is exceeded. Default: |
|
kg |
Type: number Penalty for each extra kg of throughput exceeding. Default: |
|
unit |
Type: number Penalty for each extra custom unit of throughput exceeding ( Default: |
|
vehicle |
Type: number Penalty for each extra vehicle per hour of throughput exceeding. Default: |
DepotLocation_throughput_vehicle_count_0_item
|
Name |
Description |
|
time_window |
Type: string The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero. |
|
value |
Type: number Throughput, simultaneously vehicles. Min value: Max value: |
depots_penalty_early
Penalty components for early service (used instead of out_of_time penalty). More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a courier starts beeing served at the depot before the beginning of the time window. The penalty is applied for any early service, including opening the depot, unloading or uploading the courier at the depot or closing the depot. It is applied once for each visit of a depot during which the courier was served early. More information Default: |
|
minute |
Type: number Penalty for each minute of early service of the depot. Applied in the same cases as the Default: |
depots_penalty_late
Penalty components for late visits (used instead of out_of_time penalty). Whether the start or the end of service during the visit is used to penalize for lateness is determined by the penalize_late_service option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied for each visit of the depot after the end of the time window. Starting from a depot is counted for a visit. More information Default: |
|
minute |
Type: number Penalty for each minute of lateness for every visit of the depot after the end of the time window. More information Default: |
depots_penalty_out_of_time
Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the depot is visited outside of the time window. See the specifications of Default: |
|
minute |
Type: number Penalty for each minute of being outside of the time window of the depot. See the specifications of Default: |
depots_penalty_package_throughput
Penalty components for package throughput exceeding. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if throughput is exceeded. Default: |
|
kg |
Type: number Penalty for each extra kg of throughput exceeding. Default: |
|
unit |
Type: number Penalty for each extra custom unit of throughput exceeding ( Default: |
depots_penalty_throughput
Penalty components for throughput exceeding. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if throughput is exceeded. Default: |
|
kg |
Type: number Penalty for each extra kg of throughput exceeding. Default: |
|
unit |
Type: number Penalty for each extra custom unit of throughput exceeding ( Default: |
|
vehicle |
Type: number Penalty for each extra vehicle per hour of throughput exceeding. Default: |
throughput_vehicle_count_0_item
|
Name |
Description |
|
time_window |
Type: string The time window during which the specified restriction applies. The windows must not intersect with each other, and their union must contain the defined working hours of the corresponding depot. If the restriction is not defined on any time interval outside depot working hours, then it is considered equal to zero. More information |
|
value |
Type: number Throughput, simultaneously vehicles. More information Min value: Max value: |
InitialRouteNodeDepot
A representation of a depot in initial routes
|
Name |
Description |
|
value* |
Type: InitialRouteNodeValue A representation of a location in initial routes |
|
type |
Type: string Type of a route component. Enum: |
InitialRouteNodeLocation
A representation of a location in initial routes
|
Name |
Description |
|
value* |
Type: InitialRouteNodeValue A representation of a location in initial routes |
|
type |
Type: string Type of a route component. Enum: |
InitialRouteNodeWorkBreak
A representation of a work break in initial routes
|
Name |
Description |
|
value* |
Type: InitialRouteNodeWorkBreak_value A representation of a work break in initial routes |
|
type |
Type: string Type of a route component. Enum: |
InitialRouteNodeCourierPosition
A representation of a couerier position in initial routes
|
Name |
Description |
|
value* |
|
|
type |
Type: string Type of a route component. Enum: |
points_throughputs_penalty_throughput
Penalty components for throughput exceeding. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if throughput is exceeded. Default: |
|
kg |
Type: number Penalty for each extra kg of throughput exceeding. Default: |
|
unit |
Type: number Penalty for each extra custom unit of throughput exceeding ( Default: |
|
vehicle |
Type: number Penalty for each extra vehicle per hour of throughput exceeding. Default: |
_penalty
Penalties applied for violations of work break conditions.
|
Name |
Description |
|
early |
Type: penalty_early Penalty components for early work break. |
|
late |
Type: penalty_late Penalty components for late work break. |
shifts_penalty_early
Penalty components for shifts started too early (used instead of out_of_time penalty). If the shift was also finished too early, it is applied to the shift finish too. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the vehicle starts or finishes the shift before the start of the time window. Default: |
|
minute |
Type: number Penalty for each minute of earliness if the vehicle starts or finishes the shift before the start of the time window. Default: |
shifts_penalty_late
Penalty components for shifts finished too late (used instead of out_of_time penalty). This penalty is applied for being late to the end of the shift's time window or violating the max_duration_s bound. If both are violated simultaneously, the penalty is applied twice and summed. If the shift was started after the end of the time window, this penalty for the start time point is also added separately. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the vehicle starts or finishes the shift after the end of the time window or shift duration exceeds the Default: |
|
minute |
Type: number Penalty for each minute of lateness if the vehicle starts or finishes the shift after the end of the time window or if the vehicle spends more than Default: |
shifts_penalty_max_mileage
Penalties applied for violating shift's max_mileage_km limit. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a vehicle shift has mileage greater than Default: Min value: |
|
km |
Type: number Penalty applied per each extra kilometer when shift mileage is greater than Default: Min value: |
shifts_penalty_out_of_time
Penalty components for time window failure. Can be used to set the values of early and late options simultaneously, and each value is overridden if the respective option is also defined. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the vehicle starts or finishes the shift outside of the time window. See the specifications of Default: |
|
minute |
Type: number Penalty for each minute of being outside of the time window of the shift. See the specifications of Default: |
shifts_penalty_stop_excess
Penalties applied for violating shift's maximal_stops limit. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a vehicle shift has greater than Default: Min value: |
|
per_stop |
Type: number Penalty applied per each extra stop when shift stop count is greater than Default: Min value: |
shifts_penalty_stop_lack
Penalties applied for violating shift's minimal_stops limit. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a vehicle shift has less than Default: Min value: |
|
per_stop |
Type: number Penalty applied per each missing stop when shift stop count is less than Default: Min value: |
shifts_penalty_unique_stop_lack
Penalties applied for violating shift's minimal_stops limit. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a vehicle shift has less than Default: Min value: |
|
per_stop |
Type: number Penalty applied per each missing stop when shift stop count is less than Default: Min value: |
trailer_capacity_limits
Trailer load limits.
|
Name |
Description |
|
units_perc |
Type: number Upper limit of total shipments size in custom units as a percentage of a trailer capacity Default: Min value: |
|
volume_perc |
Type: number Upper limit of total shipments volume as a percentage of trailer volume. For container fitting purposes it is assumed that each dimension is multiplied by the cubic root of Default: Min value: |
|
weight_perc |
Type: number Upper limit of total shipments weight as a percentage of total weight the trailer is allowed to carry. Default: Min value: |
trailer_capacity_volume
Trailer dimensions.
|
Name |
Description |
|
depth_m* |
Type: number Depth, meters. Default: Min value: Max value: |
|
height_m* |
Type: number Height, meters. Default: Min value: Max value: |
|
width_m* |
Type: number Width, meters. Default: Min value: Max value: |
InitialRouteNodeValue
A representation of a location in initial routes
|
Name |
Description |
|
actual_total_service_duration_s |
Type: number Actual total duration of service at a location (according to actual_arrival_time_s and actual_departure_time_s). |
|
added_shared_service_duration_s |
Type: number Added duration of shared service, for first order in multi-order equals to shared_service_duration_sFor other orders in multi-order maybe non-zero,if shared_service_duration_s of current order is more than shared_service_duration_s of previous orders Default: Min value: Max value: |
|
anchor_mode |
Type: string Default: Enum: |
|
delivered_orders |
Type: (integer or string)[] List of IDs of orders delivered to the drop_off, depot or crossdock for delivery to the destination. |
|
delivery_deadline |
Type: string Time by which the |
|
fixed_position |
Type: boolean It is not allowed to move location or insert other locations before it Default: |
|
fixed_run |
Type: boolean Order can only be added in the run in which it was planned Default: |
|
fixed_shift |
Type: boolean Order can only be added in the shift in which it was planned Default: |
|
fixed_vehicle |
Type: boolean Order can only be taken by the vehicle in which it was planned Default: |
|
id |
Type: integer or string Reference to a location specified in |
|
keep_in_vehicle |
Type: boolean When order is dropped it still takes space in the vehicle Default: |
|
loaded_orders |
Type: (integer or string)[] Ids of |
|
parking_mode |
Type: string Default: Enum: |
|
parking_type |
Type: string Enum: |
|
picked_orders |
Type: (integer or string)[] A list of IDs of orders picked up in the crossdock or depot. |
|
pickup_id |
Type: integer or string ID of a pickup corresponding to this delivery. |
|
pickup_ids |
Type: (integer or string)[] List of IDs of pickups corresponding to this delivery. |
|
service_waiting_duration_s |
Type: number Duration of waiting for service at a location. It can be non-zero when, for example, an order is a part of a multi-order, in this case waiting duration includes duration of service of the other orders from the multi-order. Default: Min value: Max value: |
|
split_info |
Type: SplitInfo Information about split part of the order (in case if the order was split) |
|
total_service_duration_s |
Type: number Total duration of service at a location, it includes Default: Min value: Max value: |
|
trailer_decoupled |
Type: boolean Default: |
|
trailer_used |
Type: boolean Default: |
|
undroppable |
Type: boolean Location cannot be dropped Default: |
|
unfeasible_reasons |
Type: (UnfeasibleReasons_0 or UnfeasibleReasons_1 or UnfeasibleReasons_2 or UnfeasibleReasons_3 or UnfeasibleReasons_4 or UnfeasibleReasons_5 or UnfeasibleReasons_6 or UnfeasibleReasons_7 or UnfeasibleReasons_8 or object)[] The reason why the location is not feasible. |
|
zones |
Type: string[] List of zones. Min length: Max length: |
InitialRouteNodeWorkBreak_value
A representation of a work break in initial routes
|
Name |
Description |
|
after_last_location |
Type: boolean When true, work break will be put after the last location. If possible it will be merged with the first work break of type listed in Default: |
|
at_rest_place |
Type: boolean When true, the vehicle will break work only in a location with type "rest_place" Default: |
|
before_first_location |
Type: boolean When true, work break will be put before the first location. If possible it will be merged with the last work break of type listed in Default: |
|
chain_number |
Type: integer Sequential number of a work break chain to which the break belongs. |
|
continuous_travel_time_range |
Type: string Minimal and maximal duration of continuous travel time before rest, format: |
|
driving_time_range |
Type: string Minimal and maximal duration of driving before rest, format: |
|
exact_time_range |
Type: string The exact time range when the rest should start, format: |
|
fixed_position |
Type: boolean It is not allowed to move location or insert other locations before it Default: |
|
fixed_run |
Type: boolean Order can only be added in the run in which it was planned Default: |
|
fixed_shift |
Type: boolean Order can only be added in the shift in which it was planned Default: |
|
fixed_vehicle |
Type: boolean Order can only be taken by the vehicle in which it was planned Default: |
|
keep_in_vehicle |
Type: boolean When order is dropped it still takes space in the vehicle Default: |
|
merge_with_types |
Type: string[] Types of work breaks this work break can be merged with. This field can only be used with |
|
necessary_route_duration_s |
Type: number Minimal duration of route needed to make work break necessary, seconds. Min value: Max value: |
|
repeatable |
Type: boolean When true, this work break will be repeated until the end of route. Can only be true for the last break in the chain. Default: |
|
rest_duration_s |
Type: number Duration of rest, seconds. Min value: Max value: |
|
route_duration_s |
Type: number Minimal duration of route needed to use work break, seconds. Min value: Max value: |
|
travel_time_range |
Type: string Minimal and maximal duration of driving and waiting before rest, format: |
|
undroppable |
Type: boolean Location cannot be dropped Default: |
|
work_duration_s |
Type: number Duration of continuous work before the break, seconds. Min value: Max value: |
|
work_time_range_from_start |
Type: string Minimal and maximal duration of time from start of route until rest, format: |
|
work_time_range_till_rest |
Type: string Minimal and maximal duration of work before rest, format: |
InitialRouteNodeCourierPosition_value
|
Name |
Description |
|
location_id* |
Type: string Id of current location |
|
passed_time_s |
Type: number Time passed after courier leave current location. Consider that courier has not yet arrived to the next location. |
penalty_early
Penalty components for early work break.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a courier starts a work break while they worked for a less than the specified minimal work duration since the start of work or the previous work break ending.More information Default: |
|
minute |
Type: number Penalty for each minute of an early start of work break if a courier starts a work break while they worked for a less than the specified minimal work duration since the start of work or the previous work break ending.More information Default: |
penalty_late
Penalty components for late work break.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a worker starts a work break while they worked for a more than the specified maximal work duration since the start of work or the previous work break ending.More information Default: |
|
minute |
Type: number Penalty for each minute of a late start of work break if a worker starts a work break while they worked for a more than the specified maximal work duration since the start of work or the previous work break ending.More information Default: |
SplitInfo
Information about split part of the order (in case if the order was split)
|
Name |
Description |
|
order_ratio |
Type: number Order ratio, included in this part. |
|
part_id |
Type: integer Number of this part of the order. |
|
parts_count |
Type: integer Number of parts, in which the order was split. |
|
units |
Type: number Size of this part in custom units (in case there was corresponding quant specified for this order). |
|
volume_cbm |
Type: number Volume of this part, cubic meters (in case there was corresponding quant specified for this order). |
|
weight_kg |
Type: number Weight of this part, kilograms (in case there was corresponding quant specified for this order). |
UnfeasibleReasons_0
The reason why the location is not feasible.
|
Name |
Description |
|
overload* |
Type: number The overload value. The unit used depends on the overload type: * |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
|
custom_type |
Type: string Type of custom units that caused overload in case of OVERLOAD_CUSTOM. |
UnfeasibleReasons_1
The reason why the location is not feasible.
|
Name |
Description |
|
late_duration_s* |
Type: number The duration of late arrival, (arrival time) - (end of time window), seconds. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_2
The reason why the location is not feasible.
|
Name |
Description |
|
tags* |
Type: string[] List of missing required tags. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_3
The reason why the location is not feasible.
|
Name |
Description |
|
tags* |
Type: string[] List of present excluded tags. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_4
The reason why the location is not feasible.
|
Name |
Description |
|
overrun_s* |
Type: number The amount of time by which the hard transit time restriction was exceeded, in seconds |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_5
The reason why the location is not feasible.
|
Name |
Description |
|
incompatibilities* |
Type: UnfeasibleReasons_incompatibilities_item_1[] List of all incompatibile load type pairs |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_6
The reason why the location is not feasible.
|
Name |
Description |
|
incompatibilities* |
Type: UnfeasibleReasons_incompatibilities_item[] List of all incompatibile zone pairs |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_7
The reason why the location is not feasible.
|
Name |
Description |
|
tags* |
Type: string[] List of vehicle''s allowed zones. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_8
The reason why the location is not feasible.
|
Name |
Description |
|
tags* |
Type: string[] List of present forbidden zones. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons: * Enum: |
UnfeasibleReasons_incompatibilities_item_1
A list of all pairs of load types that are not compatible with an order.
|
Name |
Description |
|
incompatible_order_id* |
Type: integer or string Reference to a location specified in |
|
types* |
Type: incompatibilities_types_item[] |
UnfeasibleReasons_incompatibilities_item
A list of all pairs of zones that are not compatible with an order.
|
Name |
Description |
|
incompatible_order_id* |
Type: integer or string Reference to a location specified in |
|
zones* |
Type: incompatibilities_zones_item[] |
incompatibilities_types_item
|
Name |
Description |
|
other_type* |
Type: string Load type of the incompatible order. |
|
self_type* |
Type: string Load type of the current order. |
incompatibilities_zones_item
|
Name |
Description |
|
other_zone* |
Type: string Load type of the incompatible order. |
|
self_zone* |
Type: string Load type of the current order. |
Responses
202 Accepted
Task has been queued for execution.
Body
application/json
{
"id": "string",
"message": "string",
"status": {
"queued": 0,
"started": 0,
"completed": 0,
"cancelled": 0,
"estimate": 0
}
}
|
Name |
Description |
|
id* |
Type: string Task unique id. |
|
status* |
Type: TaskInfoResponse_status Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits:
|
|
message |
Type: string Human-readable description of task state. |
TaskInfoResponse_status
Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status.
Possible status transits:
queued -> started -> (completed or cancelled)
|
Name |
Description |
|
queued* |
Type: number Task has been queued for execution. |
|
cancelled |
Type: number Task execution has been cancelled by system due to timeout or error. |
|
completed |
Type: number Task execution completed with result or error. |
|
estimate |
Type: number Estimated time when task expected to be completed. The time estimation may change during solving process. The estimate is valid for approximately 75% of tasks (they may be ready 5-15 seconds before "estimate")Some tasks may require more time for calculation, typically this extra time is not more than 1 minute. |
|
started |
Type: number Task execution has been started. |
400 Bad Request
Invalid JSON in POST request body.
Body
application/json
{
"error": {
"message": "string",
"incident_id": "string"
}
}
|
Name |
Description |
|
error* |
Type: ErrorTaskAdd_error Error description. |
ErrorTaskAdd_error
Error description.
|
Name |
Description |
|
message* |
Type: string Human-readable error description. |
|
incident_id |
Type: string Unique identifier of error incident. In case of API error, this identifier can be provided to support for investigation. |
Body
text/html
{}
403 Forbidden
You do not have permission to add MVRP tasks.
500 Internal Server Error
Server error during request processing.
Body
application/json
{
"error": {
"message": "string",
"incident_id": "string"
}
}
|
Name |
Description |
|
error* |
Type: ErrorTaskAdd_error Error description. |
Body
text/html
{}
503 Service Unavailable
Not enough resources available to run the task.
Body
application/json
{
"error": {
"message": "string",
"incident_id": "string"
}
}
|
Name |
Description |
|
error* |
Type: ErrorTaskAdd_error Error description. |
Body
text/html
{}
No longer supported, please use an alternative and newer version.