- Request
- Responses
- 200 OK
- Body
- dropped_locations
- employee
- solution_metrics
- solver_options
- routes
- solver_status
- detailed_cost
- calendar_planning_mvrp_response_zones_item
- coordinate_1
- dropped_locations_cost
- dropped_locations_optional_tags_item
- dropped_locations_penalty
- dropped_locations_shipment_size
- dropped_locations_time_windows_item
- dropped_locations_visit
- dropped_locations_visits_item
- employee_capacity
- employee_cost_0
- employee_cost_1
- employee_optional_zones_item
- employee_payout_0
- employee_public_transport_cost
- employee_working_days_item
- solver_options_penalty
- route_metrics
- route_element
- routes_global_proximity_attraction_point
- detailed_cost_raw_metrics_item
- detailed_cost_subcosts_item
- calendar_planning_mvrp_response_zones_geometry
- dropped_locations_cost_additional_visitors
- penalty_drop_0_2
- dropped_locations_penalty_early
- dropped_locations_penalty_late
- dropped_locations_penalty_max_days_between_visits
- dropped_locations_penalty_max_distinct_visitors
- dropped_locations_penalty_min_days_between_visits
- dropped_locations_penalty_out_of_time
- dropped_locations_penalty_preferred_days
- dropped_locations_penalty_visit_count
- working_days_start_time_0_item
- employee_working_days_penalty
- solver_options_penalty_multiorders
- route_element_node
- route_element_failed_time_window
- route_element_overtime
- route_element_probably_failed_time_window
- routes_global_proximity_attraction_point_cost
- routes_global_proximity_attraction_point_optional_tags_item
- routes_global_proximity_attraction_point_penalty
- routes_global_proximity_attraction_point_shipment_size
- routes_global_proximity_attraction_point_time_windows_item
- routes_global_proximity_attraction_point_visits_item
- detailed_cost_raw_metrics_raw_metrics_item
- detailed_cost_raw_metrics_subcosts_item
- detailed_cost_subcosts_raw_metrics_item
- detailed_cost_subcosts_subcosts_item
- working_days_penalty_early
- working_days_penalty_late
- working_days_penalty_max_mileage
- working_days_penalty_out_of_time
- working_days_penalty_stop_excess
- working_days_penalty_stop_lack
- route_location
- route_element_node_used_projection
- global_proximity_attraction_point_cost_additional_visitors
- global_proximity_attraction_point_penalty_drop_0
- global_proximity_attraction_point_penalty_early
- global_proximity_attraction_point_penalty_late
- global_proximity_attraction_point_penalty_max_days_between_visits
- global_proximity_attraction_point_penalty_max_distinct_visitors
- global_proximity_attraction_point_penalty_min_days_between_visits
- global_proximity_attraction_point_penalty_out_of_time
- global_proximity_attraction_point_penalty_preferred_days
- global_proximity_attraction_point_penalty_visit_count
- raw_metrics_raw_metrics_item_14
- raw_metrics_subcosts_item_12
- subcosts_raw_metrics_item_11
- subcosts_subcosts_item_10
- raw_metrics_raw_metrics_item_7
- raw_metrics_subcosts_item_5
- subcosts_raw_metrics_item_4
- subcosts_subcosts_item_3
- route_location_cost
- route_location_optional_tags_item
- route_location_penalty
- route_location_shipment_size
- route_location_time_windows_item
- route_location_unfeasible_reasons_0
- route_location_unfeasible_reasons_1
- route_location_unfeasible_reasons_2
- route_location_unfeasible_reasons_3
- route_location_unfeasible_reasons_4
- route_location_unfeasible_reasons_5
- route_location_unfeasible_reasons_6
- route_location_unfeasible_reasons_7
- route_location_unfeasible_reasons_8
- route_location_unfeasible_reasons_9
- route_location_visit
- route_location_visits_item
- raw_metrics_raw_metrics_item_13
- raw_metrics_subcosts_item_13
- subcosts_raw_metrics_item_13
- subcosts_subcosts_item_13
- raw_metrics_raw_metrics_item_10
- raw_metrics_subcosts_item_9
- subcosts_raw_metrics_item_9
- subcosts_subcosts_item_9
- raw_metrics_raw_metrics_item_6
- raw_metrics_subcosts_item_6
- subcosts_raw_metrics_item_6
- subcosts_subcosts_item_6
- raw_metrics_raw_metrics_item_3
- raw_metrics_subcosts_item_2
- subcosts_raw_metrics_item_2
- subcosts_subcosts_item_2
- route_location_cost_additional_visitors
- route_location_penalty_drop_0
- route_location_penalty_early
- route_location_penalty_late
- route_location_penalty_max_days_between_visits
- route_location_penalty_max_distinct_visitors
- route_location_penalty_min_days_between_visits
- route_location_penalty_out_of_time
- route_location_penalty_preferred_days
- route_location_penalty_visit_count
- unfeasible_reasons_incompatibilities_item_1
- unfeasible_reasons_incompatibilities_item
- raw_metrics_raw_metrics_item_12
- raw_metrics_subcosts_item_14
- subcosts_raw_metrics_item_14
- subcosts_subcosts_item_14
- raw_metrics_raw_metrics_item_11
- raw_metrics_subcosts_item_11
- subcosts_raw_metrics_item_12
- subcosts_subcosts_item_12
- raw_metrics_raw_metrics_item_9
- raw_metrics_subcosts_item_10
- subcosts_raw_metrics_item_10
- subcosts_subcosts_item_11
- raw_metrics_raw_metrics_item_8
- raw_metrics_subcosts_item_8
- subcosts_raw_metrics_item_8
- subcosts_subcosts_item_8
- raw_metrics_raw_metrics_item_5
- raw_metrics_subcosts_item_7
- subcosts_raw_metrics_item_7
- subcosts_subcosts_item_7
- raw_metrics_raw_metrics_item_4
- raw_metrics_subcosts_item_4
- subcosts_raw_metrics_item_5
- subcosts_subcosts_item_5
- raw_metrics_raw_metrics_item_2
- raw_metrics_subcosts_item_3
- subcosts_raw_metrics_item_3
- subcosts_subcosts_item_4
- raw_metrics_raw_metrics_item_1
- raw_metrics_subcosts_item_1
- subcosts_raw_metrics_item_1
- subcosts_subcosts_item_1
- incompatibilities_types_item
- incompatibilities_zones_item
- raw_metrics_raw_metrics_item
- raw_metrics_subcosts_item
- subcosts_raw_metrics_item
- subcosts_subcosts_item
- 400 Bad Request
- 401 Unauthorized
- 402 Payment Required
- 404 Not Found
- 500 Internal Server Error
Get task result
Get calendar planning task result.
Request
GET
https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks/{id}/result
Path parameters
|
Name |
Description |
|
id* |
Type: string<byte> Task ID to query status or result. |
Query parameters
|
Name |
Description |
|
apikey* |
Type: string API key. |
|
lang |
Type: string Response locale in RFC-3066 format. Default: |
Responses
200 OK
Task result recieved.
Body
application/json
{
"detailed_cost_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"subcosts": [
{
"name": "string",
"raw_metrics": [
{
"name": "string",
"value": 0
}
],
"subcosts": [
{
"name": "string",
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"value": 0
}
],
"dropped_locations": [
{
"address": "string",
"allowed_days": [
0,
"string"
],
"comments": "string",
"custom_value": 0,
"denied_days": [
0,
"string"
],
"description": "string",
"drop_reason": "string",
"hard_time_window": "string",
"hard_window": false,
"id": 0,
"last_visit_date": "string",
"load_types": [
"string"
],
"mandatory_days": [
0,
"string"
],
"max_days_between_visits": 0,
"max_distinct_visitors": 1,
"max_total_employees": 0,
"min_days_between_visits": 1,
"optional_tags": [
{
"tag": "string",
"value": 0
}
],
"phone": "string",
"point": {
"lat": 0,
"lon": 0
},
"preferred_days": [
0,
"string"
],
"priority": 0,
"ref": "string",
"required_tags": [
"string"
],
"service_duration_s": 0,
"shared_with_company_ids": [
0
],
"time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
],
"title": "string",
"type": "check-in",
"use_in_proximity": true,
"visit_count": 1,
"visit_index": 0,
"visits": [
{
"allowed_days": [
0,
"string"
],
"denied_days": [
0,
"string"
],
"drop": 0,
"preferred_days": [
0,
"string"
],
"service_duration_s": 0,
"title": "string"
}
],
"visit": {
"allowed_days": [
0,
"string"
],
"denied_days": [
0,
"string"
],
"drop": 0,
"preferred_days": [
0,
"string"
],
"service_duration_s": 0,
"title": "string"
},
"shipment_size": {
"units": 0
},
"penalty": {
"drop": 1000000,
"visit_count": {
"fixed": 1000000,
"per_visit": 1000000
},
"preferred_days": {
"fixed": 0,
"per_day": 0
},
"out_of_time": {
"fixed": 1000,
"minute": 17
},
"min_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"max_distinct_visitors": {
"fixed": 0,
"per_visitor": 0
},
"max_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
}
},
"cost": {
"additional_visitors": {
"fixed": 0,
"per_visitor": 0
}
}
}
],
"employees": [
{
"allowed_zones": [
"string"
],
"between_days_max_edge_distance_m": 0,
"between_days_max_edge_duration_s": 0,
"can_add_walking_edges": false,
"cost": {
"empty": 0,
"empty_run": 0,
"fixed": 3000,
"hour": 300,
"km": 50,
"location": 0,
"run": 0,
"waiting_hour": 0
},
"daily_proximity_factor": 0,
"distance_between_days_ends_factor": 0,
"distance_between_days_starts_factor": 0,
"duration_between_days_ends_factor": 0,
"duration_between_days_starts_factor": 0,
"excluded_tags": [
"string"
],
"finish_at": 0,
"first_edges_penalty_factor": 0,
"forbidden_zones": [
"string"
],
"global_proximity_attraction_point": 0,
"global_proximity_factor": 0,
"id": 0,
"imei": 0,
"incompatible_load_types": [
[
"string"
]
],
"incompatible_zones": [
[
"string"
]
],
"last_edges_penalty_factor": 0,
"max_edge_distance_m": 0,
"max_edge_duration_s": 0,
"max_public_transport_edge_duration_s": 0,
"max_runs": 1,
"optional_zones": [
{
"value": 0,
"zone": "string"
}
],
"payout": "string",
"phone": "string",
"ref": "string",
"routing_mode": "driving",
"service_duration_multiplier": 1,
"start_at": 0,
"tags": [
"string"
],
"travel_time_multiplier": 1,
"use_walking_proximity": false,
"vacations": [
0,
"string"
],
"working_days": [
{
"cost": 0,
"day": [
0,
"string"
],
"fixed": false,
"hard_max_duration_s": 2592000,
"hard_max_finish_time": "string",
"hard_window": false,
"id": "string",
"max_duration_s": 172800,
"max_finish_time": "string",
"max_mileage_km": 0,
"maximal_stops": 0,
"min_duration_s": 0,
"minimal_stops": 0,
"start_time": "string",
"penalty": {
"stop_lack": {
"fixed": 0,
"per_stop": 0
},
"stop_excess": {
"fixed": 0,
"per_stop": 10000
},
"out_of_time": {
"fixed": 1000,
"minute": 17
},
"max_mileage": {
"fixed": 1000,
"km": 100
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
}
}
}
],
"public_transport_cost": {
"edge": 0,
"hour": 0,
"km": 0,
"run": 0
},
"penalty": {},
"capacity": {
"units": 0
}
}
],
"metrics": {
"accomplished_visits": 0,
"additional_visitors_cost": 0,
"affecting_utilization": 0,
"assigned_location_count": 0,
"available_man_days": 0,
"completely_assigned_location_count": 0,
"completely_unassigned_location_count": 0,
"daily_proximity": 0,
"early_location_count": 0,
"failed_time_window_location_count": 0,
"general_utilization": 0,
"global_proximity": 0,
"late_location_count": 0,
"lateness_risk_location_count": 0,
"max_employee_runs": 0,
"objective_minimum": 0,
"operations_per_second": 0,
"optimization_steps": 0,
"overtime_duration_penalty": 0,
"overtime_duration_s": 0,
"overtime_penalty": 0,
"overtime_runs_count": 0,
"overtime_runs_count_penalty": 0,
"partially_assigned_location_count": 0,
"regular_time_runs_count": 0,
"regular_time_runs_duration_s": 0,
"route_custom_cost": 0,
"route_payout": 0,
"run_custom_cost": 0,
"run_payout": 0,
"total_cost": 0,
"total_cost_with_penalty": 0,
"total_custom_cost": 0,
"total_daily_proximity_distance_m": 0,
"total_daily_proximity_duration_s": 0,
"total_daily_proximity_penalty": 0,
"total_drop_penalty": 0,
"total_duration_cost": 0,
"total_duration_s": 0,
"total_early_count": 0,
"total_early_duration_s": 0,
"total_early_penalty": 0,
"total_employee_locations_cost": 0,
"total_failed_time_window_count": 0,
"total_failed_time_window_duration_s": 0,
"total_failed_time_window_penalty": 0,
"total_fixed_cost": 0,
"total_global_proximity_distance_m": 0,
"total_global_proximity_duration_s": 0,
"total_global_proximity_penalty": 0,
"total_guaranteed_penalty": 0,
"total_late_count": 0,
"total_late_duration_s": 0,
"total_late_penalty": 0,
"total_lateness_risk_probability": 0,
"total_locations_cost": 0,
"total_mileage_penalty": 0,
"total_multiorders_penalty": 0,
"total_optional_tags_cost": 0,
"total_optional_zones_cost": 0,
"total_payout": 0,
"total_penalty": 0,
"total_probable_penalty": 0,
"total_public_transport_distance_cost": 0,
"total_public_transport_distance_m": 0,
"total_public_transport_duration_cost": 0,
"total_public_transport_duration_s": 0,
"total_public_transport_edges_cost": 0,
"total_public_transport_runs_cost": 0,
"total_runs_cost": 0,
"total_service_duration_s": 0,
"total_stop_count_penalty": 0,
"total_transit_distance_cost": 0,
"total_transit_distance_m": 0,
"total_transit_duration_s": 0,
"total_unfeasibility_count": 0,
"total_unfeasibility_penalty": 0,
"total_units": 0,
"total_unpaid_distance_m": 0,
"total_unpaid_duration_s": 0,
"total_waiting_duration_s": 0,
"unassigned_location_count": 0,
"undertime_duration_penalty": 0,
"undertime_duration_s": 0,
"undertime_penalty": 0,
"undertime_runs_count": 0,
"undertime_runs_count_penalty": 0,
"unfullfilled_visits": 0,
"used_employees": 0,
"used_man_days": 0
},
"options": {
"allow_multiple_visitors": false,
"avoid_tolls": false,
"avoid_zones": [
"string"
],
"critical_lateness_risk_probability": 20,
"daily_proximity_factor": 0,
"date": "string",
"distance_between_days_ends_factor": 0,
"distance_between_days_starts_factor": 0,
"duration_between_days_ends_factor": 0,
"duration_between_days_starts_factor": 0,
"fixed": false,
"fixed_drops": false,
"global_proximity_factor": 0,
"incompatible_load_types": [
[
"string"
]
],
"incompatible_zones": [
[
"string"
]
],
"late_days_cost_increment": 0,
"minimize_lateness_risk": false,
"non_working_days": [
0,
"string"
],
"penalize_late_service": true,
"planning_days": 0,
"post_optimization": false,
"quality": "low",
"restart_on_drop": false,
"routing_mode": "driving",
"time_zone": 0,
"working_days": [
0,
"string"
],
"working_days_in_week": 5,
"penalty": {
"multiorders": {
"per_extra_employee": 0,
"per_extra_point": 0,
"per_extra_visit": 0
}
}
},
"routes": [
{
"day": 0,
"employee_id": 0,
"metrics": {
"accomplished_visits": 0,
"affecting_utilization": 0,
"daily_proximity": 0,
"early_location_count": 0,
"failed_time_window_location_count": 0,
"general_utilization": 0,
"late_location_count": 0,
"overtime_duration_penalty": 0,
"overtime_duration_s": 0,
"overtime_penalty": 0,
"overtime_runs_count": 0,
"overtime_runs_count_penalty": 0,
"regular_time_runs_count": 0,
"regular_time_runs_duration_s": 0,
"route_custom_cost": 0,
"route_payout": 0,
"run_custom_cost": 0,
"run_payout": 0,
"total_cost": 0,
"total_cost_with_penalty": 0,
"total_custom_cost": 0,
"total_daily_proximity_distance_m": 0,
"total_daily_proximity_duration_s": 0,
"total_daily_proximity_penalty": 0,
"total_duration_cost": 0,
"total_duration_s": 0,
"total_early_count": 0,
"total_early_duration_s": 0,
"total_early_penalty": 0,
"total_employee_locations_cost": 0,
"total_failed_time_window_count": 0,
"total_failed_time_window_duration_s": 0,
"total_failed_time_window_penalty": 0,
"total_fixed_cost": 0,
"total_guaranteed_penalty": 0,
"total_late_count": 0,
"total_late_duration_s": 0,
"total_late_penalty": 0,
"total_mileage_penalty": 0,
"total_multiorders_penalty": 0,
"total_optional_tags_cost": 0,
"total_optional_zones_cost": 0,
"total_payout": 0,
"total_penalty": 0,
"total_public_transport_distance_cost": 0,
"total_public_transport_distance_m": 0,
"total_public_transport_duration_cost": 0,
"total_public_transport_duration_s": 0,
"total_public_transport_edges_cost": 0,
"total_public_transport_runs_cost": 0,
"total_runs_cost": 0,
"total_service_duration_s": 0,
"total_stop_count_penalty": 0,
"total_transit_distance_cost": 0,
"total_transit_distance_m": 0,
"total_transit_duration_s": 0,
"total_unfeasibility_penalty": 0,
"total_units": 0,
"total_waiting_duration_s": 0,
"undertime_duration_penalty": 0,
"undertime_duration_s": 0,
"undertime_penalty": 0,
"undertime_runs_count": 0,
"undertime_runs_count_penalty": 0
},
"route": [
{
"actual_arrival_time_s": 0,
"actual_departure_time_s": 0,
"actual_service_start_time_s": 0,
"actual_waiting_duration_s": 0,
"arrival_time_s": 0,
"departure_time_s": 0,
"multi_order": false,
"stop_sequence_number": 0,
"transit_distance_m": 0,
"transit_duration_s": 0,
"waiting_duration_s": 0,
"probably_failed_time_window": {
"duration_s": 0,
"high_risk": false,
"how": "EARLY",
"probability": 0
},
"overtime": {
"duration_s": 0
},
"node": {
"type": "location",
"used_hard_time_window": "string",
"used_time_window": "string",
"value": {
"added_shared_service_duration_s": 0,
"address": "string",
"allowed_days": [
0,
"string"
],
"comments": "string",
"custom_value": 0,
"denied_days": [
0,
"string"
],
"description": "string",
"drop_reason": "string",
"hard_time_window": "string",
"hard_window": false,
"id": 0,
"is_visited_by_deputy": false,
"last_visit_date": "string",
"load_types": [
"string"
],
"mandatory_days": [
0,
"string"
],
"max_days_between_visits": 0,
"max_distinct_visitors": 1,
"max_total_employees": 0,
"min_days_between_visits": 1,
"optional_tags": [
{
"tag": "string",
"value": 0
}
],
"phone": "string",
"point": {
"lat": 0,
"lon": 0
},
"preferred_days": [
0,
"string"
],
"priority": 0,
"ref": "string",
"required_tags": [
"string"
],
"routing_mode": "driving",
"service_duration_s": 0,
"service_waiting_duration_s": 0,
"shared_with_company_ids": [
0
],
"time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
],
"title": "string",
"total_service_duration_s": 0,
"type": "check-in",
"unfeasible_reasons": [
{
"custom_type": "string",
"overload": 0,
"text": "string",
"type": "OVERLOAD_SIZE"
},
{
"late_duration_s": 0,
"text": "string",
"type": "FAILED_HARD_TIME_WINDOW"
},
{
"tags": [
"string"
],
"text": "string",
"type": "REQUIRED_TAGS_VIOLATION"
},
{
"tags": [
"string"
],
"text": "string",
"type": "EXCLUDED_TAGS_VIOLATION"
},
{
"overrun_s": 0,
"text": "string",
"type": "TRANSIT_TIME_VIOLATION"
},
{
"incompatibilities": [
{
"incompatible_order_id": 0,
"types": [
{
"other_type": "string",
"self_type": "string"
}
]
}
],
"text": "string",
"type": "INCOMPATIBLE_LOAD_TYPES_VIOLATION"
},
{
"incompatibilities": [
{
"incompatible_order_id": 0,
"zones": [
{
"other_zone": "string",
"self_zone": "string"
}
]
}
],
"text": "string",
"type": "INCOMPATIBLE_ZONES_VIOLATION"
},
{
"tags": [
"string"
],
"text": "string",
"type": "ALLOWED_ZONES_VIOLATION"
},
{
"tags": [
"string"
],
"text": "string",
"type": "FORBIDDEN_ZONES_VIOLATION"
},
{
"text": "string",
"type": "OTHER"
}
],
"use_in_proximity": true,
"visit_count": 1,
"visit_index": 0,
"visits": [
{
"allowed_days": [
0,
"string"
],
"denied_days": [
0,
"string"
],
"drop": 0,
"preferred_days": [
0,
"string"
],
"service_duration_s": 0,
"title": "string"
}
],
"visit": {
"allowed_days": [
0,
"string"
],
"denied_days": [
0,
"string"
],
"drop": 0,
"preferred_days": [
0,
"string"
],
"service_duration_s": 0,
"title": "string"
},
"shipment_size": {
"units": 0
},
"penalty": {
"drop": 1000000,
"visit_count": {
"fixed": 1000000,
"per_visit": 1000000
},
"preferred_days": {
"fixed": 0,
"per_day": 0
},
"out_of_time": {
"fixed": 1000,
"minute": 17
},
"min_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"max_distinct_visitors": {
"fixed": 0,
"per_visitor": 0
},
"max_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
}
},
"cost": {
"additional_visitors": {
"fixed": 0,
"per_visitor": 0
}
}
},
"used_projection": {
"lat": 0,
"lon": 0
}
},
"failed_time_window": {
"duration_s": 0,
"how": "EARLY"
}
}
],
"run_number": 0,
"global_proximity_attraction_point": {
"address": "string",
"allowed_days": [
0,
"string"
],
"comments": "string",
"custom_value": 0,
"denied_days": [
0,
"string"
],
"description": "string",
"hard_time_window": "string",
"hard_window": false,
"id": 0,
"last_visit_date": "string",
"load_types": [
"string"
],
"mandatory_days": [
0,
"string"
],
"max_days_between_visits": 0,
"max_distinct_visitors": 1,
"max_total_employees": 0,
"min_days_between_visits": 1,
"optional_tags": [
{
"tag": "string",
"value": 0
}
],
"phone": "string",
"point": {
"lat": 0,
"lon": 0
},
"preferred_days": [
0,
"string"
],
"priority": 0,
"ref": "string",
"required_tags": [
"string"
],
"service_duration_s": 0,
"shared_with_company_ids": [
0
],
"time_window": "string",
"time_windows": [
{
"hard_time_window": "string",
"time_window": "string"
}
],
"title": "string",
"type": "check-in",
"use_in_proximity": true,
"visit_count": 1,
"visits": [
{
"allowed_days": [
0,
"string"
],
"denied_days": [
0,
"string"
],
"drop": 0,
"preferred_days": [
0,
"string"
],
"service_duration_s": 0,
"title": "string"
}
],
"shipment_size": {
"units": 0
},
"penalty": {
"drop": 1000000,
"visit_count": {
"fixed": 1000000,
"per_visit": 1000000
},
"preferred_days": {
"fixed": 0,
"per_day": 0
},
"out_of_time": {
"fixed": 1000,
"minute": 17
},
"min_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"max_distinct_visitors": {
"fixed": 0,
"per_visitor": 0
},
"max_days_between_visits": {
"fixed": 0,
"per_day": 10000
},
"late": {
"fixed": 1000,
"minute": 17
},
"early": {
"fixed": 1000,
"minute": 17
}
},
"cost": {
"additional_visitors": {
"fixed": 0,
"per_visitor": 0
}
}
}
}
],
"solver_status": "SOLVED",
"zones": [
{
"id": "string",
"geometry": {
"coordinates": [
[
[
0
]
]
],
"type": "string"
}
}
]
}
|
Name |
Description |
|
dropped_locations* |
Type: dropped_locations[] List of locations excluded (dropped) from route due to employee shortage or another constraint violation. |
|
employees* |
Type: employee[] List of employees, available for route planning. Min items: |
|
metrics* |
Type: solution_metrics Metrics for a solution. |
|
options* |
Type: solver_options Solver options. It is forbidden to specify options that are not present in the list below. |
|
routes* |
Type: routes[] List of routes and individual metrics for each route. |
|
solver_status* |
Type: solver_status Status of routing solver:
Enum: |
|
detailed_cost_metrics |
Type: detailed_cost[] The value of an arbitrary cost. |
|
zones |
dropped_locations
Location of order to deliver from depot.
|
Name |
Description |
|
drop_reason* |
Type: string Explanation why the location was dropped. |
|
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 |
|
point* |
Type: coordinate_1 WGS84 coordinate of a location. More information |
|
visit_index* |
Type: integer |
|
address |
Type: string Address of the location. More information |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
comments |
Type: string Comments. More information |
|
cost |
Type: dropped_locations_cost Location cost. More information |
|
custom_value |
Type: number A custom numeric value, associated with location (E.g. the reward for the employee for visiting this location). May be used as a component in employee cost function. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
description |
Type: string Location description. More information |
|
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: |
|
last_visit_date |
Type: string The date of the last location visit before the start of planning period. More information |
|
load_types |
Type: string[] Defines compatibility with other locations in the route.
mustn |
|
mandatory_days |
Type: (integer or string)[] The list of days mandatory to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
max_days_between_visits |
Type: integer Maximal interval (in days) between two location visits. More information Min value: |
|
max_distinct_visitors |
Type: integer Maximal number of different employees visiting location. More information Default: Min value: |
|
max_total_employees |
Type: integer Maximal number of employees that can be served by an anchor location. Unlimited by default. |
|
min_days_between_visits |
Type: integer Minimal interval (in days) between two location visits. More information Default: Min value: |
|
optional_tags |
Type: dropped_locations_optional_tags_item[] A list of tags that an employee does not need to have to visit the location. These tags can reduce or increase the route cost. More information |
|
penalty |
Type: dropped_locations_penalty Penalties for missing visits and violating location visit windows. More information |
|
phone |
Type: string Phone number of check-in receiver. More information |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
priority |
Type: integer Location visit priority, the lower is this value, the higher is priority. Locations with higher |
|
ref |
Type: string Additional location ref. More information |
|
required_tags |
Type: string[] List of tags a employee must have to arrive at the location. More information |
|
service_duration_s |
Type: number The locations handling time. Handling time may include any operations at the location, such as loading or unloading or any other time/activity associated with the location (except waiting time, which is calculated as the difference between the employees arrival at the location and the start of handling time). More information Default: Min value: Max value: |
|
shared_with_company_ids |
Type: integer[] IDs of the companies that can access the order information.More information Min value: |
|
shipment_size |
Type: dropped_locations_shipment_size Shipment size (dimensions and/or weight). |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: dropped_locations_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
title |
Type: string Location title. More information |
|
type |
Type: string Defines the type of location:
Default: Enum: |
|
use_in_proximity |
Type: boolean When Default: |
|
visit |
Type: dropped_locations_visit The properties of a specific type of location visits. |
|
visit_count |
Type: integer Required number of visits for a location in planning period. More information Default: Min value: |
|
visits |
Type: dropped_locations_visits_item[] Descriptions of individual location visits.More information |
employee
Employees specification.
|
Name |
Description |
|
id* |
Type: integer or string Employees ID. All employee IDs in task must be unique and have the same type: integer or string. More information |
|
allowed_zones |
Type: string[] List of zones, which can be visited by employee. More information |
|
between_days_max_edge_distance_m |
Type: number Maximal transit distance (in meters) between the first/last locations of neighboring days. More information Min value: |
|
between_days_max_edge_duration_s |
Type: number Maximal transit duration (in seconds) between the first/last locations of neighboring days. More information Min value: |
|
can_add_walking_edges |
Type: boolean Employee with Default: |
|
capacity |
Type: employee_capacity Employee capacity |
|
cost |
Type: employee_cost_0 or string or employee_cost_1 |
|
daily_proximity_factor |
Type: number Level of location proximity influence on employee routes during the day. Recommended values are from Default: Min value: Max value: |
|
distance_between_days_ends_factor |
Type: number Coefficient with which the cost for transit distances between run ending locations on consecutive days is added to the route cost.More information Default: Min value: |
|
distance_between_days_starts_factor |
Type: number Coefficient with which the cost for transit distances between run starting locations on consecutive days is added to the route costMore information Default: Min value: |
|
duration_between_days_ends_factor |
Type: number Coefficient with which the cost for transit durations between run ending locations on consecutive days is added to the route cost.More information Default: Min value: |
|
duration_between_days_starts_factor |
Type: number Coefficient with which the cost for transit durations between run starting locations on consecutive days is added to the route cost.More information Default: Min value: |
|
excluded_tags |
Type: string[] List of excluding employee tags, checked for compatibility with location tags (POSIX-extended regular expression are used). More information |
|
finish_at |
Type: integer or string Defines |
|
first_edges_penalty_factor |
Type: number A factor that determines extra penalty/bonus for the first edge of each run.More information Default: |
|
forbidden_zones |
Type: string[] List of zones, which can not be visited by employee. More information |
|
global_proximity_attraction_point |
Type: integer or string Defines |
|
global_proximity_factor |
Type: number Level of location proximity influence on employee routes during the planning period. Recommended values are from Default: Min value: Max value: |
|
imei |
Type: integer The IMEI number of the GPS tracker. More information |
|
incompatible_load_types |
Type: string[][] Each item in this array defines list of location load types, that should not be handled within the same employee run (overrides |
|
incompatible_zones |
Type: string[][] Each item in this array defines list of location zones, that should not be visited within the same employee run. (overrides |
|
last_edges_penalty_factor |
Type: number A factor that determines extra penalty/bonus for the last edge of each run.More information Default: |
|
max_edge_distance_m |
Type: number Maximal transit distance (in meters) between two consequtive locations in employee route.More information Min value: |
|
max_edge_duration_s |
Type: number Maximal transit duration (in seconds) between two consecutive locations in employee routeMore information Min value: |
|
max_public_transport_edge_duration_s |
Type: number Maximal transit duration (in seconds) between two consecutive locations in employee route using public transport.More information Min value: |
|
max_runs |
Type: integer Maximal number of the employee routes per day. More information Default: |
|
optional_zones |
Type: employee_optional_zones_item[] Array of optional zones with bonus or penalty.More information |
|
payout |
Type: string or employee_payout_0 |
|
penalty |
Type: object Penalties for employee limitations violation. |
|
phone |
Type: string Phone number of the employee. More information |
|
public_transport_cost |
Type: employee_public_transport_cost Cost for public transport use. More information |
|
ref |
Type: string Additional number of the employee. More information |
|
routing_mode |
Type: string Mode of routing. If present, overrides
Enum: |
|
service_duration_multiplier |
Type: number Coefficient for the adjustment of handling time for more or less qualified employees. More information Default: Min value: |
|
start_at |
Type: integer or string Defines |
|
tags |
Type: string[] List of employee tags, checked for compatibility with location tags (POSIX-extended regular expression are used). More information |
|
travel_time_multiplier |
Type: number Coefficient for the adjustment of handling time for more or less qualified employees. More information Default: Min value: |
|
use_walking_proximity |
Type: boolean Use walking cost matrix when computing proximity penalty for the vehicles routes Default: |
|
vacations |
Type: (integer or string)[] The list of vacation days during the planning period. Incompatible with the working_days_in_week option. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
working_days |
Type: employee_working_days_item[] The list of working days parameters. More information |
solution_metrics
Metrics for a solution.
|
Name |
Description |
|
accomplished_visits* |
Type: integer Total number of location visits, made by all employees. |
|
affecting_utilization* |
Type: number Ratio of total employees working time, including travel time, spent on location visits, according to their service_duration_s. |
|
daily_proximity* |
Type: number Proximity level of daily runs: average possible distance from the last location in day run, to other locations visited on the same day, kilometers. |
|
early_location_count* |
Type: integer Number of locations where arrival will happen earlier than the picked time window. |
|
failed_time_window_location_count* |
Type: integer Number of locations where arrival will happen outside of the time window. |
|
general_utilization* |
Type: number Ratio of total employees working shifts length to their total, working time, including travel time. |
|
late_location_count* |
Type: integer Number of locations where arrival will happen later than the picked time window. |
|
optimization_steps* |
Type: integer Number of solver optimization steps. |
|
overtime_duration_penalty* |
Type: number Sum of per minute penalties applied for violating of maximal shift duration. |
|
overtime_duration_s* |
Type: number Total shift overtime duration in seconds. |
|
overtime_penalty* |
Type: number Sum of penalties applied for violating of maximal shift duration. |
|
overtime_runs_count* |
Type: integer Number of shifts where duration is more than |
|
overtime_runs_count_penalty* |
Type: number Sum of fixed penalties applied for violating of maximal shift duration. |
|
regular_time_runs_count* |
Type: integer Number of routes, not violating working day duration limits. |
|
regular_time_runs_duration_s* |
Type: number Total duration of the routes, not violating working day duration limits, in seconds. |
|
total_cost* |
Type: number Total of all expenses. |
|
total_cost_with_penalty* |
Type: number Total expectation of all expenses including guaranteed and probable penalties. |
|
total_daily_proximity_distance_m* |
Type: number Total daily proximity distance: total distance from the last location in each run to other locations in the same run, meters.More information |
|
total_daily_proximity_duration_s* |
Type: number Total daily proximity duration: total duration from the last location in each run to other locations in the same run, meters. |
|
total_daily_proximity_penalty* |
Type: number Sum of daily proximity penalties. |
|
total_duration_cost* |
Type: number Total cost for all employees involved.More information |
|
total_duration_s* |
Type: number Total duration including transit, service and waiting time, seconds. |
|
total_early_count* |
Type: integer Total number of arrivals earlier than the picked time window. |
|
total_early_duration_s* |
Type: number Total duration of early arrivals, sum of (start of the time window) - (arrival time), seconds. |
|
total_early_penalty* |
Type: number Sum of penalties applied for arriving and serving at location earlier than the picked time window. |
|
total_employee_locations_cost* |
Type: number Total of all used employees costs per location. |
|
total_failed_time_window_count* |
Type: integer Total number of time window fails (sum of |
|
total_failed_time_window_duration_s* |
Type: number Total duration of time window fails (sum of |
|
total_failed_time_window_penalty* |
Type: number Total penalties applied for being at a location outside the visit window. |
|
total_fixed_cost* |
Type: number Total of all used employees fixed costs. |
|
total_guaranteed_penalty* |
Type: number Total of all guaranteed penalties. |
|
total_late_count* |
Type: integer Total number of arrivals later than the picked time window. |
|
total_late_duration_s* |
Type: number Total duration of late arrivals, sum of (arrival time) - (end of the time window), seconds. |
|
total_late_penalty* |
Type: number Sum of penalties applied for arriving and serving at location later than the picked time window. |
|
total_mileage_penalty* |
Type: number Total penalties applied for mileage limit violation. |
|
total_optional_tags_cost* |
Type: number The value added to the total cost by optional tags. |
|
total_optional_zones_cost* |
Type: number The value added to the total cost by optional zones. |
|
total_penalty* |
Type: number Sum of guaranteed and probable penalties. |
|
total_runs_cost* |
Type: number Total of all used employees costs per run. |
|
total_service_duration_s* |
Type: number Total duration of service at locations, seconds |
|
total_stop_count_penalty* |
Type: number Total penalties applied for stop count limit violation. |
|
total_transit_distance_cost* |
Type: number Total of all used employees costs per transit distance. |
|
total_transit_distance_m* |
Type: number Total transit distance, meters. If |
|
total_transit_duration_s* |
Type: number Total transit duration (driving duration), seconds. |
|
total_unfeasibility_penalty* |
Type: number Sum of location drop penalties applied for locations which violate strict constraints but cannot be dropped. |
|
total_waiting_duration_s* |
Type: number Total duration of waiting at locations before travel to other locations or the start of the time window, seconds.More information |
|
undertime_duration_penalty* |
Type: number Sum of per minute penalties applied for violating of minimal shift duration. |
|
undertime_duration_s* |
Type: number Total shift undertime duration in seconds. |
|
undertime_penalty* |
Type: number Sum of penalties applied for violating of minimal shift duration. |
|
undertime_runs_count* |
Type: integer Number of shifts where duration is less than |
|
undertime_runs_count_penalty* |
Type: number Sum of fixed penalties applied for violating of minimal shift duration. |
|
used_employees* |
Type: integer Number of employees used in solution. |
|
used_man_days* |
Type: integer Total number of employee runs. |
|
additional_visitors_cost |
Type: number Total cost for additional locations visitors. More information |
|
assigned_location_count |
Type: integer Total number of partially or completely assigned to employees locations. |
|
available_man_days |
Type: integer Total number of available working days for all employees. |
|
completely_assigned_location_count |
Type: integer Total number of completely assigned to employees locations. |
|
completely_unassigned_location_count |
Type: integer Total number of completely unassigned to employees locations. |
|
global_proximity |
Type: number Global proximity level of route(s): average possible distance from the last location in route, kilometers. |
|
lateness_risk_location_count |
Type: integer Number of locations and deadlines with a risk of late arrival. |
|
max_employee_runs |
Type: integer Maximal number of a single employee runs. |
|
objective_minimum |
Type: number Minimum of optimization objective. |
|
operations_per_second |
Type: number Solver speed, number of operations per second. |
|
partially_assigned_location_count |
Type: integer Total number of partially assigned (partially unassigned) to employees locations. |
|
route_custom_cost |
Type: number Cost of custom defined expenses for route. For employees, the entire cost placed in metrics of route first run. |
|
route_payout |
Type: number Payout to employee of custom defined expenses for route. For employees, the entire payout placed in metrics of route first run.More information |
|
run_custom_cost |
Type: number Cost of custom defined expenses for run. |
|
run_payout |
Type: number Payout to employee of custom defined expenses for run.More information |
|
total_custom_cost |
Type: number Total cost of all custom defined expenses. Includes expenses for the route, shifts and runs. For employees, the entire route cost placed in metrics of first run. |
|
total_drop_penalty |
Type: number Sum of dropped locations penalties per drop. |
|
total_global_proximity_distance_m |
Type: number Total global proximity distance, meters. |
|
total_global_proximity_duration_s |
Type: number Total global proximity duration, seconds. |
|
total_global_proximity_penalty |
Type: number Sum of global proximity penalties. |
|
total_lateness_risk_probability |
Type: number Sum of all probabilities of being late on locations and deadlines. |
|
total_locations_cost |
Type: number Total of all visited locations costs. |
|
total_multiorders_penalty |
Type: number Total penalty for extra visits to multiorder points.More information |
|
total_payout |
Type: number Total amount of payouts to employees. For employees, the entire payment for the route placed in metrics of first run.More information |
|
total_probable_penalty |
Type: number Expected total of all probable penalties. |
|
total_public_transport_distance_cost |
Type: number Total of all employees costs for public transport usage distance (only pedestrian distance part of routes is actually considered).More information |
|
total_public_transport_distance_m |
Type: number Total public transport transit distance, meters (only pedestrian distance part of routes is actually considered).More information |
|
total_public_transport_duration_cost |
Type: number Total of all employees costs for public transport usage duration.More information |
|
total_public_transport_duration_s |
Type: number Total public transport usage duration, seconds.More information |
|
total_public_transport_edges_cost |
Type: number Total of all employees costs for transits between consucutive locations, using public transport.More information |
|
total_public_transport_runs_cost |
Type: number Total of all employees costs for all working days, when public transport is used.More information |
|
total_unfeasibility_count |
Type: number Number of locations which violate strict constraints but cannot be dropped. |
|
total_units |
Type: number Total weight of orders in the route in units. |
|
total_unpaid_distance_m |
Type: number Total transit distance between the last location on every day and the first location on the following day, for all employees, in seconds. |
|
total_unpaid_duration_s |
Type: number Total transit duration between the last location on every day and the first location on the following day, for all employees, in seconds. |
|
unassigned_location_count |
Type: integer Total number of partially or completely unassigned to employees locations. |
|
unfullfilled_visits |
Type: integer Total number of unfulfilled location visits, which needed to be made according to visit_count. |
solver_options
Solver options. It is forbidden to specify options that are not present in the list below.
|
Name |
Description |
|
date* |
Type: string Starting date for all routes ( Pattern: |
|
planning_days* |
Type: integer Planning period in days. More information Min value: |
|
time_zone* |
Type: number or string |
|
allow_multiple_visitors |
Type: boolean Allow one location to be visited by different employees. More information Default: |
|
avoid_tolls |
Type: boolean Do not use toll roads if possible (only for Default: |
|
avoid_zones |
Type: string[] List of zones that cannot be entered when performing a route. These zones will be avoided even if the fastest route passes through them. The total number of corners in zone polygons must not exceed 300. Min items: Max items: |
|
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: |
|
daily_proximity_factor |
Type: number Level of location proximity influence on employee routes during the day. Recommended values are from Default: Min value: Max value: |
|
distance_between_days_ends_factor |
Type: number Coefficient with which the cost for transit distances between run ending locations on consecutive days is added to the route costMore information Default: Min value: |
|
distance_between_days_starts_factor |
Type: number Coefficient with which the cost for transit distances between run starting locations on consecutive days is added to the route costMore information Default: Min value: |
|
duration_between_days_ends_factor |
Type: number Coefficient with which the cost for transit durations between run ending locations on consecutive days is added to the route costMore information Default: Min value: |
|
duration_between_days_starts_factor |
Type: number Coefficient with which the cost for transit durations between run starting locations on consecutive days is added to the route costMore information Default: Min value: |
|
fixed |
Type: boolean All routes, specified in Default: |
|
fixed_drops |
Type: boolean All visits, specified in Default: |
|
global_proximity_factor |
Type: number Level of location proximity influence on employee routes during the planning period. Recommended values are from Default: Min value: Max value: |
|
incompatible_load_types |
Type: string[][] Each item in this array defines list of location load types, that should not be handled within the same employee 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 employee run. More information |
|
late_days_cost_increment |
Type: number Parameter, helping solver to visit locations on earlier days. When this parameter is used, during optimization the cost of every used working day is increased by parameter value, multiplied by the day index (where day indices start with 0) ands coefficient declining from 1 to 0 during optimization (i.e. this parameter does not affect the final solutuion cost). 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: |
|
non_working_days |
Type: (integer or string)[] The list of non-working days during the planning period. Has a higher priority than the working_days and working_days_in_week.Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
penalize_late_service |
Type: boolean The option determines whether the employee should be penalized for the late start or end of a location visit.
Default: |
|
penalty |
Type: solver_options_penalty Penalties for global solution limitations violation. |
|
post_optimization |
Type: boolean Use post optimization: restart algorithm in the last 10% operations with disabled Default: |
|
quality |
Type: string Route optimization 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 Mode of routing. More information
Default: Enum: |
|
working_days |
Type: (integer or string)[] The list of working days during the planning period. Incompatible with the working_days_in_week option. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
working_days_in_week |
Type: integer Number of working days in week. Working days always start from Monday and distributed in the week evenly. Incompatible with the working_days option. More information Default: Min value: Max value: |
routes
|
Name |
Description |
|
metrics* |
Type: route_metrics Metrics for a single route. |
|
route* |
Type: route_element[] Sequence of route nodes, comprising a route. |
|
day |
Type: integer Number of the day, when the run was made (days are numbered from 0, starting with the date specified in 'date' option. |
|
employee_id |
Type: integer or string Employees ID. All employee IDs in task must be unique and have the same type: integer or string. More information |
|
global_proximity_attraction_point |
Type: routes_global_proximity_attraction_point Location of order to deliver from depot. |
|
run_number |
Type: integer Sequential number of a employee run. |
solver_status
Status of routing solver:
SOLVED- the VRP is fully solved within defined constraints,PARTIAL_SOLVED- the VRP is solved but some orders are dropped or some time windows are failed,UNFEASIBLE- unable to find solution that satisfies all strict constraints.
|
Type |
Description |
|
Enum: |
detailed_cost
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: detailed_cost_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: detailed_cost_subcosts_item[] The value of an arbitrary cost. |
calendar_planning_mvrp_response_zones_item
|
Name |
Description |
|
geometry* |
|
|
id* |
Type: string Zone number |
coordinate_1
WGS84 coordinate of a location. More information
|
Name |
Description |
|
lat* |
Type: number Min value: Max value: |
|
lon* |
Type: number Min value: Max value: |
dropped_locations_cost
Location cost. More information
|
Name |
Description |
|
additional_visitors |
Type: dropped_locations_cost_additional_visitors Constituents of the locations service cost if it was visited by several employees. More information |
dropped_locations_optional_tags_item
An optional tag for the location.
|
Name |
Description |
|
tag* |
Type: string An arbitrary tag. |
|
value* |
Type: number Value of the tag. When location is served by a employee with a matching tag in |
dropped_locations_penalty
Penalties for missing visits and violating location visit windows. More information
|
Name |
Description |
|
drop |
Type: number or penalty_drop_0_2 |
|
early |
Type: dropped_locations_penalty_early Constituents of penalties for violation of handling time — early visit to a location (used instead of the |
|
late |
Type: dropped_locations_penalty_late Penalty components for late visits (used instead of |
|
max_days_between_visits |
Type: dropped_locations_penalty_max_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
max_distinct_visitors |
Type: dropped_locations_penalty_max_distinct_visitors Penalty components for having location visited by more distinct employees, than specified in |
|
min_days_between_visits |
Type: dropped_locations_penalty_min_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
out_of_time |
Type: dropped_locations_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
preferred_days |
Type: dropped_locations_penalty_preferred_days Penalty components for failing to visit location on some of the week days, specified in |
|
visit_count |
Type: dropped_locations_penalty_visit_count Constituents of penalties for missed visits to a location. More information |
dropped_locations_shipment_size
Shipment size (dimensions and/or weight).
|
Name |
Description |
|
units |
Type: integer Size of shipment in custom units. Default: Min value: Max value: |
dropped_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 |
dropped_locations_visit
The properties of a specific type of location visits.
|
Name |
Description |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
drop |
Type: number Penalty for missing to visit of this type. Overrides |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
service_duration_s |
Type: number Handling time at the location. Overrides |
|
title |
Type: string Visits title (type). More information |
dropped_locations_visits_item
The properties of a specific type of location visits.
|
Name |
Description |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
drop |
Type: number Penalty for missing to visit of this type. Overrides |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
service_duration_s |
Type: number Handling time at the location. Overrides |
|
title |
Type: string Visits title (type). More information |
employee_capacity
Employee capacity
|
Name |
Description |
|
units |
Type: integer The maximum number of units that the employee can process in one working day. By default there are no restrictions. Min value: Max value: |
employee_cost_0
Employees cost. More information
|
Name |
Description |
|
empty |
Type: number Cost per fact of unused employee. Cost occurred if employee is not included in route.More information Default: Min value: |
|
empty_run |
Type: number Cost per single employee unused run from depot to locations.More information Default: Min value: |
|
fixed |
Type: number Cost per fact of employee use. More information Default: Min value: |
|
hour |
Type: number Cost of using employee per hour. It should not be zero or very small, otherwise you may get routes which are not optimal in terms of time.More information Default: Min value: |
|
km |
Type: number Cost of using employee per kilometer. It should not be zero or very small, otherwise you may get routes which are not optimal in terms of distance.More information Default: Min value: |
|
location |
Type: number Cost of visit per location (default 0). More information Default: Min value: |
|
run |
Type: number Cost per single employee run. More information Default: Min value: |
|
waiting_hour |
Type: number Cost of waiting per hour. If not defined, the value specified in the Min value: |
employee_cost_1
Description of the cost of using the employee with the possibility of specifying arithmetic expressions for individual parts of the route. The total cost will be obtained as the sum of all the specified expressions for all parts included in the route.
|
Name |
Description |
|
route |
Type: string Arithmetic expression representing route cost |
|
run |
Type: string Arithmetic expression representing run cost |
employee_optional_zones_item
An optional tag with bonus. More information
|
Name |
Description |
|
value* |
Type: number Value of the zone. This value is subtracted from the route cost for any served location with a matching zone.For location with multiple matching zones will be chosen the maximum bonus.More information |
|
zone* |
Type: string Zone id. |
employee_payout_0
Description of the payout to the employee for completing the route with the possibility of specifying arithmetic expressions for individual parts of the route. The total payout will be obtained as the sum of all the specified expressions for all parts included in the route.More information
|
Name |
Description |
|
route |
Type: string Arithmetic expression representing route cost |
|
run |
Type: string Arithmetic expression representing run cost |
employee_public_transport_cost
Cost for public transport use. More information
|
Name |
Description |
|
edge |
Type: number Fixed cost for every transit between two consucutive locations, using public transport.More information Default: Min value: |
|
hour |
Type: number Cost of using public transport per hour. More information Default: Min value: |
|
km |
Type: number Cost of using public transport per kilometer (only pedestrian distance part of routes is actually considered).More information Default: Min value: |
|
run |
Type: number Fixed cost for every employee working day, when public transport is used. More information Default: Min value: |
employee_working_days_item
Employees working day. More information
|
Name |
Description |
|
start_time* |
Type: string or array |
|
cost |
Type: number Cost of the employee's work on this day. More information Default: |
|
day |
Type: integer or string or array |
|
fixed |
Type: boolean All routes of the employee, specified in Default: |
|
hard_max_duration_s |
Type: number Hard limit on the maximum shift duration in seconds. If both Default: Min value: Max value: |
|
hard_max_finish_time |
Type: string Maximal a valid time for the end of the working day. More information |
|
hard_window |
Type: boolean Restricts time window relaxation during route planning. When Default: |
|
id |
Type: string Unique identifier of a shift. More information |
|
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. More information Default: Min value: Max value: |
|
max_finish_time |
Type: string The latest possible time of the end of the working day. More information |
|
max_mileage_km |
Type: number Maximal mileage of the employee during the shift in kilometers. If a planned mileage is greater than this value, the penalties from a shift parameter Min value: |
|
maximal_stops |
Type: integer Maximal number of stops per day, if the final stop count is greater than this value, Default: Min value: |
|
min_duration_s |
Type: number Minimal 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: |
|
minimal_stops |
Type: integer Minimal number of shift stops, if the final stop count is less than this value, Default: Min value: |
|
penalty |
Type: employee_working_days_penalty Penalties for shift constraints violation. More information |
solver_options_penalty
Penalties for global solution limitations violation.
|
Name |
Description |
|
multiorders |
Type: solver_options_penalty_multiorders Penalty components for extra visits to addresses with several locations.More information |
route_metrics
Metrics for a single route.
|
Name |
Description |
|
accomplished_visits* |
Type: integer Total number of location visits, made by all employees. |
|
affecting_utilization* |
Type: number Ratio of total employees working time, including travel time, spent on location visits, according to their service_duration_s. |
|
daily_proximity* |
Type: number Proximity level of daily runs: average possible distance from the last location in day run, to other locations visited on the same day, kilometers. |
|
early_location_count* |
Type: integer Number of locations where arrival will happen earlier than the picked time window. |
|
failed_time_window_location_count* |
Type: integer Number of locations where arrival will happen outside of the time window. |
|
general_utilization* |
Type: number Ratio of total employees working shifts length to their total, working time, including travel time. |
|
late_location_count* |
Type: integer Number of locations where arrival will happen later than the picked time window. |
|
overtime_duration_penalty* |
Type: number Sum of per minute penalties applied for violating of maximal shift duration. |
|
overtime_duration_s* |
Type: number Total shift overtime duration in seconds. |
|
overtime_penalty* |
Type: number Sum of penalties applied for violating of maximal shift duration. |
|
overtime_runs_count* |
Type: integer Number of shifts where duration is more than |
|
overtime_runs_count_penalty* |
Type: number Sum of fixed penalties applied for violating of maximal shift duration. |
|
regular_time_runs_count* |
Type: integer Number of routes, not violating working day duration limits. |
|
regular_time_runs_duration_s* |
Type: number Total duration of the routes, not violating working day duration limits, in seconds. |
|
total_cost* |
Type: number Total of all expenses. |
|
total_cost_with_penalty* |
Type: number Total expectation of all expenses including guaranteed and probable penalties. |
|
total_daily_proximity_distance_m* |
Type: number Total daily proximity distance: total distance from the last location in each run to other locations in the same run, meters.More information |
|
total_daily_proximity_duration_s* |
Type: number Total daily proximity duration: total duration from the last location in each run to other locations in the same run, meters. |
|
total_daily_proximity_penalty* |
Type: number Sum of daily proximity penalties. |
|
total_duration_cost* |
Type: number Total cost for all employees involved.More information |
|
total_duration_s* |
Type: number Total duration including transit, service and waiting time, seconds. |
|
total_early_count* |
Type: integer Total number of arrivals earlier than the picked time window. |
|
total_early_duration_s* |
Type: number Total duration of early arrivals, sum of (start of the time window) - (arrival time), seconds. |
|
total_early_penalty* |
Type: number Sum of penalties applied for arriving and serving at location earlier than the picked time window. |
|
total_employee_locations_cost* |
Type: number Total of all used employees costs per location. |
|
total_failed_time_window_count* |
Type: integer Total number of time window fails (sum of |
|
total_failed_time_window_duration_s* |
Type: number Total duration of time window fails (sum of |
|
total_failed_time_window_penalty* |
Type: number Total penalties applied for being at a location outside the visit window. |
|
total_fixed_cost* |
Type: number Total of all used employees fixed costs. |
|
total_guaranteed_penalty* |
Type: number Total of all guaranteed penalties. |
|
total_late_count* |
Type: integer Total number of arrivals later than the picked time window. |
|
total_late_duration_s* |
Type: number Total duration of late arrivals, sum of (arrival time) - (end of the time window), seconds. |
|
total_late_penalty* |
Type: number Sum of penalties applied for arriving and serving at location later than the picked time window. |
|
total_mileage_penalty* |
Type: number Total penalties applied for mileage limit violation. |
|
total_optional_tags_cost* |
Type: number The value added to the total cost by optional tags. |
|
total_optional_zones_cost* |
Type: number The value added to the total cost by optional zones. |
|
total_penalty* |
Type: number Sum of guaranteed and probable penalties. |
|
total_runs_cost* |
Type: number Total of all used employees costs per run. |
|
total_service_duration_s* |
Type: number Total duration of service at locations, seconds |
|
total_stop_count_penalty* |
Type: number Total penalties applied for stop count limit violation. |
|
total_transit_distance_cost* |
Type: number Total of all used employees costs per transit distance. |
|
total_transit_distance_m* |
Type: number Total transit distance, meters. If |
|
total_transit_duration_s* |
Type: number Total transit duration (driving duration), seconds. |
|
total_unfeasibility_penalty* |
Type: number Sum of location drop penalties applied for locations which violate strict constraints but cannot be dropped. |
|
total_waiting_duration_s* |
Type: number Total duration of waiting at locations before travel to other locations or the start of the time window, seconds.More information |
|
undertime_duration_penalty* |
Type: number Sum of per minute penalties applied for violating of minimal shift duration. |
|
undertime_duration_s* |
Type: number Total shift undertime duration in seconds. |
|
undertime_penalty* |
Type: number Sum of penalties applied for violating of minimal shift duration. |
|
undertime_runs_count* |
Type: integer Number of shifts where duration is less than |
|
undertime_runs_count_penalty* |
Type: number Sum of fixed penalties applied for violating of minimal shift duration. |
|
route_custom_cost |
Type: number Cost of custom defined expenses for route. For employees, the entire cost placed in metrics of route first run. |
|
route_payout |
Type: number Payout to employee of custom defined expenses for route. For employees, the entire payout placed in metrics of route first run.More information |
|
run_custom_cost |
Type: number Cost of custom defined expenses for run. |
|
run_payout |
Type: number Payout to employee of custom defined expenses for run.More information |
|
total_custom_cost |
Type: number Total cost of all custom defined expenses. Includes expenses for the route, shifts and runs. For employees, the entire route cost placed in metrics of first run. |
|
total_multiorders_penalty |
Type: number Total penalty for extra visits to multiorder points.More information |
|
total_payout |
Type: number Total amount of payouts to employees. For employees, the entire payment for the route placed in metrics of first run.More information |
|
total_public_transport_distance_cost |
Type: number Total of all employees costs for public transport usage distance (only pedestrian distance part of routes is actually considered).More information |
|
total_public_transport_distance_m |
Type: number Total public transport transit distance, meters (only pedestrian distance part of routes is actually considered).More information |
|
total_public_transport_duration_cost |
Type: number Total of all employees costs for public transport usage duration.More information |
|
total_public_transport_duration_s |
Type: number Total public transport usage duration, seconds.More information |
|
total_public_transport_edges_cost |
Type: number Total of all employees costs for transits between consucutive locations, using public transport.More information |
|
total_public_transport_runs_cost |
Type: number Total of all employees costs for all working days, when public transport is used.More information |
|
total_units |
Type: number Total weight of orders in the route in units. |
route_element
Route node. Contains data about a location in the route or a work break, travel duration between nodes, as well as the arrival time.
|
Name |
Description |
|
arrival_time_s* |
Type: number Arrival time at the location. Arrival happened before the start of the time window, will incur waiting time. |
|
node* |
Type: route_element_node Route component. |
|
transit_distance_m* |
Type: number Transit distance to a location, meters. If routing_mode is set to |
|
transit_duration_s* |
Type: number Transit time to a location, seconds. |
|
actual_arrival_time_s |
Type: number Actual arrival time at the location. |
|
actual_departure_time_s |
Type: number Actual time of departure from the location. |
|
actual_service_start_time_s |
Type: number Actual time of service start in the location. |
|
actual_waiting_duration_s |
Type: number Waiting duration, time spent at location after arrival and before the start of the time window, seconds. |
|
departure_time_s |
Type: number Time of departure from the location. |
|
failed_time_window |
|
|
multi_order |
Type: boolean Several locations are at the same address. Arrival time for all locations. Arrival time is the same for all orders in the group, also the orders share Default: |
|
overtime |
Type: route_element_overtime |
|
probably_failed_time_window |
|
|
stop_sequence_number |
Type: integer Sequence number of a stop (among check-in locations) |
|
waiting_duration_s |
Type: number Waiting duration, time spent at location after arrival and before the start of the time window, seconds. |
routes_global_proximity_attraction_point
Location of order to deliver from depot.
|
Name |
Description |
|
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 |
|
point* |
Type: coordinate_1 WGS84 coordinate of a location. More information |
|
address |
Type: string Address of the location. More information |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
comments |
Type: string Comments. More information |
|
cost |
Type: routes_global_proximity_attraction_point_cost Location cost. More information |
|
custom_value |
Type: number A custom numeric value, associated with location (E.g. the reward for the employee for visiting this location). May be used as a component in employee cost function. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
description |
Type: string Location description. More information |
|
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: |
|
last_visit_date |
Type: string The date of the last location visit before the start of planning period. More information |
|
load_types |
Type: string[] Defines compatibility with other locations in the route.
mustn |
|
mandatory_days |
Type: (integer or string)[] The list of days mandatory to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
max_days_between_visits |
Type: integer Maximal interval (in days) between two location visits. More information Min value: |
|
max_distinct_visitors |
Type: integer Maximal number of different employees visiting location. More information Default: Min value: |
|
max_total_employees |
Type: integer Maximal number of employees that can be served by an anchor location. Unlimited by default. |
|
min_days_between_visits |
Type: integer Minimal interval (in days) between two location visits. More information Default: Min value: |
|
optional_tags |
Type: routes_global_proximity_attraction_point_optional_tags_item[] A list of tags that an employee does not need to have to visit the location. These tags can reduce or increase the route cost. More information |
|
penalty |
Type: routes_global_proximity_attraction_point_penalty Penalties for missing visits and violating location visit windows. More information |
|
phone |
Type: string Phone number of check-in receiver. More information |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
priority |
Type: integer Location visit priority, the lower is this value, the higher is priority. Locations with higher |
|
ref |
Type: string Additional location ref. More information |
|
required_tags |
Type: string[] List of tags a employee must have to arrive at the location. More information |
|
service_duration_s |
Type: number The locations handling time. Handling time may include any operations at the location, such as loading or unloading or any other time/activity associated with the location (except waiting time, which is calculated as the difference between the employees arrival at the location and the start of handling time). More information Default: Min value: Max value: |
|
shared_with_company_ids |
Type: integer[] IDs of the companies that can access the order information.More information Min value: |
|
shipment_size |
Type: routes_global_proximity_attraction_point_shipment_size Shipment size (dimensions and/or weight). |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: routes_global_proximity_attraction_point_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
title |
Type: string Location title. More information |
|
type |
Type: string Defines the type of location:
Default: Enum: |
|
use_in_proximity |
Type: boolean When Default: |
|
visit_count |
Type: integer Required number of visits for a location in planning period. More information Default: Min value: |
|
visits |
Type: routes_global_proximity_attraction_point_visits_item[] Descriptions of individual location visits.More information |
detailed_cost_raw_metrics_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: detailed_cost_raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: detailed_cost_raw_metrics_subcosts_item[] The value of an arbitrary cost. |
detailed_cost_subcosts_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: detailed_cost_subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: detailed_cost_subcosts_subcosts_item[] The value of an arbitrary cost. |
calendar_planning_mvrp_response_zones_geometry
|
Name |
Description |
|
coordinates |
Type: number[][][] Always consists of two elements: longitude and latitude.More information |
|
type |
Type: string Always equals |
dropped_locations_cost_additional_visitors
Constituents of the locations service cost if it was visited by several employees. More information
|
Name |
Description |
|
fixed |
Type: number Fixed cost applied if the location is visited by more than one employees. More information Default: |
|
per_visitor |
Type: number Cost for each additional employee, visiting a location. More information Default: |
penalty_drop_0_2
Penalty if there was not a single visit to a location. In case of use, it is forbidden to use the visit_count part of location penalty.
|
Name |
Description |
|
all |
Type: number Penalty if there was not a single visit to a location. More information Default: |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required.More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
dropped_locations_penalty_early
Constituents of penalties for violation of handling time — early visit to a location (used instead of the out_of_time penalty).More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty for violation of handling time — visiting a location earlier than the specified visit window.More information Default: |
|
minute |
Type: number Penalty for every minute of early attendance if handling time started earlier than the specified visit window.More information Default: |
dropped_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.More information Default: |
|
minute |
Type: number Penalty for every minute of delay if a location is visited after the specified visit window.More information Default: |
dropped_locations_penalty_max_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is more than required. More information Default: |
|
per_day |
Type: number Penalty for each excessive day between location visits. More information Default: |
dropped_locations_penalty_max_distinct_visitors
Penalty components for having location visited by more distinct employees, than specified in max_distinct_visitors option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited by more distinct employees, than specified in Default: |
|
per_visitor |
Type: number Penalty for each excessive employee, visiting a location. More information Default: |
dropped_locations_penalty_min_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is less than required. More information Default: |
|
per_day |
Type: number Penalty for each missing day between location visits. More information Default: |
dropped_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 for visiting a location earlier or later than the specified visit window. See the specifications of Default: |
|
minute |
Type: number Penalty for every minute of being late or for visiting a location before the specified visit window. See the specifications of Default: |
dropped_locations_penalty_preferred_days
Penalty components for failing to visit location on some of the week days, specified in preferred_days option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is not visited on some of the days, specified in Default: |
|
per_day |
Type: number Penalty for each day in Default: |
dropped_locations_penalty_visit_count
Constituents of penalties for missed visits to a location. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required. More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
working_days_start_time_0_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 |
employee_working_days_penalty
Penalties for shift constraints violation. More information
|
Name |
Description |
|
early |
Type: working_days_penalty_early Penalty components for shifts started too early (used instead of |
|
late |
Type: working_days_penalty_late Penalty components for shifts finished too late (used instead of |
|
max_mileage |
Type: working_days_penalty_max_mileage Penalties applied for exceeding the maximum allowed distance traveled by an employee in a working day (the |
|
out_of_time |
Type: working_days_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
stop_excess |
Type: working_days_penalty_stop_excess Penalties applied for violating shifts |
|
stop_lack |
Type: working_days_penalty_stop_lack Penalties applied for violating shifts |
solver_options_penalty_multiorders
Penalty components for extra visits to addresses with several locations.More information
|
Name |
Description |
|
per_extra_employee |
Type: number Penalty for every extra employees that arrives at address with several locations.More information Default: Min value: |
|
per_extra_point |
Type: number Penalty for every address where employees arrive more than once.More information Default: Min value: |
|
per_extra_visit |
Type: number Penalty for each extra visit to address with several locations.More information Default: Min value: |
route_element_node
Route component.
|
Name |
Description |
|
type* |
Type: string Type of a route component. Enum: |
|
value* |
Type: route_location Description of a location. |
|
used_hard_time_window |
Type: string Hard time window used to visit location or depot, in |
|
used_projection |
Type: route_element_node_used_projection WGS84 coordinate of a location. More information |
|
used_time_window |
Type: string Time window used to visit location or depot, in |
route_element_failed_time_window
|
Name |
Description |
|
duration_s* |
Type: number When a location is visited outside the visit window, it shows the time difference (in seconds) between the start or end time of the visit (depending on the value in |
|
how* |
Type: string When a location is visited outside of the time window, indicates the time direction between the arrival time and the failed time window:
Enum: |
route_element_overtime
|
Name |
Description |
|
duration_s* |
Type: number Employees shift overtime in seconds. |
route_element_probably_failed_time_window
|
Name |
Description |
|
duration_s* |
Type: number Expected difference between arrival time and failing time window, seconds. |
|
how* |
Type: string When a location is visited outside of the time window, indicates the time direction between the arrival time and the failed time window:
Enum: |
|
probability* |
Type: number Probability of being outside of the time window, percent.More information |
|
high_risk |
Type: boolean When true, it means that probability of being late on location is greater or equal to |
routes_global_proximity_attraction_point_cost
Location cost. More information
|
Name |
Description |
|
additional_visitors |
Type: global_proximity_attraction_point_cost_additional_visitors Constituents of the locations service cost if it was visited by several employees. More information |
routes_global_proximity_attraction_point_optional_tags_item
An optional tag for the location.
|
Name |
Description |
|
tag* |
Type: string An arbitrary tag. |
|
value* |
Type: number Value of the tag. When location is served by a employee with a matching tag in |
routes_global_proximity_attraction_point_penalty
Penalties for missing visits and violating location visit windows. More information
|
Name |
Description |
|
drop |
Type: number or global_proximity_attraction_point_penalty_drop_0 |
|
early |
Type: global_proximity_attraction_point_penalty_early Constituents of penalties for violation of handling time — early visit to a location (used instead of the |
|
late |
Type: global_proximity_attraction_point_penalty_late Penalty components for late visits (used instead of |
|
max_days_between_visits |
Type: global_proximity_attraction_point_penalty_max_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
max_distinct_visitors |
Type: global_proximity_attraction_point_penalty_max_distinct_visitors Penalty components for having location visited by more distinct employees, than specified in |
|
min_days_between_visits |
Type: global_proximity_attraction_point_penalty_min_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
out_of_time |
Type: global_proximity_attraction_point_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
preferred_days |
Type: global_proximity_attraction_point_penalty_preferred_days Penalty components for failing to visit location on some of the week days, specified in |
|
visit_count |
Type: global_proximity_attraction_point_penalty_visit_count Constituents of penalties for missed visits to a location. More information |
routes_global_proximity_attraction_point_shipment_size
Shipment size (dimensions and/or weight).
|
Name |
Description |
|
units |
Type: integer Size of shipment in custom units. Default: Min value: Max value: |
routes_global_proximity_attraction_point_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 |
routes_global_proximity_attraction_point_visits_item
The properties of a specific type of location visits.
|
Name |
Description |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
drop |
Type: number Penalty for missing to visit of this type. Overrides |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
service_duration_s |
Type: number Handling time at the location. Overrides |
|
title |
Type: string Visits title (type). More information |
detailed_cost_raw_metrics_raw_metrics_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_14[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_12[] The value of an arbitrary cost. |
detailed_cost_raw_metrics_subcosts_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_11[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_10[] The value of an arbitrary cost. |
detailed_cost_subcosts_raw_metrics_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_7[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_5[] The value of an arbitrary cost. |
detailed_cost_subcosts_subcosts_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_4[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_3[] The value of an arbitrary cost. |
working_days_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.
|
Name |
Description |
|
fixed |
Type: number Fixed penalty for starting or ending a working day before the time specified in the Default: |
|
minute |
Type: number Penalty for every minute of an early start or end of the working day when an employee starts or ends a working day before the time specified in the Default: |
working_days_penalty_late
Penalty components for shifts finished too late (used instead of out_of_time penalty). The penalty is applied both for the late end of a working day and for exceeding the maximum duration of a working day (max_duration_s). If both are violated simultaneously, the penalty is applied twice and summed. If the employee started their working day later than the time indicated in the max_finish_time parameter, in addition to this penalty, a penalty for the late start of a working day is also applied. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the employee 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 employee starts or finishes the shift after the end of the time window or if the employee spends more than Default: |
working_days_penalty_max_mileage
Penalties applied for exceeding the maximum allowed distance traveled by an employee in a working day (the max_mileage_km parameter).More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a employee 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: |
working_days_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 for working earlier than the start or later than the end of the working day. See the specifications of Default: |
|
minute |
Type: number Penalty for every minute of work before the start or later than the end of the working day. See the specifications of Default: |
working_days_penalty_stop_excess
Penalties applied for violating shifts maximal_stops limit.More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a employee 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: |
working_days_penalty_stop_lack
Penalties applied for violating shifts minimal_stops limit.More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if a employee 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: |
route_location
Description of a location.
|
Name |
Description |
|
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 |
|
added_shared_service_duration_s |
Type: number Additional service time for the address. For the first location at this address, it is Default: Min value: Max value: |
|
address |
Type: string Address of the location. More information |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
comments |
Type: string Comments. More information |
|
cost |
Type: route_location_cost Location cost. More information |
|
custom_value |
Type: number A custom numeric value, associated with location (E.g. the reward for the employee for visiting this location). May be used as a component in employee cost function. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
description |
Type: string Location description. More information |
|
drop_reason |
Type: string Explanation why the location was dropped. |
|
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: |
|
is_visited_by_deputy |
Type: boolean Location was visited by deputy employee. |
|
last_visit_date |
Type: string The date of the last location visit before the start of planning period. More information |
|
load_types |
Type: string[] Defines compatibility with other locations in the route.
mustn |
|
mandatory_days |
Type: (integer or string)[] The list of days mandatory to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
max_days_between_visits |
Type: integer Maximal interval (in days) between two location visits. More information Min value: |
|
max_distinct_visitors |
Type: integer Maximal number of different employees visiting location. More information Default: Min value: |
|
max_total_employees |
Type: integer Maximal number of employees that can be served by an anchor location. Unlimited by default. |
|
min_days_between_visits |
Type: integer Minimal interval (in days) between two location visits. More information Default: Min value: |
|
optional_tags |
Type: route_location_optional_tags_item[] A list of tags that an employee does not need to have to visit the location. These tags can reduce or increase the route cost. More information |
|
penalty |
Type: route_location_penalty Penalties for missing visits and violating location visit windows. More information |
|
phone |
Type: string Phone number of check-in receiver. More information |
|
point |
Type: coordinate_1 WGS84 coordinate of a location. More information |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
priority |
Type: integer Location visit priority, the lower is this value, the higher is priority. Locations with higher |
|
ref |
Type: string Additional location ref. More information |
|
required_tags |
Type: string[] List of tags a employee must have to arrive at the location. More information |
|
routing_mode |
Type: string The routing mode used to reach this location. Enum: |
|
service_duration_s |
Type: number The locations handling time. Handling time may include any operations at the location, such as loading or unloading or any other time/activity associated with the location (except waiting time, which is calculated as the difference between the employees arrival at the location and the start of handling time). More information Default: Min value: Max value: |
|
service_waiting_duration_s |
Type: number Waiting time duration before the start of the locations service time. It may be non-zero when, for example, several locations are at the same address. In this case waiting duration includes duration of service of the other orders from the multi-order. Default: Min value: Max value: |
|
shared_with_company_ids |
Type: integer[] IDs of the companies that can access the order information.More information Min value: |
|
shipment_size |
Type: route_location_shipment_size Shipment size (dimensions and/or weight). |
|
time_window |
Type: string Allowed time window to visit location, in |
|
time_windows |
Type: route_location_time_windows_item[] List of allowed time windows. Time windows can not overlap. Fields |
|
title |
Type: string Location title. More information |
|
total_service_duration_s |
Type: number Total duration of service at a location, it includes Default: Min value: Max value: |
|
type |
Type: string Defines the type of location:
Default: Enum: |
|
unfeasible_reasons |
Type: (route_location_unfeasible_reasons_0 or route_location_unfeasible_reasons_1 or route_location_unfeasible_reasons_2 or route_location_unfeasible_reasons_3 or route_location_unfeasible_reasons_4 or route_location_unfeasible_reasons_5 or route_location_unfeasible_reasons_6 or route_location_unfeasible_reasons_7 or route_location_unfeasible_reasons_8 or route_location_unfeasible_reasons_9)[] List of unfeasible reasons. |
|
use_in_proximity |
Type: boolean When Default: |
|
visit |
Type: route_location_visit The properties of a specific type of location visits. |
|
visit_count |
Type: integer Required number of visits for a location in planning period. More information Default: Min value: |
|
visit_index |
Type: integer |
|
visits |
Type: route_location_visits_item[] Descriptions of individual location visits.More information |
route_element_node_used_projection
WGS84 coordinate of a location. More information
|
Name |
Description |
|
lat* |
Type: number Min value: Max value: |
|
lon* |
Type: number Min value: Max value: |
global_proximity_attraction_point_cost_additional_visitors
Constituents of the locations service cost if it was visited by several employees. More information
|
Name |
Description |
|
fixed |
Type: number Fixed cost applied if the location is visited by more than one employees. More information Default: |
|
per_visitor |
Type: number Cost for each additional employee, visiting a location. More information Default: |
global_proximity_attraction_point_penalty_drop_0
Penalty if there was not a single visit to a location. In case of use, it is forbidden to use the visit_count part of location penalty.
|
Name |
Description |
|
all |
Type: number Penalty if there was not a single visit to a location. More information Default: |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required.More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
global_proximity_attraction_point_penalty_early
Constituents of penalties for violation of handling time — early visit to a location (used instead of the out_of_time penalty).More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty for violation of handling time — visiting a location earlier than the specified visit window.More information Default: |
|
minute |
Type: number Penalty for every minute of early attendance if handling time started earlier than the specified visit window.More information Default: |
global_proximity_attraction_point_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.More information Default: |
|
minute |
Type: number Penalty for every minute of delay if a location is visited after the specified visit window.More information Default: |
global_proximity_attraction_point_penalty_max_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is more than required. More information Default: |
|
per_day |
Type: number Penalty for each excessive day between location visits. More information Default: |
global_proximity_attraction_point_penalty_max_distinct_visitors
Penalty components for having location visited by more distinct employees, than specified in max_distinct_visitors option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited by more distinct employees, than specified in Default: |
|
per_visitor |
Type: number Penalty for each excessive employee, visiting a location. More information Default: |
global_proximity_attraction_point_penalty_min_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is less than required. More information Default: |
|
per_day |
Type: number Penalty for each missing day between location visits. More information Default: |
global_proximity_attraction_point_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 for visiting a location earlier or later than the specified visit window. See the specifications of Default: |
|
minute |
Type: number Penalty for every minute of being late or for visiting a location before the specified visit window. See the specifications of Default: |
global_proximity_attraction_point_penalty_preferred_days
Penalty components for failing to visit location on some of the week days, specified in preferred_days option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is not visited on some of the days, specified in Default: |
|
per_day |
Type: number Penalty for each day in Default: |
global_proximity_attraction_point_penalty_visit_count
Constituents of penalties for missed visits to a location. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required. More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
raw_metrics_raw_metrics_item_14
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_13[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_13[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_12
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_13[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_13[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_11
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_10[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_9[] The value of an arbitrary cost. |
subcosts_subcosts_item_10
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_9[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_9[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_7
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_6[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_6[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_5
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_6[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_6[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_4
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_3[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_2[] The value of an arbitrary cost. |
subcosts_subcosts_item_3
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_2[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_2[] The value of an arbitrary cost. |
route_location_cost
Location cost. More information
|
Name |
Description |
|
additional_visitors |
Type: route_location_cost_additional_visitors Constituents of the locations service cost if it was visited by several employees. More information |
route_location_optional_tags_item
An optional tag for the location.
|
Name |
Description |
|
tag* |
Type: string An arbitrary tag. |
|
value* |
Type: number Value of the tag. When location is served by a employee with a matching tag in |
route_location_penalty
Penalties for missing visits and violating location visit windows. More information
|
Name |
Description |
|
drop |
Type: number or route_location_penalty_drop_0 |
|
early |
Type: route_location_penalty_early Constituents of penalties for violation of handling time — early visit to a location (used instead of the |
|
late |
Type: route_location_penalty_late Penalty components for late visits (used instead of |
|
max_days_between_visits |
Type: route_location_penalty_max_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
max_distinct_visitors |
Type: route_location_penalty_max_distinct_visitors Penalty components for having location visited by more distinct employees, than specified in |
|
min_days_between_visits |
Type: route_location_penalty_min_days_between_visits Penalty components for the violation of days between visits requirement. More information |
|
out_of_time |
Type: route_location_penalty_out_of_time Penalty components for time window failure. Can be used to set the values of |
|
preferred_days |
Type: route_location_penalty_preferred_days Penalty components for failing to visit location on some of the week days, specified in |
|
visit_count |
Type: route_location_penalty_visit_count Constituents of penalties for missed visits to a location. More information |
route_location_shipment_size
Shipment size (dimensions and/or weight).
|
Name |
Description |
|
units |
Type: integer Size of shipment in custom units. Default: Min value: Max value: |
route_location_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 |
route_location_unfeasible_reasons_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. |
route_location_unfeasible_reasons_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: |
route_location_unfeasible_reasons_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: |
route_location_unfeasible_reasons_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: |
route_location_unfeasible_reasons_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: |
route_location_unfeasible_reasons_5
The reason why the location is not feasible.
|
Name |
Description |
|
incompatibilities* |
Type: unfeasible_reasons_incompatibilities_item_1[] List of all incompatible load type pairs |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons:
Enum: |
route_location_unfeasible_reasons_6
The reason why the location is not feasible.
|
Name |
Description |
|
incompatibilities* |
Type: unfeasible_reasons_incompatibilities_item[] List of all incompatible zone pairs |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons:
Enum: |
route_location_unfeasible_reasons_7
The reason why the location is not feasible.
|
Name |
Description |
|
tags* |
Type: string[] List of employee's allowed zones. |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons:
Enum: |
route_location_unfeasible_reasons_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: |
route_location_unfeasible_reasons_9
The reason why the location is not feasible.
|
Name |
Description |
|
text* |
Type: string Explanation for the reason the location was not feasible. |
|
type* |
Type: string Possible reasons:
Enum: |
route_location_visit
The properties of a specific type of location visits.
|
Name |
Description |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
drop |
Type: number Penalty for missing to visit of this type. Overrides |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
service_duration_s |
Type: number Handling time at the location. Overrides |
|
title |
Type: string Visits title (type). More information |
route_location_visits_item
The properties of a specific type of location visits.
|
Name |
Description |
|
allowed_days |
Type: (integer or string)[] The list of days allowed to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
denied_days |
Type: (integer or string)[] The list of days denied to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
drop |
Type: number Penalty for missing to visit of this type. Overrides |
|
preferred_days |
Type: (integer or string)[] The list of days preferred to visit the location. Dates in the YYYY-MM-DD format, numbers of days from the start of planning and names of days of the week in English with a capital letter are allowed. More information |
|
service_duration_s |
Type: number Handling time at the location. Overrides |
|
title |
Type: string Visits title (type). More information |
raw_metrics_raw_metrics_item_13
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_12[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_14[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_13
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_14[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_14[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_13
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_11[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_11[] The value of an arbitrary cost. |
subcosts_subcosts_item_13
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_12[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_12[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_10
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_9[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_10[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_9
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_10[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_11[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_9
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_8[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_8[] The value of an arbitrary cost. |
subcosts_subcosts_item_9
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_8[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_8[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_6
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_5[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_7[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_6
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_7[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_7[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_6
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_4[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_4[] The value of an arbitrary cost. |
subcosts_subcosts_item_6
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_5[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_5[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_3
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_2[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_3[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_2
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_3[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_4[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_2
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item_1[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item_1[] The value of an arbitrary cost. |
subcosts_subcosts_item_2
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item_1[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item_1[] The value of an arbitrary cost. |
route_location_cost_additional_visitors
Constituents of the locations service cost if it was visited by several employees. More information
|
Name |
Description |
|
fixed |
Type: number Fixed cost applied if the location is visited by more than one employees. More information Default: |
|
per_visitor |
Type: number Cost for each additional employee, visiting a location. More information Default: |
route_location_penalty_drop_0
Penalty if there was not a single visit to a location. In case of use, it is forbidden to use the visit_count part of location penalty.
|
Name |
Description |
|
all |
Type: number Penalty if there was not a single visit to a location. More information Default: |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required.More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
route_location_penalty_early
Constituents of penalties for violation of handling time — early visit to a location (used instead of the out_of_time penalty).More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty for violation of handling time — visiting a location earlier than the specified visit window.More information Default: |
|
minute |
Type: number Penalty for every minute of early attendance if handling time started earlier than the specified visit window.More information Default: |
route_location_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.More information Default: |
|
minute |
Type: number Penalty for every minute of delay if a location is visited after the specified visit window.More information Default: |
route_location_penalty_max_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is more than required. More information Default: |
|
per_day |
Type: number Penalty for each excessive day between location visits. More information Default: |
route_location_penalty_max_distinct_visitors
Penalty components for having location visited by more distinct employees, than specified in max_distinct_visitors option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited by more distinct employees, than specified in Default: |
|
per_visitor |
Type: number Penalty for each excessive employee, visiting a location. More information Default: |
route_location_penalty_min_days_between_visits
Penalty components for the violation of days between visits requirement. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the time past between two location visits is less than required. More information Default: |
|
per_day |
Type: number Penalty for each missing day between location visits. More information Default: |
route_location_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 for visiting a location earlier or later than the specified visit window. See the specifications of Default: |
|
minute |
Type: number Penalty for every minute of being late or for visiting a location before the specified visit window. See the specifications of Default: |
route_location_penalty_preferred_days
Penalty components for failing to visit location on some of the week days, specified in preferred_days option. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is not visited on some of the days, specified in Default: |
|
per_day |
Type: number Penalty for each day in Default: |
route_location_penalty_visit_count
Constituents of penalties for missed visits to a location. More information
|
Name |
Description |
|
fixed |
Type: number Fixed penalty applied if the location is visited more or less times than required. More information Default: |
|
per_visit |
Type: number Penalty for each excessive of missing location visit. More information Default: |
unfeasible_reasons_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 Location ID. More information |
|
types* |
Type: incompatibilities_types_item[] |
unfeasible_reasons_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 Location ID. More information |
|
zones* |
Type: incompatibilities_zones_item[] |
raw_metrics_raw_metrics_item_12
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_14
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_14
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_14
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_11
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_11
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_12
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_12
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_9
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_10
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_10
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_11
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_8
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_8
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_8
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_8
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_5
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_7
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_7
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_7
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_4
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_4
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_5
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_5
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_2
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_3
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_3
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_4
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_raw_metrics_item_1
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
raw_metrics_subcosts_item_1
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
subcosts_raw_metrics_item_1
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: raw_metrics_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: raw_metrics_subcosts_item[] The value of an arbitrary cost. |
subcosts_subcosts_item_1
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
|
raw_metrics |
Type: subcosts_raw_metrics_item[] The value of an arbitrary cost. |
|
subcosts |
Type: subcosts_subcosts_item[] The value of an arbitrary cost. |
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. |
raw_metrics_raw_metrics_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
raw_metrics_subcosts_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
subcosts_raw_metrics_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
subcosts_subcosts_item
The value of an arbitrary cost.
|
Name |
Description |
|
name* |
Type: string |
|
value* |
Type: number |
400 Bad Request
Invalid query parameters or body.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
error_1_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. |
401 Unauthorized
Missing or invalid apikey.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
402 Payment Required
Banned apikey.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
404 Not Found
Task not found.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
500 Internal Server Error
Server error during request processing.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
No longer supported, please use an alternative and newer version.