VRt.Universal [UV] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary Terms of Service

Main site

Description

Software interface for universal trip planning.

Features

Ability to pick up cargo from any location
Possibility of unloading in any location
Pair orders of several types: PICKUP (loading), DROP (unloading)
Single requests of several types: DROP_FROM_BOX (unloading cargo that is already in the body), PICKUP_TO_BOX (cargo pickup into the body without subsequent unloading), WORK (working at the location without moving the cargo)
A complex order can consist of any number of orders of any type
Transport and executors are divided into different entities, when planning, the optimal assignment of the executor to the transport occurs
The transport has several compartments - each of which can accommodate cargo and has its own characteristics
Accounting for the compatibility of cargo with transport in terms of cargo dimensions (length, width, height, additional capacity parameters)
Taking into account the compatibility of the cargo-compartment of transport (the ability to take into account the features of the compartment: refrigerator, thermal bag, fasteners, etc.)
Substitute applications, i.e. the ability to execute one of the substitute applications, the choice of which is based on its geographic location and time window

Restrictions support

Performer restrictions:

Start/finish location
Accounting for the performer's way to the transport location
Performer's availability schedule is a list of time windows when the performer can move and work on locations
The maximum duration of the performer's work during the specified time period

Transport restrictions:

Start/finish location
Transport availability schedule is a list of time windows when the transport is available
The maximum route distance
Several compartments in the transport, each with its own parameters
Capacity upper limit (weight, volume, number of orders, number of demands)

Order restrictions:

Strict time windows
Ability to specify different valid time windows for a location and time windows to fulfil the desired demand
Accounting for the requests fulfillment order within the route
A list of desired time windows with different associated costs

Compatibilities

Entities are compatible if the capabilities list of one entity corresponds to the list of restrictions of another entity (example: fleet parameters corresponds to cargo parameters to be delivered).

Supported compatibilities:

Name	Restrictions	Features
Order - Performer	order.performer_restrictions	performer.performer_features
Order - Not a performer	order.performer_blacklist	performer.performer_features
Cargo - Compartment	order.cargo.box_restrictions	transport.box.box_features
Location - Transport	location.transport_restrictions	transport.transport_features
Transport - Performer	transport.performer_restrictions	performer.performer_features
Performer - Transport	performer.transport_restrictions	transport.transport_features
Order - Order	order.order_restrictions	order.order_features

Business rule examples:

Name	Business rule example
Order - Performer	The driver must have a special license to fulfil the order
Order - Not a performer	The driver is in the blacklist
Cargo - Box	For transportation of frozen products, a compartment with a special temperature profile is required
Location - Transport	Restrictions on the transport height
Transport - Performer	The truck driver must have the class C driving license
Performer - Transport	The driver is allowed to work on a specific transport
Order - Order	It is not allowed to transport fish and fruits in the same compartment

Cargo placement

List of possibilities of a object rotations (90 degree step):

ALL - can rotate by any axis
YAW - can yaw
PITCH - can pitch
ROLL - can roll

rotation

Trip model

The trip is described by the list of states of the executor, while the executor can be in several states at the same time (for example, to be inside the working time window of a location and fulfill an order at the same location).

Possible values of the flags responsible for the geographical location:

AROUND_LOCATION - the performer is located near the location - in the process of parking or leaving it.
INSIDE_LOCATION - the performer is at the location.

Possible values of the flags responsible for being in time windows:

INSIDE_WORKING_WINDOW - the executor is inside the working time window.
INSIDE_LOCATION_WINDOW - the executor is inside the location's working time.
INSIDE_EVENT_HARD_WINDOW - the executor is inside a hard time window.
INSIDE_EVENT_SOFT_WINDOW - the executor is inside the soft time window.

Possible values of flags responsible for actions:

ON_DEMAND - the executor is working on the request.
WAITING - the performer is in standby mode.
RELOCATING - the executor is moving to the next stop.
BREAK - the performer is on a break.

An example of a route with multiple states at each point in time

time	set of active flags	location / order / application / event	comment
10:00	INSIDE_LOCATION AROUND_LOCATION	2 / - / - / -	starting location
10:10	RELOCATING	- / - / - / -	we go to the first order
10:20	AROUND_LOCATION	2 / - / - / -	arrived at the first order
10:40	AROUND_LOCATION INSIDE_LOCATION WAITING	2 / - / - / -	parked
11:00	AROUND_LOCATION INSIDE_LOCATION INSIDE_LOCATION_WINDOW WAITING INSIDE_EVENT_HARD_WINDOW	2 / - / - / -	waited for the start of the location window and at the same time the availability of the order
11:25	AROUND_LOCATION INSIDE_LOCATION INSIDE_LOCATION_WINDOW ON_DEMAND INSIDE_WORKING_WINDOW INSIDE_EVENT_HARD_WINDOW	2 / 1 / 2 / 3	waited for the change of artist
11:30	AROUND_LOCATION INSIDE_LOCATION INSIDE_LOCATION_WINDOW ON_DEMAND INSIDE_WORKING_WINDOW INSIDE_EVENT_HARD_WINDOW INSIDE_EVENT_SOFT_WINDOW	2 / 1 / 2 / 3	while working - a soft window happened
11:40	AROUND_LOCATION INSIDE_LOCATION INSIDE_LOCATION_WINDOW INSIDE_WORKING_WINDOW	2 / - / - / -	finished working
11:45	AROUND_LOCATION INSIDE_WORKING_WINDOW	2 / - / - / -	drove out of the parking lot
11:45	RELOCATING INSIDE_WORKING_WINDOW	- / - / - / -	we go to the next order

Planning configuration

For each planning, it is possible to specify a planning configuration that defines the objective function, the desired quality of the routes, and the calculation speed.

The name of the scheduling configuration is passed in the trips_settings.configuration field.

Main configurations:

Title	Task
optimize_distance	Arrange as many orders as possible, then optimize the total mileage (the number of vehicles is selected based on the mileage), used by default
optimize_transports	Place as many orders as possible, while using as little transport as possible, ceteris paribus, optimize the work time of performers
optimize_locality_grouping	Place as many orders as possible, while striving to optimize the visual grouping of routes, but not their number
optimize_cars_then_distance	Arrange as many orders as possible, then optimize the number of vehicles, then the mileage
optimize_time	Place as many orders as possible, then optimize the total work time of performers
optimize_cars_then_time	Arrange as many orders as possible, then optimize the number of transport, then the total time of the performers
optimize_money	Optimize the value of "profit - costs", consists of rewards for applications and costs for performers and transports (optimized value is non-negative)

Additional configurations:

Title	Task
visual_grouping	Arrange as many orders as possible while using as little transport as possible and routes should be visually grouped
optimize_visual_grouping	Arrange as many orders as possible, then evenly distribute orders taking into account transport accessibility zones (similar to visual_grouping, but visual grouping is calculated differently)
optimize_cars_then_locality_grouping	Arrange as many orders as possible, then optimize the number of vehicles, then visually group the routes
optimize_cars_then_single_location_grouping_sequenced	Place as many orders as possible, then optimize the number of machines, then reliability

In addition to the existing planning options, it is possible to create an objective function directly for the client's business processes (request configuration).

For development, it is recommended to use optimize_cars_then_distance, since this configuration does not require detailed selection of rates and order values.

Data validation

Input data validation consists of several steps, which are described below.

Validation of planning results (including the search for possible reasons why orders were not planned) is located in the analytics method.

1. Schema check

If the request does not follow the schema, then scheduling is not fully started and such an error is returned along with a 400 code in schema_errors.

We recommend validating the request against the schema (or yaml file) before sending it to the server.

2. Check for logical errors that prevent planning from continuing

Schema-correct data passes the second stage of checking for the possibility of starting planning.

An example of errors at this stage are keys leading to empty entities, or if all orders are incompatible with all performers, i.e. something that makes the planning task pointless.

These errors are returned along with a 400 code in logical_errors.

3. Check for logical errors that prevent planning from continuing

At the third stage, each entity is checked separately.

All entities that have not passed validation are cut out from the original task and are not sent for planning.

Depending on the setting of treat_warnings_as_errors, the results of this type of validation are returned to warnings either with a 400 code or with the scheduling result.

4. Checks in the planning process

Part of the checks can only be carried out in the planning process.

For example - that according to the specified tariffs and according to the current traffic forecast, it is physically impossible to reach a certain point.

The results of these checks are returned in warnings or together with the scheduling result.

Entity relationship diagram

erd

Xlsx

Description of VRt.Universal XLSX format for import / data export.

This format is a complete display of data JSON models and is used for:

initial data
process settings
calculation results
statistics on the calculation result

Below is a description of each sheet separately.

Locations

The name of the sheet locations.

List of locations that are used in orders and shifts.

The described object:

key required	string [ 1 .. 1024 ] characters Location key, unique identifier.
required	object (geopoint) Geographical point.
arrival_duration	string<duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Time for driving up to the location (or waiting time at parking lot) according to ISO 8601 duration.
departure_duration	string<duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Time to leave the location according to ISO 8601 duration.
	Array of objects or null (time_window) [ 0 .. 100 ] items unique Default: [] List of time windows for the location. If the list is empty or not specified, the location works without time limits.
	object or null (location_compatibilities) Location compatibilities.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}

Performers

The name of the sheet is performers.

List of available performers.

The described object:

key required	string [ 1 .. 1024 ] characters Performer's key, unique identifier.
required	Array of objects (performer_shift) [ 1 .. 15001 ] items unique List of working shifts of performer.
own_transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more Transport types: `CAR` - car `TRUCK_1500` - truck with permissible weight 1500 kg `TRUCK_3000` - truck with permissible weight 3000 kg `TRUCK_5000` - truck with permissible weight 5000 kg `TRUCK_10000` - truck with permissible weight 10000 kg `TRUCK_20000` - truck with permissible weight 20000 kg `TRUCK_GARBAGE_1` - truck for transporting garbage (type 1) `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2) `TUK_TUK` - tuk-tuk `BICYCLE` - bicycle `PEDESTRIAN` - pedestrian `PUBLIC_TRANSPORT` - public transport Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.
	object or null (performer_compatibilities) Performer compatibilities.
	object or null (performer_limits) The performer limitations.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}

Transports

The name of the sheet transports.

List of available transport.

The described object:

key required	string [ 1 .. 1024 ] characters Transport key, unique identifier.
required	Array of objects (transport_shift) [ 1 .. 15001 ] items unique List of working shifts of transport.
transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more Transport types: `CAR` - car `TRUCK_1500` - truck with permissible weight 1500 kg `TRUCK_3000` - truck with permissible weight 3000 kg `TRUCK_5000` - truck with permissible weight 5000 kg `TRUCK_10000` - truck with permissible weight 10000 kg `TRUCK_20000` - truck with permissible weight 20000 kg `TRUCK_GARBAGE_1` - truck for transporting garbage (type 1) `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2) `TUK_TUK` - tuk-tuk `BICYCLE` - bicycle `PEDESTRIAN` - pedestrian `PUBLIC_TRANSPORT` - public transport Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.
	Array of objects (box) [ 0 .. 100 ] items unique Default: [] A list of transport compartments that can accommodate the cargo.
	object or null (transport_compatibilities) Transport compatibilities.
	object or null (transport_limits) Transport load limits.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}

Boxes

The name of the sheet is transports.boxes.

List of transport boxes that can accommodate the load. The table is mandatory if there are orders with applications of types of PICKUP and DROP. In the description of the compartments, those fields that describe cargo are required.

The described object:

key required	string [ 1 .. 1024 ] characters Unique compartment key used to identify the cargo placement in compartments.
	object or null (capacity) The compartment capacity, which limits the maximum amount for all `capacity` fields of all the cargoes.
	object or null (box_compatibilities) A transport box compatibilities.
	object or null (box_limits) `max_one_cargo_capacity` - `capacity` fields limitation for one cargo.

{"key": "box01",
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"compatibilities": {"width": 1,
"height": 3.1,
"length": 2.1,
"box_features": [ ]
},
"limits": {"max_one_cargo_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}

Orders

The name of the sheet is orders.

List of orders.

The described object:

key required	string [ 1 .. 1024 ] characters Order key, unique identifier.
required	Array of objects (demand) [ 1 .. 1000 ] items unique Demands list.
	Array of objects (cargo) [ 0 .. 1000 ] items unique Default: [] The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type `WORK`.
	object or null (order_compatibilities) Order compatibilities.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}

Cargos

The name of the sheet is orders.cargos.

List of goods. It may contain one load for DROP, a list for PICKUP, empty for WORK. The table is not obligatory if all applications have the type WORK.

The described object:

key required	string [ 1 .. 1024 ] characters Cargo key, unique identifier.
	object or null (capacity) Cargo additive measures.
	object or null (cargo_compatibilities) Cargo compatibilities.
target_box_key	string or null [ 1 .. 1024 ] characters Default: null The key of the transport compartment in which the cargo is already located. Applicable only for cargo that is in the order with the type `DROP_FROM_BOX`. For other order types, the key must be empty.

{"key": "cargo01",
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"compatibilities": {"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": ["ALL"
],
"box_restrictions": [ ],
"cargo_features": [ ],
"cargo_restrictions": [ ]
},
"target_box_key": "box01"
}

Hardlinks

The name of the sheet is hardlinks.

List of hardlinks.

The described object:

key required	string [ 1 .. 1024 ] characters Hardlink key.
required	Array of objects (hardlink_element) [ 2 .. 1000 ] items List of items in the assignment group.

{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}

Trips

The name of the sheet trips.

List of trips.

The described object:

key required	string [ 1 .. 1024 ] characters Unique trip identifier.
name	string (trip_name) [ 0 .. 64 ] characters Trip name.
required	object (assigned_performer) Performer's shift assigned to the specified time (`shift_time`).
required	object (assigned_transport) Transport's shift assigned to the specified time (`shift_time`).
required	Array of objects (trip_state) [ 0 .. 15001 ] items List of performer's states.
waitlist	Array of strings (trip_waitlist) [ 0 .. 15001 ] items unique [ items [ 1 .. 1024 ] characters ] A list of keys assigned to orders, but not scheduled for a specific time.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}

Facts

The name of the sheet is facts.

List of facts.

The described object:

	Array of objects (order_fact) [ 0 .. 50001 ] items List of order's facts.
	Array of objects (performer_fact) [ 0 .. 15001 ] items List of performers's facts.

{"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
}

Plan settings

The name of the sheet plan_settings.

The described object:

	object (trips_settings) Trip creation settings.
	object (geo_settings) Geodata usage settings.
	object (calculation_settings) Calculation settings.

{"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}

Actualize settings

The name of the sheet is actualize_settings.

The described object:

current_time	string or null<date-time> Current date and time according to the ISO 8601. If not specified, the current time when the request was received by the server is taken.
	object (geo_settings) Geodata usage settings.
	object (calculation_settings) Calculation settings.

{"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}

Replan settings

The name of the sheet is replan_settings.

The described object:

	object (replan_strategy) Replan strategy.
	object (trips_settings) Trip creation settings.
	object (geo_settings) Geodata usage settings.
	object (calculation_settings) Calculation settings.

{"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
}

Plan

Planning - creating trips from orders, performers and transport.

Planning requests can be executed in synchronous and asynchronous mode.

Planning (SYNC)

Sync method for trip planning. Use only for testing and manual plannings. For production use async method.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

New planning request.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
	object (plan_settings) Planning settings.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Request samples

Payload
Python

Content type

application/json

Example

Tokyo

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 35.7048259,
"longitude": 139.7297071
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 35.71861,
"longitude": 139.7190533
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 35.7099049,
"longitude": 139.7265958
}
},
{"key": "location_storage",
"geopoint": {"latitude": 35.7042346,
"longitude": 139.6531996
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance"
},
"geo_settings": {"toll_roads": true,
"traffic_jams": false
}
}
}

Response samples

Content type

application/json

Example

Tokyo

{"tracedata": {"code": "861c8e0a-2651-444e-b426-71cdccc31423",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-01T11:50:15.123Z"
},
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"states": [{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:12:04Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:12:04Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:27:04Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:27:04Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:56Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:40:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
],
"statistics": {"total_statistics": {"cost": 2176.933,
"reward": 3000.3,
"measurements": {"driving_time": "PT52M41S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H27M41S",
"distance": 31306,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"trips_statistics": [{"trip_key": "performer_1_shift",
"statistics": {"cost": 2176.9333333333334,
"reward": 3000.3,
"measurements": {"driving_time": "PT52M41S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H27M41S",
"distance": 31306,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.006,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"demand_ids": ["demand_2_pickup",
"demand_1_pickup"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T04:48:15Z"
}
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"demand_ids": ["demand_1_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT21M45S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT31M45S",
"distance": 8878,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:10:00Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"demand_ids": ["demand_3_work"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT17M4S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT15M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT32M4S",
"distance": 10003,
"time_window": {"from": "2024-02-08T05:10:00Z",
"to": "2024-02-08T05:27:04Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"demand_ids": ["demand_2_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT13M52S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT23M52S",
"distance": 12425,
"time_window": {"from": "2024-02-08T05:27:04Z",
"to": "2024-02-08T05:40:56Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
],
"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 108,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ],
"unplanned_items": {"order_keys": [ ],
"performer_keys": [ ],
"transport_keys": [ ],
"hardlink_keys": [ ]
}
}

Planning (ASYNC)

Trip planning. The result can be obtained using the result method, removing - with delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Launching the asynchronous planning.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
	object (plan_settings) Planning settings.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
id required	string<uuid> (calculation_id) Calculation identifier.

Request samples

Payload

Content type

application/json

Example

Tokyo

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 35.7048259,
"longitude": 139.7297071
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 35.71861,
"longitude": 139.7190533
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 35.7099049,
"longitude": 139.7265958
}
},
{"key": "location_storage",
"geopoint": {"latitude": 35.7042346,
"longitude": 139.6531996
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance"
},
"geo_settings": {"toll_roads": true,
"traffic_jams": false
}
}
}

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"id": "11111111-2222-3333-4444-555555555555"
}

Calculation state

Read calculation state by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
}
}

Cancel calculation

Cancel calculation by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Getting the result

Getting the planning result based on the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

Example

Tokyo

{"tracedata": {"code": "861c8e0a-2651-444e-b426-71cdccc31423",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-01T11:50:15.123Z"
},
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"states": [{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:48:15Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:12:04Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:12:04Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:27:04Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:27:04Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:56Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:40:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
],
"statistics": {"total_statistics": {"cost": 2176.933,
"reward": 3000.3,
"measurements": {"driving_time": "PT52M41S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H27M41S",
"distance": 31306,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"trips_statistics": [{"trip_key": "performer_1_shift",
"statistics": {"cost": 2176.9333333333334,
"reward": 3000.3,
"measurements": {"driving_time": "PT52M41S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H27M41S",
"distance": 31306,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:40:56Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.006,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"demand_ids": ["demand_2_pickup",
"demand_1_pickup"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T04:48:15Z"
}
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"demand_ids": ["demand_1_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT21M45S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT31M45S",
"distance": 8878,
"time_window": {"from": "2024-02-08T04:48:15Z",
"to": "2024-02-08T05:10:00Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"demand_ids": ["demand_3_work"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT17M4S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT15M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT32M4S",
"distance": 10003,
"time_window": {"from": "2024-02-08T05:10:00Z",
"to": "2024-02-08T05:27:04Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"demand_ids": ["demand_2_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT13M52S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT23M52S",
"distance": 12425,
"time_window": {"from": "2024-02-08T05:27:04Z",
"to": "2024-02-08T05:40:56Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
],
"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 108,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ],
"unplanned_items": {"order_keys": [ ],
"performer_keys": [ ],
"transport_keys": [ ],
"hardlink_keys": [ ]
}
}

Result removal

Removal of the planning result by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Data validation

Check data before using.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for validation.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
	object (plan_settings) Planning settings.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.

Request samples

Payload

Content type

application/json

Example

Tokyo

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 35.7048259,
"longitude": 139.7297071
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 35.71861,
"longitude": 139.7190533
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 35.7099049,
"longitude": 139.7265958
}
},
{"key": "location_storage",
"geopoint": {"latitude": 35.7042346,
"longitude": 139.6531996
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance"
},
"geo_settings": {"toll_roads": true,
"traffic_jams": false
}
}
}

Response samples

Content type

application/json

{"tracedata": {"code": "87d0c1a7-375b-412e-9ab8-8f4be24d0456",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_validation",
"time": "2024-02-01T11:50:15.123Z"
},
"warnings": [{"type": "NO_AVAILABLE_TRANSPORT",
"entities": [{"entity_key": "ord0001",
"entity_type": "ORDER"
}
]
}
]
}

Actualize

Trips actualization - updating the planned ETA, taking into account the facts and without changing the order of the roundabout.

Actualization takes place in three stages - verification, application of facts, updating times for failed trip states.

Use data cleaning to get the result of applying facts to the original task.

Accounting for the current time current_time:

Only facts that happened later than current_time are taken into account.
The minimum time of all states of computed trips is taken from current_time.

Accounting facts about the order:

If the order has completed all applications - it is considered completed.
If the order is completed or canceled - it, and the entities to which only it refers, are removed from the data for actualization.
If an order has a PICKUP demand, then the corresponding DROP demand will be converted into a DROP_FROM_BOX demand.
The fact about the order has a higher priority than the facts about the demands for this order (if the facts about the demands contradict the fact about the order, they will not be taken into account).
Only one unclosed fact DEMAND_START is allowed per trip (closed by the fact DEMAND_DONE) - since the performer can only fulfill one request at a time.
If there is a fact about the work on the application, which contradicts the planned order in the specified trip, this application will be completed first, then the trip will continue according to the planned order.

Accounting facts about the performer:

List of facts about the location of the performer in a particular location.
If the trip has started (the time of the fact is later than the scheduled start time of the trip) - the transport is considered to be in the same location as the performer.
If there are several facts, only the latest one in the time field is taken into account.
The location referenced by the fact must be in the locations list.

Accounting for existing trips:

Entities that are not referenced by input trips are removed - locations, performers, transport, hard links, orders, requests, events.
Changes of the performer and transport assigned to the trip cannot be used on other trips.

The trips received as a result of updating contain only those works that remain to be completed.

Actualization (SYNC)

Trips actualization.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

New request for actualization.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"trips": [ ],
"statistics": {"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"trips_statistics": [{"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
]
},
"warnings": [ ],
"unplanned_items": {"order_keys": ["key_01"
],
"order_keys_count": 99,
"performer_keys": ["key_01"
],
"performer_keys_count": 99,
"transport_keys": ["key_01"
],
"transport_keys_count": 99,
"hardlink_keys": ["key_01"
],
"hardlink_keys_count": 99
},
"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
}
}

Data validation

Check data before using.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for validation.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}
],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"external_routing": [ ],
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

Response samples

Content type

application/json

{"tracedata": {"code": "87d0c1a7-375b-412e-9ab8-8f4be24d0456",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_validation",
"time": "2024-02-01T11:50:15.123Z"
},
"warnings": [{"type": "NO_AVAILABLE_TRANSPORT",
"entities": [{"entity_key": "ord0001",
"entity_type": "ORDER"
}
]
}
]
}

Data refine

Refine data before using.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for refine.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}
],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"external_routing": [ ],
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

Replan

Replanning - creation of new trips based on existing trips, taking into account the facts.

Replanning takes place in three stages - checking, applying facts and creating restrictions for planning based on existing trips, planning.

Replanning (SYNC)

Trips replanning - changing existing and creating new trips based on the facts and data about orders, performers and transport.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

New replanning request.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (replan_settings) Replanning settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Request samples

Payload
Python

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "861c8e0a-2651-444e-b426-71cdccc31423",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_replan_calculation",
"time": "2024-02-01T11:50:15.123Z"
},
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
],
"statistics": {"total_statistics": {"cost": 2415.263,
"reward": 3000.3,
"measurements": {"driving_time": "PT1H15M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H50M5S",
"distance": 78117,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"trips_statistics": [{"trip_key": "performer_1_shift",
"statistics": {"cost": 2415.2633333333333,
"reward": 3000.3,
"measurements": {"driving_time": "PT1H15M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H50M5S",
"distance": 78117,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.006,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"demand_ids": ["demand_2_pickup",
"demand_1_pickup"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT0S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
}
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"demand_ids": ["demand_2_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT31M26S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT41M26S",
"distance": 17108,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:10:00Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"demand_ids": ["demand_1_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT20M52S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M52S",
"distance": 26991,
"time_window": {"from": "2024-02-08T05:10:00Z",
"to": "2024-02-08T05:30:52Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"demand_ids": ["demand_3_work"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT22M47S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT15M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT37M47S",
"distance": 34018,
"time_window": {"from": "2024-02-08T05:30:52Z",
"to": "2024-02-08T05:53:39Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
],
"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 108,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ],
"unplanned_items": {"order_keys": [ ],
"performer_keys": [ ],
"transport_keys": [ ],
"hardlink_keys": [ ]
}
}

Replanning (ASYNC)

Trip replanning - changing existing and creating new trips based on the facts and data about orders, performers and transport. The result can be obtained using the result method, removing - with delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Launching the asynchronous replanning.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (replan_settings) Replanning settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
id required	string<uuid> (calculation_id) Calculation identifier.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"id": "11111111-2222-3333-4444-555555555555"
}

Calculation state

Read calculation state by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
}
}

Cancel calculation

Cancel calculation by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Getting the result

Getting the replanning result based on the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Default: [] Schedule of trips assigned to performers.
required	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"tracedata": {"code": "861c8e0a-2651-444e-b426-71cdccc31423",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_replan_calculation",
"time": "2024-02-01T11:50:15.123Z"
},
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
],
"statistics": {"total_statistics": {"cost": 2415.263,
"reward": 3000.3,
"measurements": {"driving_time": "PT1H15M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H50M5S",
"distance": 78117,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0.006,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"trips_statistics": [{"trip_key": "performer_1_shift",
"statistics": {"cost": 2415.2633333333333,
"reward": 3000.3,
"measurements": {"driving_time": "PT1H15M5S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT35M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H50M5S",
"distance": 78117,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"performers_count": 1,
"trips_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"cargo_capacity_ratio": {"mass": 0.01,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.006,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"quality": {"soft_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"keys": [ ],
"count": 0
},
"after": {"keys": [ ],
"count": 0
}
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"demand_ids": ["demand_2_pickup",
"demand_1_pickup"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT0S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
}
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"demand_ids": ["demand_2_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT31M26S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT41M26S",
"distance": 17108,
"time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:10:00Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"demand_ids": ["demand_1_drop"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT20M52S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT10M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M52S",
"distance": 26991,
"time_window": {"from": "2024-02-08T05:10:00Z",
"to": "2024-02-08T05:30:52Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"demand_ids": ["demand_3_work"
],
"stop_time_window": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T04:38:34Z"
},
"measurements": {"driving_time": "PT22M47S",
"waiting_time": "PT0S",
"break_time": "PT0S",
"working_time": "PT15M",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT37M47S",
"distance": 34018,
"time_window": {"from": "2024-02-08T05:30:52Z",
"to": "2024-02-08T05:53:39Z"
}
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
],
"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 108,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ],
"unplanned_items": {"order_keys": [ ],
"performer_keys": [ ],
"transport_keys": [ ],
"hardlink_keys": [ ]
}
}

Result removal

Removal of the planning result by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Data validation

Check data before using.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for validation.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (replan_settings) Replanning settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (entity_warning_list) [ 0 .. 15001 ] items Warning list.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "87d0c1a7-375b-412e-9ab8-8f4be24d0456",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_validation",
"time": "2024-02-01T11:50:15.123Z"
},
"warnings": [{"type": "NO_AVAILABLE_TRANSPORT",
"entities": [{"entity_key": "ord0001",
"entity_type": "ORDER"
}
]
}
]
}

Data refine

Refine data before using.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for refine.

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (replan_settings) Replanning settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/json

required	Array of objects (location) [ 1 .. 15001 ] items unique List of locations used for orders and shifts.
required	Array of objects (order) [ 1 .. 15001 ] items unique Orders list.
required	Array of objects (performer) [ 1 .. 15001 ] items unique Available performers list.
required	Array of objects (transport) [ 1 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Default: [] Assignments list.
required	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (replan_settings) Replanning settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [ ],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"external_routing": [ ],
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

Response samples

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [ ],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"external_routing": [ ],
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

Convert

Data conversion.

JSON >> XLSX

Used for conversion of input and output data to the VRt.Universal XLSX format.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Conversion request to the XLSX.

	Array of objects (location) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order) [ 0 .. 15001 ] items unique Orders list.
	Array of objects (performer) [ 0 .. 15001 ] items unique Available performers list.
	Array of objects (transport) [ 0 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: application/octet-stream

string<byte> (file_xlsx)

File with data in XLSX format.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

XLSX >> JSON

Used for data conversion from the VRt.Universal XLSX format to the VRt.Universal JSON format.

Authorizations:

ApiKeyAuth

Request Body schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
required

Conversion request to the JSON format.

string<byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json

	Array of objects (location) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order) [ 0 .. 15001 ] items unique Orders list.
	Array of objects (performer) [ 0 .. 15001 ] items unique Available performers list.
	Array of objects (transport) [ 0 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Response samples

Content type

application/json

{"locations": [{"key": "location01",
"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"arrival_duration": "P1Y1M1DT2H12M34.3S",
"departure_duration": "P1Y1M1DT2H12M34.3S",
"work_windows": [ ],
"compatibilities": {"transport_restrictions": [ ]
},
"attributes": [ ]
}
],
"orders": [{"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location01",
"duration": "P1Y1M1DT2H12M34.3S",
"reward": 199.9,
"hard_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"soft_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
}
],
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": {"order_features": [ ],
"order_restrictions": [ ],
"performer_restrictions": [ ],
"performer_blacklist": [ ]
},
"attributes": [ ]
}
],
"performers": [{"key": "performer0001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"max_locations": 15,
"max_stops": 15,
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": "PT24H",
"cost_per_unit": 0.001
}
],
"max_penalty_cost": 2000
},
"work_and_rest_rules": {"first_break": {"max_work_duration_sum": "P1Y1M1DT2H12M34.3S",
"duration": "P1Y1M1DT2H12M34.3S"
}
},
"attributes": [ ]
}
],
"own_transport_type": "CAR",
"compatibilities": {"performer_features": [ ],
"performer_features_lifetimes": [ ],
"transport_restrictions": [ ]
},
"limits": {"max_work_shifts": 3
},
"attributes": [ ]
}
],
"transports": [{"key": "transport001",
"shifts": [{"key": "shift01",
"availability_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"working_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"start_location_key": "start_location01",
"finish_location_key": "finish_location01",
"tariff": {"cost_per_shift": 2000,
"constraints": [{"stage_length": 100000000,
"cost_per_unit": 0.001
}
],
"transportation_cost": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_penalty_cost": 2000
},
"attributes": [ ]
}
],
"transport_type": "CAR",
"boxes": [ ],
"compatibilities": {"transport_features": [ ],
"transport_features_lifetimes": [ ],
"performer_restrictions": [ ]
},
"limits": {"max_boxes": 2,
"max_capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"attributes": [ ]
}
],
"hardlinks": [{"key": "group01",
"links": [{"type": "ORDER",
"entity_key": "ord0001"
},
{"type": "ORDER",
"entity_key": "ord0001"
}
]
}
],
"trips": [{"key": "631988f0-9e27-11ed-a8fc-0242ac120002",
"name": "1-ABC",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"states": [{"time": "2024-02-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location01",
"flags": [ ],
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"attributes": [ ]
}
],
"facts": {"order_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"type": "ORDER_DONE",
"order_key": "order_01",
"demand_key": "order_01_demand_01"
}
],
"performer_facts": [{"key": "fact_01",
"time": "2024-02-21T09:30:00+03:00",
"performer_key": "performer_01",
"location_key": "location01"
}
]
},
"statistics": {"total_statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"trips_statistics": [{"trip_key": "trip01",
"statistics": {"cost": 1231.1,
"reward": 2343.3,
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"cargo_capacity_ratio": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"max_transport_load": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
},
"quality": {"soft_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
},
"hard_time_window_violations": {"before": {"keys": ["obj1"
],
"count": 1700
},
"after": {"keys": ["obj1"
],
"count": 1700
}
}
}
},
"stop_statistics": [{"location_key": "location01",
"demand_ids": ["demand01"
],
"stop_time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
},
"measurements": {"driving_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"break_time": "P1Y1M1DT2H12M34.3S",
"working_time": "P1Y1M1DT2H12M34.3S",
"arriving_time": "P1Y1M1DT2H12M34.3S",
"departure_time": "P1Y1M1DT2H12M34.3S",
"total_time": "P1Y1M1DT2H12M34.3S",
"distance": 5200,
"time_window": {"from": "2024-02-21T09:30:00+03:00",
"to": "2024-02-21T19:45:00Z"
}
},
"upload": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"download": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
],
"total_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3
}
}
}
]
},
"external_routing": [ ],
"plan_settings": {"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
},
"trips_settings": {"configuration": "optimize_distance",
"trip_start_time_strategy": "LOWEST_COST",
"assumptions": {"transport_factor": [ ],
"capacity_factor": [ ],
"demands_extra_duration": [ ],
"feature_lifetimes": [ ],
"disable_compatibility": true,
"disable_capacity": true,
"same_order_time_window": true,
"expand_shift_time_window": true
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"actualize_settings": {"current_time": "2024-02-21T09:30:00+03:00",
"geo_settings": {"geo_provider": "OSRM",
"toll_roads": false,
"ferry_crossing": false,
"traffic_jams": false,
"flight_distance": true,
"restricted_zones": ["ART_MOSCOW_MKAD_CARGO_FRAME"
]
},
"calculation_settings": {"max_calculation_time": "PT4M30S",
"max_waiting_time": "PT2H",
"result_ttl": "PT4M30S",
"result_timezone": 3,
"treat_warnings_as_errors": true,
"precision": 3
}
},
"dataset_name": "custom_dataset_one"
}

JSON >> THRIFT

Used for conversion of input data to the THRIFT format.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Conversion request to the THRIFT.

	Array of objects (location) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order) [ 0 .. 15001 ] items unique Orders list.
	Array of objects (performer) [ 0 .. 15001 ] items unique Available performers list.
	Array of objects (transport) [ 0 .. 15001 ] items unique Available transports list.
	Array of objects (hardlink) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip) [ 0 .. 15001 ] items unique Existing routes.
	object (facts) Events that have taken place.
	object or null (plan_statistics) General statistics on planned trips.
	Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 1000 ] characters The name of the dataset. A technical field that does not affect planning.

Responses

Response Schema: text/plain

string (file_text)

File with data in text format.

Request samples

Payload

Content type

application/json

{"locations": [{"key": "location_client_1",
"geopoint": {"latitude": 55.713699,
"longitude": 37.621839
}
},
{"key": "location_client_2",
"geopoint": {"latitude": 55.630721,
"longitude": 37.62493
}
},
{"key": "location_client_3",
"geopoint": {"latitude": 55.722801,
"longitude": 37.674984
}
},
{"key": "location_storage",
"geopoint": {"latitude": 55.685853,
"longitude": 37.43181
}
}
],
"orders": [{"key": "order_1",
"demands": [{"key": "demand_1_drop",
"demand_type": "DROP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_drop_event",
"location_key": "location_client_1",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_1_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_1_cargos"
],
"possible_events": [{"key": "demand_1_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_1_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_2",
"demands": [{"key": "demand_2_drop",
"demand_type": "DROP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_drop_event",
"location_key": "location_client_2",
"duration": "PT10M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
},
{"key": "demand_2_pickup",
"demand_type": "PICKUP",
"target_cargos": ["order_2_cargos"
],
"possible_events": [{"key": "demand_2_pickup_event",
"location_key": "location_storage",
"duration": "P0D",
"reward": 0,
"hard_time_window": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
}
}
]
}
],
"cargos": [{"key": "order_2_cargos",
"capacity": {"mass": 1
}
}
]
},
{"key": "order_3",
"demands": [{"key": "demand_3_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_3_work_event",
"location_key": "location_client_3",
"duration": "PT15M",
"hard_time_window": {"from": "2024-02-08T05:00:00+00:00",
"to": "2024-02-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": "PT10H",
"cost_per_unit": 1
}
]
}
}
]
}
],
"transports": [{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"working_time": {"from": "2024-02-07T21:00:00+00:00",
"to": "2024-02-08T20:59:59+00:00"
},
"tariff": {"cost_per_shift": 1000,
"constraints": [{"stage_length": 1000000,
"cost_per_unit": 0.01
}
]
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}
],
"trips": [{"key": "performer_1_shift",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2024-02-08T04:38:34Z",
"to": "2024-02-08T05:53:39Z"
}
},
"states": [{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:20:52Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_placements": [{"box_key": "box_1",
"cargo_key": "order_1_cargos"
}
],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:38:39Z",
"flags": ["ON_DEMAND",
"INSIDE_EVENT_HARD_WINDOW",
"INSIDE_LOCATION_WINDOW",
"INSIDE_LOCATION",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
},
{"time": "2024-02-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_placements": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"code": "215b87e0-4407-4e0f-b2cc-8540f8f0cad7",
"client": "veeroute_|_example",
"server": "edge",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json

health

required

number<double> [ 0 .. 1 ]

Current health.

Response samples

Content type

application/json

{"health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer<int32> [ 1 .. 100 ] Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer<int32> [ 0 .. 111 ] Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Build version. Contains backwards compatible bug fixes and docs update.

Response samples

Content type

application/json

{"major": 4,
"minor": 4,
"build": "1754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

Content type

application/json

{"resource_id": "resource_id",
"detail": {"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
}
}

VRt.Universal [UV] (6.20.2289)

Description

Features

Restrictions support

Compatibilities

Cargo placement

Trip model

An example of a route with multiple states at each point in time

Planning configuration

Data validation

1. Schema check

2. Check for logical errors that prevent planning from continuing

3. Check for logical errors that prevent planning from continuing

4. Checks in the planning process

Entity relationship diagram

Xlsx

Locations

Performers

Transports

Boxes

Orders

Cargos

Hardlinks

Trips

Facts

Plan settings

Actualize settings

Replan settings

Plan

Planning (SYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Planning (ASYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Calculation state

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Cancel calculation

Authorizations:

path Parameters

Responses

Response samples

Getting the result

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Result removal

Authorizations:

path Parameters

Responses

Response samples

Data validation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Actualize

Actualization (SYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required