VRt.Monitor [MT] (7.39.3350)

Veeroute Support Team: support@veeroute.com License: Proprietary Terms of Service

Programming interface for the Veeroute Monitor tool.

Description

The server side of Veeroute Monitor.

Main responsibilities:

storage and processing of waves (input data for planning and trips with their execution results)
recalculation of trips during their execution
creation and storage of statistics on trip execution results
creation and storage of trip execution forecasts

Trip state model

State code	Description	Expected action
`FREE`	Trip created, crew not assigned	Operator will assign a crew
`ASSIGNED`	Crew assigned	Operator will send the assignment to the crew
`SENT`	Assignment sent to the crew	Crew will confirm receipt
`RECEIVED`	Crew received the trip (fact `TRIP_RECEIVED`)	Crew will accept or reject the trip
`CONFIRMED`	Crew agreed to perform the trip (fact `TRIP_CONFIRMED`)	Crew will start performing the trip
`REJECTED`	Crew refused to perform the trip (fact `TRIP_REJECTED`)	Operator will assign a new crew or cancel
`EXECUTING`	Crew is performing the trip (fact `TRIP_EXECUTING`)	Crew will finish all tasks
`FINISHED`	Trip is finished — no work is left for the trip	This is a terminal status
`CANCELLED`	Trip cancelled by the operator	This is a terminal status

State transitions:

Operator: FREE → ASSIGNED → SENT

Crew: RECEIVED → CONFIRMED / REJECTED → EXECUTING

Conditions: EXECUTING → FINISHED / CANCELLED

Entity diagram

erd

Explorer

Virtual filesystem management.

Create folder

Create new folder.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to create a folder. In the parent_key field, you must specify the key of the folder in which the new folder will be created. If parent_key is not specified, the folder is created in the root.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-09-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New folder key.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-09-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Getting a filesystem

Getting a filesystem.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Parent folder key, if not specified - a list of root folders is returned
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those folders that contain a substring from the filter are returned: in folder name in folder comment
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more Example: sort_field=CREATION_DATE The name of the column in the table with folders.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	object (folder) Folder is an element of a virtual file system.
required	Array of objects (folder) [ 0 .. 2001 ] items List of folders.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

Update folder

Rename and move folder.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-09-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (folder) Folder is an element of a virtual file system.
required	Array of objects (folder) [ 0 .. 2001 ] items List of folders.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-09-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

Folder removal

Folder removal by key.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder specification

Getting a folder specification.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-09-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Response samples

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-09-21T19:45:00Z",
"attributes": [ ]
}

Folder path

Folder path.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json

required

Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type

application/json

{"folders": [{"key": "11111111-2222-3333-4444-555555555555",
"type": "FOLDER",
"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"attributes": [ ],
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"creation_date": "2026-09-21T19:45:00Z",
"expiration_date": "2026-09-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Create folders (batch)

Create new folder (batch).

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to create a group of folders from the root of the virtual file system.

If any folder in the path already exists - it will not be created again.

The method returns the key of the last folder, even if no folders were created.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Last folder key.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Folders removal (batch)

Batch delete folders.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of folder keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder key

Getting a folder key by path.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If any folder in the path not exists - 404 will be returned.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Last folder key.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

File key

Getting a file key by path.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If in the folder multiple files with the same name - the last modified will be returned. If any folder or file in the path not exists - 404 will be returned.

folder_names required	Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ] Example: ["folder_1"] List of folder names from the root of the virtual filesystem.
file_name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

File key.

Request samples

Payload

Content type

application/json

{"folder_names": [ ],
"file_name": "file_1"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Files removal (batch)

Batch delete files.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of file's keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Enable sharing (batch)

Batch enable sharing.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of file keys for which sharing should be enabled.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Disable sharing (batch)

Batch disable sharing.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of file keys for which sharing should be disabled.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Filesystem counters

Getting a virtual filesystem counters.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required	object (folder_counters) Current number of available folders/files.
required	object (folder_counters) Max number of available folders/files.

Response samples

Content type

application/json

{"current": {"folders_count": 12,
"files_count": 16
},
"max": {"folders_count": 12,
"files_count": 16
}
}

Backups

Bulk data export and import.

Folder export

Export folder with files.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder import

Import folder with files. The folder should not be of type ROOT and should be empty.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/octet-stream
required

Data (ZIP).

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Crews

A crew combines:

a real performer (or a group of performers) that performs orders
a transport that is used to perform orders
mobile devices to which trips are sent and from which facts about the execution process are received

For each crew an account is automatically created for authorization. A crew can connect to the server with a single account from multiple devices simultaneously.

All crews are bound to a company and are available for reading depending on the role model:

USER: all crews of the company whose owner_username matches the user's username are available
COMPANYOWNER: all crews of the company across all users are available
OVERLORD: all crews of all companies are available
for other roles, reading crews is not available

Creating and modifying crews is available only for the CREWMANAGER role.

A crew is assigned to a trip by a logistician via the web interface or by an integration module via API using the create_deal method.

At any single moment in time a crew can be performing only one trip from one wave, while the number of trips assigned to it can be more than one.

Crew creation

New crew creation.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Crew creation request.

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" New password.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
account_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that uses the crew.
owner_company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" The key of the company that owns the crew.
owner_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that owns the crew.
required	object (crew_status) Crew status.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.
	Array of objects (crew_device_list) [ 0 .. 100 ] items List of device.
edit_date required	string <date-time> Example: "2026-09-21T19:45:00Z" Last edit date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"password": "long_strong_password",
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
}
}

Response samples

Content type

application/json

{"key": "mega_crew",
"account_username": "username_for_login",
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"status": {"online": true,
"deals": [ ]
},
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
},
"devices": [{"key": "key01",
"app_version": "7.51",
"os_version": "15.0",
"manufacturer": "Samsung",
"model": "S25"
}
],
"edit_date": "2026-09-21T19:45:00Z"
}

Crew update

Updating the crew information.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Crew update request.

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" New password.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
account_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that uses the crew.
owner_company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" The key of the company that owns the crew.
owner_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that owns the crew.
required	object (crew_status) Crew status.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.
	Array of objects (crew_device_list) [ 0 .. 100 ] items List of device.
edit_date required	string <date-time> Example: "2026-09-21T19:45:00Z" Last edit date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"password": "long_strong_password",
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
}
}

Response samples

Content type

application/json

{"key": "mega_crew",
"account_username": "username_for_login",
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"status": {"online": true,
"deals": [ ]
},
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
},
"devices": [{"key": "key01",
"app_version": "7.51",
"os_version": "15.0",
"manufacturer": "Samsung",
"model": "S25"
}
],
"edit_date": "2026-09-21T19:45:00Z"
}

Getting crew information

Getting crew information by key.

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

string (crew_key) [ 3 .. 256 ] characters \w+

Example: mega_crew

Parameter (path) with crew key.

Responses

Response Schema: application/json

required	object (crew) Crew.
	object (table_crew_fields) Crew fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"crew": {"key": "mega_crew",
"account_username": "username_for_login",
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"status": {"online": true,
"deals": [ ]
},
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
},
"devices": [{"key": "key01",
"app_version": "7.51",
"os_version": "15.0",
"manufacturer": "Samsung",
"model": "S25"
}
],
"edit_date": "2026-09-21T19:45:00Z"
},
"fields": {"essence_type": "CREW",
"essence_key": "key01",
"account_username": "AAA",
"owner_username": "AAA",
"owner_company_key": "AAA",
"composition_phone": "AAA",
"status_online": true
},
"linked_essences": [ ]
}

Delete crew

Delete a crew.

A crew cannot be deleted if a trip is assigned to it (i.e. a deal exists).

When a crew is deleted, the account associated with it is also deleted, along with all audit actions and all statistics for that account.

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

string (crew_key) [ 3 .. 256 ] characters \w+

Example: mega_crew

Parameter (path) with crew key.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Reading crews (table)

Getting a list of crews.

Authorizations:

ApiKeyAuth

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_crew_column_type) Default: "ESSENCE_KEY" Enum: "ESSENCE_KEY" "ACCOUNT_USERNAME" "OWNER_USERNAME" … 3 more Example: sort_field=OWNER_COMPANY_KEY Crew table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 0 .. 2001 ] items A list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_type": "CREW",
"essence_key": "key01",
"account_username": "AAA",
"owner_username": "AAA",
"owner_company_key": "AAA",
"composition_phone": "AAA",
"status_online": true
},
"elements": [{"essence_type": "CREW",
"essence_key": "key01",
"account_username": "AAA",
"owner_username": "AAA",
"owner_company_key": "AAA",
"composition_phone": "AAA",
"status_online": true
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Crews removal (batch)

Batch crews delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to delete crews.

Array ([ 0 .. 2001 ] items)

string (crew_key) [ 3 .. 256 ] characters \w+

Unique crew key.

Responses

Request samples

Payload

Content type

application/json

["mega_crew"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Crew trackpoints

Getting a crew trackpoints.

Authorizations:

ApiKeyAuth

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (crew_trackpoint) [ 0 .. 2001 ] items A list of points.
required	object (table_list_counters) Counters by list of entities.
required	object (table_list_counters_detail) Counters by list of points.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"trackpoints": [{"trackpoint": {"latitude": 55.692789,
"longitude": 37.554554,
"time": "2026-09-21T09:30:00+03:00"
},
"crew_key": "mega_crew",
"online": true
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"trackpoints_counters": {"total": 1
}
}

Import crews (JSON)

Importing new data from JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data (JSON).

Array ([ 0 .. 15001 ] items)

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" New password.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.

Responses

Request samples

Payload

Content type

application/json

[{"key": "mega_crew",
"password": "long_strong_password",
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
}
}
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2026-09-28T17:13:27.945583194Z"
},
"message": "logical error detail",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Import crews (XLSX)

Importing new data from XLSX file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:

ApiKeyAuth

Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2026-09-28T17:13:27.945583194Z"
},
"message": "logical error detail",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Export crews (JSON)

Exporting crews to a JSON file.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

Array ([ 0 .. 15001 ] items)

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.

Response samples

Content type

application/json

[{"key": "mega_crew",
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
}
}
]

Export crews (XLSX)

Exporting crews to a XLSX file.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2026-09-28T17:13:27.945583194Z"
},
"message": "logical error detail",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "order_1",
"entity_type": "ORDER"
}
]
}
],
"warnings": [ ]
}

Self crew information APP

Getting crew information by login. Available only for users with CREW role.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
account_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that uses the crew.
owner_company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" The key of the company that owns the crew.
owner_username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" The username of the account that owns the crew.
required	object (crew_status) Crew status.
	object (crew_composition) Detailed description of the crew composition — used by the automatic process of assigning crews to trips.
	Array of objects (crew_device_list) [ 0 .. 100 ] items List of device.
edit_date required	string <date-time> Example: "2026-09-21T19:45:00Z" Last edit date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "mega_crew",
"account_username": "username_for_login",
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"status": {"online": true,
"deals": [ ]
},
"composition": {"name": "X1-ABC",
"phone": "+71112223333",
"attributes": [ ],
"performer_compatibilities": null,
"performer_limits": null,
"transport_type": "CAR",
"transport_boxes": [ ],
"transport_compatibilities": null,
"transport_limits": null
},
"devices": [{"key": "key01",
"app_version": "7.51",
"os_version": "15.0",
"manufacturer": "Samsung",
"model": "S25"
}
],
"edit_date": "2026-09-21T19:45:00Z"
}

Update device APP

Updating information about your device (by login). Available only for users with CREW role.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to update information about your device.

key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: "key01" Unique device identifier.
app_version	string or null [ 2 .. 64 ] characters Default: null Example: "7.51" Application version.
os_version	string or null [ 2 .. 64 ] characters Default: null Example: "15.0" Operation system version.
manufacturer	string or null [ 2 .. 64 ] characters Default: null Example: "Samsung" Mobile device manufacturer.
model	string or null [ 2 .. 64 ] characters Default: null Example: "S25" Mobile device model.

Responses

Request samples

Payload

Content type

application/json

{"key": "key01",
"app_version": "7.51",
"os_version": "15.0",
"manufacturer": "Samsung",
"model": "S25"
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Update coordinates APP

Updating information about your location (by login). Available only for users with CREW role.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to update information about your location.

required	object (trackpoint) A geographic point with a time reference.
crew_key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
online	boolean Default: false Example: "true" Indicates the presence of a active connection.

Responses

Request samples

Payload

Content type

application/json

{"trackpoint": {"latitude": 55.692789,
"longitude": 37.554554,
"time": "2026-09-21T09:30:00+03:00"
},
"crew_key": "mega_crew",
"online": true
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Deals

Deal management.

A deal is the assignment of a crew to a specific trip from a specific wave.

The object is temporary and is automatically removed after the crew finishes the trip.

Deal creation

New deal creation.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Deal creation request.

crew_key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key.
wave_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
trip_key required	string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Unique trip identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier.
required	object (deal_specification) Deal description.

Request samples

Payload

Content type

application/json

{"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Deal update

Updating the deal information.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Deal update request.

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier.
required	object (deal_specification) Deal description.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier.
required	object (deal_specification) Deal description.

Request samples

Payload

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Getting deal information

Getting deal information by key.

Authorizations:

ApiKeyAuth

path Parameters

deal_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Unique deal identifier.
required	object (deal_specification) Deal description.

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Deal removal

Removing a deal by key.

Authorizations:

ApiKeyAuth

path Parameters

deal_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Deals removal (batch)

Batch deals delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to delete deals.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Self crew trips APP

Getting a crew trips by login. Available only for users with CREW role.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

Array ([ 0 .. 30 ] items)

required	object (deal) Deal - the assignment of a team to a specific trip from a specific wave.
	trip (object) or nullable (null) Default: null Trip.
	trip_status (string) or nullable (null) Default: null Status.
	trip_statistics (object) or nullable (null) Default: null Statistics.

Response samples

Content type

application/json

[{"deal": {"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
},
"trip": null,
"trip_status": null,
"trip_statistics": null
}
]

Waves

Management of planning and execution waves.

A wave consists of:

Input data for the calculation (orders, performers, transport, settings)
Calculation results (trips, statistics)
Execution results (facts)

Create wave

Create new wave.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

wave create request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New wave key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Reading wave

Getting wave information by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Wave update

Rename \ move wave.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

wave specification update request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Wave removal

Wave removal by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Waves list (table)

Getting a table with wave.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Folder key, unique identifier.
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those files are returned whose name or description contains a substring from the filter. If the filter is empty, all files in the folder are returned. The results are sorted by editing time.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "SHARING" "EDIT_DATE" … 4 more Example: sort_field=SPECIFICATION_FOLDER_KEY Wave table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items A list of waves.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "wave1",
"specification_folder_key": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Wave search

Wave global search.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Filter for searching by text fields - only those configurations are returned whose name or description contains a substring from the filter. If the filter is empty, an empty list is returned. By default the results are sorted by editing time.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "SHARING" "EDIT_DATE" … 4 more Example: sort_field=SPECIFICATION_FOLDER_KEY Wave table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items A list of waves.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"essences": [{"fields": {"essence_key": "wave1",
"specification_folder_key": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Wave duplicate

Wave duplicate.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

wave duplicate request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Duplicated wave key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Wave path

Wave path.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

required

Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type

application/json

{"folders": [{"key": "11111111-2222-3333-4444-555555555555",
"type": "FOLDER",
"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"attributes": [ ],
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"creation_date": "2026-09-21T19:45:00Z",
"expiration_date": "2026-09-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Import (XLSX)

Importing new data from an XLSX file. If an entity is already present (determined by its key), it is updated. If not, a new one is created. The data time zone is taken from the XLSX file.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Import (JSON)

Importing new data from VRt.Universal JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data (JSON).

	Array of objects (location_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations.
	plan_statistics (object) or nullable (null) Default: null General statistics on the calculation result.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T04:38:34Z",
"to": "2026-09-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-09-08T04:38:34Z",
"to": "2026-09-08T05:53:39Z"
}
},
"states": [{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Import from Studio

Importing new data from a VRt.Universal JSON file by experiment key from VRt.Studio. If the entity is already present in the wave (determined by its key), it is updated, if not, a new one is created.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
studio_experiment_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Experiment key from VRt.Studio, unique identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Export (XLSX)

Export (XLSX).

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

timezone

integer <int32> (timezone) [ -12 .. 12 ]

Default: 0

Example: timezone=3

Target time zone.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Export (JSON)

Export data to VRt.Universal JSON file.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

	Array of objects (location_list) [ 0 .. 15001 ] items unique List of locations used for orders and shifts.
	Array of objects (order_list) [ 0 .. 15001 ] items unique List of orders that need to be completed.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Available performers list. The performer fulfills orders using transport.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Available transports list. Transport is used by the trip performer to fulfill orders.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Assignments list.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Trip list. A fact is an event that has occurred that affects further trip operations.
	plan_statistics (object) or nullable (null) Default: null General statistics on the calculation result.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account.
	object (plan_settings) Planning settings.
	object (replan_settings) Replanning settings.
	object (actualize_settings) Actualize settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Response samples

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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
}
],
"performers": [{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-07T21:00:00+00:00",
"to": "2026-09-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": "2026-09-08T04:38:34Z",
"to": "2026-09-08T05:53:39Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-09-08T04:38:34Z",
"to": "2026-09-08T05:53:39Z"
}
},
"states": [{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T04:38:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
},
{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:20:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "ADD"
}
],
"attributes": [ ]
},
{"time": "2026-09-08T05:30:52Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:30:52Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:38:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-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_actions": [ ],
"attributes": [ ]
},
{"time": "2026-09-08T05:53:39Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"attributes": [ ]
}
],
"waitlist": [ ],
"attributes": [ ]
}
]
}

Run validation

Validation run.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	wave_autopilot (object) or nullable (null) Default: null Current calculation state.
	experiment_check (object) or nullable (null) Default: null Result of checking the dataset.
sharing	boolean (file_sharing) Example: "false" File sharing flag.
edit_date required	string <date-time> (file_edit_date) Example: "2026-09-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-09-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
"specification": {"name": "new wave 3000",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091"
},
"settings": {"plan_settings": {"trips_settings": {"configuration": "default",
"assumptions": {"disable_compatibility": false,
"disable_capacity": false,
"same_order_time_window": false,
"expand_shift_time_window": false
},
"penalties": {"compatibilities": [ ]
}
},
"geo_settings": {"geo_provider": "VRT",
"toll_roads": true,
"ferry_crossing": true,
"traffic_jams": true,
"flight_distance": false
},
"calculation_settings": {"max_calculation_time": "PT20M",
"max_waiting_time": "PT30M",
"result_ttl": "PT20M",
"result_timezone": 0,
"treat_warnings_as_errors": false,
"precision": 2
}
},
"actualize_settings": {"current_time": "2026-09-07T22:30:00Z",
"max_delay_duration": "PT1H"
},
"replan_settings": {"replan_strategy": {"reorder": true,
"plan_new_orders": true,
"create_new_trips": true
}
}
},
"statistics": {"indicators": ["data_statistics_hardlinks",
"data_statistics_locations",
"data_statistics_orders",
"data_statistics_performers",
"data_statistics_transports",
"data_statistics_trips",
"data_statistics_facts",
"total_statistics_max_transport_load_capacity_a",
"total_statistics_max_transport_load_capacity_b",
"total_statistics_max_transport_load_capacity_c",
"total_statistics_max_transport_load_mass",
"total_statistics_max_transport_load_volume",
"total_statistics_cargo_capacity_ratio_capacity_a",
"total_statistics_cargo_capacity_ratio_capacity_b",
"total_statistics_cargo_capacity_ratio_capacity_c",
"total_statistics_cargo_capacity_ratio_mass",
"total_statistics_cargo_capacity_ratio_volume",
"total_statistics_cost",
"total_statistics_measurements_arriving_time",
"total_statistics_measurements_departure_time",
"total_statistics_measurements_distance",
"total_statistics_measurements_driving_time",
"total_statistics_measurements_time_window_from",
"total_statistics_measurements_time_window_to",
"total_statistics_measurements_total_time",
"total_statistics_measurements_waiting_time",
"total_statistics_measurements_working_time",
"total_statistics_orders_count",
"total_statistics_performers_count",
"total_statistics_plan_orders_count",
"quality_hard_time_window_violations_after_count",
"quality_hard_time_window_violations_before_count",
"quality_soft_time_window_violations_after_count",
"quality_soft_time_window_violations_before_count",
"total_statistics_reward",
"total_statistics_waitlist_orders_count"
],
"total_statistics": {"profit": 1,
"cost": 0,
"reward": 0,
"measurements": {"driving_time": "P0D",
"waiting_time": "P0D",
"break_time": "P0D",
"rest_time": "PT0S",
"working_time": "P0D",
"arriving_time": "P0D",
"departure_time": "P0D",
"total_time": "P0D",
"distance": 0,
"time_window": {"from": "2026-09-15T13:56:07.697Z",
"to": "2026-09-15T13:56:07.697Z"
}
},
"performers_count": 0,
"trips_count": 0,
"orders_count": 0,
"plan_orders_count": 0,
"waitlist_orders_count": 0,
"stops_count": 1,
"locations_count": 1,
"average_speed": 45.2,
"round_trips_count": 1,
"cargo_capacity_sum": {"mass": 1.9,
"volume": 2,
"capacity_a": 3,
"capacity_b": 1,
"capacity_c": 1
},
"cargo_capacity_ratio": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"max_transport_load": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"quality": {"locations_limits_penalty": 0,
"soft_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
},
"hard_time_window_violations": {"before": {"demand_keys": [ ],
"count": 0
},
"after": {"demand_keys": [ ],
"count": 0
}
}
},
"task_statistics": {"planning_horizon": {"from": "2026-09-21T09:30:00+03:00",
"to": "2026-09-21T19:45:00Z"
}
},
"data_statistics": {"locations": 958,
"orders": 1000,
"performers": 1000,
"transports": 1000,
"hardlinks": 0,
"trips": 0,
"facts": 1,
"external_routing": false
}
},
"edit_date": "2026-09-15T13:56:07.728Z",
"creation_date": "2026-09-15T13:56:07.728Z"
}

Locations

Locations management.

Create location

Create location.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key required	string [ 1 .. 1024 ] characters Example: "location_01" 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... Example: "PT1H45M" 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... Example: "PT1H45M" Time to leave the location according to ISO 8601 duration.
	Array of objects (location_timetable) [ 0 .. 30 ] items Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.
	location_compatibilities (object) or nullable (null) Default: null Compatibilities of the location with transport.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
address	string or null [ 1 .. 1024 ] characters Default: null Example: "24th Line V.O., 15/2, building A, St. Petersburg, 199106" Full location address.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	location_statistics (object) or nullable (null) Default: null Statistics for a specific trip.
	object (table_location_fields) Location fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
}

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Update location

Updating the location by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key required	string [ 1 .. 1024 ] characters Example: "location_01" 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... Example: "PT1H45M" 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... Example: "PT1H45M" Time to leave the location according to ISO 8601 duration.
	Array of objects (location_timetable) [ 0 .. 30 ] items Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.
	location_compatibilities (object) or nullable (null) Default: null Compatibilities of the location with transport.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
address	string or null [ 1 .. 1024 ] characters Default: null Example: "24th Line V.O., 15/2, building A, St. Petersburg, 199106" Full location address.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	location_statistics (object) or nullable (null) Default: null Statistics for a specific trip.
	object (table_location_fields) Location fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
}

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Read location

Getting location information by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (location) Location - unique geographical location of the object with accessibility parameters.
	location_statistics (object) or nullable (null) Default: null Statistics for a specific trip.
	object (table_location_fields) Location fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"location": {"key": "performer_1_location",
"geopoint": {"latitude": 55.720292,
"longitude": 37.625994
}
},
"fields": {"essence_key": "performer_1_location",
"enabled": true
}
}

Remove location

Removing a location by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Locations list

Getting a locations list.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_location_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more Example: sort_field=ESSENCE_KEY Locations table column name.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 The name of the additional column in the table.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_location) [ 0 .. 2001 ] items Locations list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Delete locations (batch)

Removing locations from the file.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete locations.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Location geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_location_geopoint) [ 0 .. 2001 ] items A list of points.
required	object (table_list_counters) Counters by list of entities.
required	object (table_list_counters_detail) Counters by list of points.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"location_key": "location_01",
"name": "X1-ABC",
"icon_name": "location_whs",
"linked": true
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Location metrics

Calculate general metrics for selected locations.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] A list of keys.
	Array of objects (table_location_filter) [ 0 .. 50 ] items Default: [] A list of filters.

Responses

Response Schema: application/json

	object (table_location_fields) Total values for fields of types int, double, duration.
	object (table_location_fields) Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "LOCATION",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "LOCATION",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Orders

Orders management.

Create order

New order creation.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key required	string [ 1 .. 1024 ] characters Example: "order01" Order key, unique identifier.
required	Array of objects (demand) [ 1 .. 1000 ] items unique Demands list.
	Array of objects (cargo_list) [ 0 .. 1000 ] items unique 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`.
	order_compatibilities (object) or nullable (null) Default: null Compatibilities of the order with performers and other orders.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (order) The order for delivery/transportation, contains a list of demands.
	object (table_order_fields) Order and demand fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
}

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Update order

Updating the essence by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key required	string [ 1 .. 1024 ] characters Example: "order01" Order key, unique identifier.
required	Array of objects (demand) [ 1 .. 1000 ] items unique Demands list.
	Array of objects (cargo_list) [ 0 .. 1000 ] items unique 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`.
	order_compatibilities (object) or nullable (null) Default: null Compatibilities of the order with performers and other orders.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (order) The order for delivery/transportation, contains a list of demands.
	object (table_order_fields) Order and demand fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
}

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Reading order

Getting order information by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (order) The order for delivery/transportation, contains a list of demands.
	object (table_order_fields) Order and demand fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"order": {"key": "order_1",
"demands": [{"key": "demand_work",
"demand_type": "WORK",
"possible_events": [{"key": "demand_work_event",
"location_key": "location_client",
"duration": "PT15M",
"hard_time_window": {"from": "2026-09-08T05:00:00+00:00",
"to": "2026-09-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Deleting one order

Removing a essence by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

List orders

Getting a orders list.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_order_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more Example: sort_field=ESSENCE_KEY Order table column name.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 The name of the additional column in the table.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Essence filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_order) [ 0 .. 15001 ] items Orders list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Delete orders (batch)

Removing orders from the file.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete orders.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Enable orders

Enable orders in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable orders request.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Disable orders

Disable orders in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable orders request.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Order geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Orders filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_order_geopoint) [ 0 .. 2001 ] items A list of points.
required	object (table_list_counters) Counters by list of entities.
required	object (table_list_counters_detail) Counters by list of points.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"demand_type": "WORK",
"trip_key": "key01",
"trip_name": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Order metrics

Calculate general metrics for selected orders.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] A list of keys.
	Array of objects (table_order_filter) [ 0 .. 50 ] items Default: [] A list of filters.

Responses

Response Schema: application/json

	object (table_order_fields) Total values for fields of types int, double, duration.
	object (table_order_fields) Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "ORDER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "AAA",
"hard_time_window": null,
"soft_time_window": null,
"general_drop_time_window": null,
"general_pickup_time_window": null,
"general_work_time_window": null,
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": "AAA",
"order_restrictions": "AAA",
"performer_restrictions": "AAA",
"performer_blacklist": "AAA",
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": "AAA",
"box_restrictions": "AAA",
"cargo_features": "AAA",
"cargo_restrictions": "AAA",
"demands_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "ORDER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"state": "PLANNED",
"type": "AAA",
"hard_time_window": null,
"soft_time_window": null,
"general_drop_time_window": null,
"general_pickup_time_window": null,
"general_work_time_window": null,
"reward": 2343.3,
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"order_features": "AAA",
"order_restrictions": "AAA",
"performer_restrictions": "AAA",
"performer_blacklist": "AAA",
"width": 1,
"height": 0.3,
"length": 2.2,
"rotation": "AAA",
"box_restrictions": "AAA",
"cargo_features": "AAA",
"cargo_restrictions": "AAA",
"demands_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Performers

Performers management.

Create performer

Create performer.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Performer creation request.

key required	string [ 1 .. 1024 ] characters Example: "performer0001" 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) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" The type of personal transport that the performer will use to get to his assigned work transport.
	performer_compatibilities (object) or nullable (null) Default: null Compatibilities of the performer with transport and orders.
	performer_limits (object) or nullable (null) Default: null Limitation on the performer's workload.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (performer) Performer. Fulfills orders using transport.
	object (table_performer_fields) Performer and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
]
}

Response samples

Content type

application/json

{"performer": {"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Update performer

Updating the performer by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Performer update request.

key required	string [ 1 .. 1024 ] characters Example: "performer0001" 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) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" The type of personal transport that the performer will use to get to his assigned work transport.
	performer_compatibilities (object) or nullable (null) Default: null Compatibilities of the performer with transport and orders.
	performer_limits (object) or nullable (null) Default: null Limitation on the performer's workload.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (performer) Performer. Fulfills orders using transport.
	object (table_performer_fields) Performer and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
]
}

Response samples

Content type

application/json

{"performer": {"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Read performer

Getting performer information by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required	object (performer) Performer. Fulfills orders using transport.
	object (table_performer_fields) Performer and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"performer": {"key": "performer_1",
"shifts": [{"key": "performer_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
},
"working_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
]
},
"fields": {"essence_key": "performer_1",
"enabled": true
}
}

Remove performer

Removing a performer by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Performers list

Getting a performers list.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_performer_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 12 more Example: sort_field=ESSENCE_KEY Performers table column name.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 The name of the additional column in the table.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_performer) [ 0 .. 2001 ] items Performers list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"essences": [ ],
"counters": {"overall": {"total": 0
},
"filter": {"total": 0
}
}
}

Delete performers (batch)

Removing performers from the file.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete performers.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Enable performers

Enable performers in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable performers request.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Disable performers

Disable performers in the calculation.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable performers request.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["essence_key_1",
"essence_key_99"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-09-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Performer geopoints

Getting a geopoints.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (web_performer_geopoint) [ 0 .. 2001 ] items A list of points.
required	object (table_list_counters) Counters by list of entities.
required	object (table_list_counters_detail) Counters by list of points.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"geopoints": [{"geopoint": {"latitude": 55.692789,
"longitude": 37.554554
},
"performer_key": "performer_01",
"shift_key": "shift01",
"point_type": "START",
"trip_key": "key01",
"trip_name": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Performer metrics

Calculate general metrics for selected performers.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] A list of keys.
	Array of objects (table_performer_filter) [ 0 .. 50 ] items Default: [] A list of filters.

Responses

Response Schema: application/json

	object (table_performer_fields) Total values for fields of types int, double, duration.
	object (table_performer_fields) Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"filters": [{"type": "STRING_SEARCH",
"column": "ESSENCE_KEY",
"string_search": {"text": "key01",
"strict": false
}
}
]
}

Response samples

Content type

application/json

{"fields_sum": {"essence_type": "PERFORMER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"availability_time": null,
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"performer_features": "AAA",
"transport_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"fields_avg": {"essence_type": "PERFORMER",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"working_time": null,
"availability_time": null,
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"performer_features": "AAA",
"transport_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-09-21T18:00:00+03:00",
"datetime_1": "2026-09-21T18:00:00+03:00",
"datetime_2": "2026-09-21T18:00:00+03:00",
"datetime_3": "2026-09-21T18:00:00+03:00",
"datetime_4": "2026-09-21T18:00:00+03:00",
"datetime_5": "2026-09-21T18:00:00+03:00",
"datetime_6": "2026-09-21T18:00:00+03:00",
"datetime_7": "2026-09-21T18:00:00+03:00",
"datetime_8": "2026-09-21T18:00:00+03:00",
"datetime_9": "2026-09-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Transports

Transports management.

Create transport

Creating a transport.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Transport creation request.

key required	string [ 1 .. 1024 ] characters Example: "transport001" 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) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" 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_10000_L75_H35_W24_6000` - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg `TRUCK_18000_L95_H40_W26_11000` - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 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 `TELEPORT` - teleport (instant movement between points) 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 Default: [] A list of transport boxes that can accommodate the cargo.
	transport_compatibilities (object) or nullable (null) Default: null Compatibilities of the transport with performers and locations.
	transport_limits (object) or nullable (null) Default: null Transport load limits.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	object (table_transport_fields) Transport and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}

Response samples

Content type

application/json

{"transport": {"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Update transport

Updating a transport by its key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Transport update request.

key required	string [ 1 .. 1024 ] characters Example: "transport001" 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) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" 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_10000_L75_H35_W24_6000` - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg `TRUCK_18000_L95_H40_W26_11000` - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 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 `TELEPORT` - teleport (instant movement between points) 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 Default: [] A list of transport boxes that can accommodate the cargo.
	transport_compatibilities (object) or nullable (null) Default: null Compatibilities of the transport with performers and locations.
	transport_limits (object) or nullable (null) Default: null Transport load limits.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Name, information field.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (transport) Transport. Used by performer for relocating and cargo transfer.
	object (table_transport_fields) Transport and shift fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Request samples

Payload

Content type

application/json

{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
}

Response samples

Content type

application/json

{"transport": {"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-09-07T21:00:00+00:00",
"to": "2026-09-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Reading transport

Getting transport information by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 File key, unique identifier.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Key, unique identifier.

Responses

Response Schema: application/json

required

VRt.Monitor [MT] (7.39.3350)

Description

Trip state model

Entity diagram

Explorer

Create folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Getting a filesystem

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Update folder

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folder removal

Authorizations:

path Parameters

Responses

Response samples

Folder specification

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Folder path

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Create folders (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folders removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Folder key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

File key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Files removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Enable sharing (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

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/octet-stream
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional