VRt.Monitor [MT] (7.28.3096)

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

Программный интерфейс для инструмента Veeroute Monitor.

Описание

Серверная часть Veeroute Monitor.

Модель состояний рейса

Код состояния	Описание	Ожидаемое действие
`FREE`	Рейс создан, экипаж не назначен	Оператор назначит экипаж
`ASSIGNED`	Экипаж назначен	Оператор отправит задание экипажу
`SENT`	Задание отправлено экипажу	Экипаж подтвердит факт получения
`RECEIVED`	Экипаж получил рейс (факт `TRIP_RECEIVED`)	Экипаж примет или отклонит рейс
`CONFIRMED`	Экипаж согласился выполнить рейс (факт `TRIP_CONFIRMED`)	Экипаж начнет выполнять рейс
`REJECTED`	Экипаж отказался выполнить рейс (факт `TRIP_REJECTED`)	Оператор назначит новый экипаж или отменит рейс
`EXECUTING`	Экипаж выполняет рейс (факт `TRIP_EXECUTED`)	Экипаж завершит все задачи
`FINISHED`	Рейс завершён - не осталось работ по рейсу	Это конечный статус
`CANCELLED`	Рейс отменён оператором	Это конечный статус

Переход статусов:

Оператор: FREE → ASSIGNED → SENT

Экипаж: RECEIVED → CONFIRMED / REJECTED → EXECUTING

Условия: EXECUTING → FINISHED / CANCELLED

Факты

В зависимости от типа факта, кроме основных обязательных полей (которые описаны в API), появляются дополнительные обязательные поля:

Обозначение факта	order_key	demand_key	performer_key	location_key
`NEW_LOCATION`			+	+
`ORDER_DONE`	+
`DEMAND_START`		+
`DEMAND_DONE`		+
`TRIP_RECEIVED`
`TRIP_CONFIRMED`
`TRIP_REJECTED`
`TRIP_EXECUTED`

Диаграмма сущностей

erd

Explorer

Управление виртуальной файловой системой.

Создание папки

Создание новой папки.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание папки. В поле parent_key необходимо указать ключ папки, в которой будет создана новая папка. Если parent_key не указан - папка создается в корне.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

string <uuid> (unique_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-01-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Чтение структуры папок

Получение структуры папок.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Ключ родительской папки, если не указан - возвращается список корневых папок
filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те папки, у которых содержится подстрока из фильтра: в названии папки в комментарии к папке
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more Example: sort_field=CREATION_DATE Название колонки в таблице с папками.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Список папок.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Обновление папки

Переименование и перемещение папки.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление папки.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Список папок.
required	object (table_list_counters) Счетчики по списку.

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-01-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
}
}
}

Удаление папки

Удаление папки по ключу.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Информация о папке

Получение информации о папке.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response Schema: application/json

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-01-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

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-01-21T19:45:00Z",
"attributes": [ ]
}

Получение пути папки

Получение пути папки.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response Schema: application/json

required

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

Список папок.

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-01-21T19:45:00Z",
"expiration_date": "2026-01-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Создание папок (пачка)

Создание новых папок (пачка).

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание группы папок от корня виртуальной файловой системы. Если любая папка в пути уже существует - она не будет создаваться заново. Метод возвращает ключ последней папки даже в случае, если не было создано ни одной папки.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Название папки.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Удаление папок (пачка)

Массовое удаление папок.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей папок, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Ключ, уникальный идентификатор.

Responses

Request samples

Payload

Content type

application/json

[ ]

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Получение ключа папки

Получение ключа папки по пути.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа папки по пути от корня виртуальной файловой системы. Если любой папки в пути не существует - вернется 404.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Название папки.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Получение ключа файла

Получение ключа файла по пути.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа файла по пути от корня виртуальной файловой системы. Если в папке несколько файлов с одинаковым названием - возвращается последний измененный. Если любой папки или файла в пути не существует - вернется 404.

folder_names required	Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ] Example: ["folder_1"] Список названий папок от корня виртуальной файловой системы.
file_name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Удаление файлов (пачка)

Массовое удаление файлов.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей файлов, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Ключ, уникальный идентификатор.

Responses

Request samples

Payload

Content type

application/json

[ ]

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Счетчики файловой системы

Получение статистики по виртуальной файловой системе.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required	object (folder_counters) Текущее количество доступных папок/файлов.
required	object (folder_counters) Максимальное количество доступных папок/файлов.

Response samples

Content type

application/json

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

Backups

Массовый экспорт и импорт данных.

Экспорт папки

Экспорт папки с экспериментами.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP-архив с данными.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Импорт папки

Импорт папки с экспериментами. Папка не должна типа ROOT и должна быть пустой.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Данные (ZIP).

string <byte> (file_zip)

ZIP-архив с данными.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Crews

Управление экипажами.

Экипаж состоит из:

Мобильное устройство
Исполнитель
Транспортное средство

Создание экипажа

Создание нового экипажа.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание экипажа.

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: null Описание исполнителя.
	transport (object) or nullable (null) Default: null Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: null Описание исполнителя.
	transport (object) or nullable (null) Default: null Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Обновление экипажа

Обновление информации об экипаже.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на обновление экипажа.

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: null Описание исполнителя.
	transport (object) or nullable (null) Default: null Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: null Описание исполнителя.
	transport (object) or nullable (null) Default: null Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Чтение экипажа

Получение информации об экипаже по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

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

Example: mega_crew

Параметр (path) с ключом экипажа.

Responses

Response Schema: application/json

required	object (crew) Экипаж.
	object (table_crew_fields) Табличные поля экипажей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"crew": {"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
},
"fields": {"essence_type": "CREW",
"essence_key": "key01",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
},
"linked_essences": [ ]
}

Удаление экипажа

Удаление экипажа.

Authorizations:

ApiKeyAuth

path Parameters

crew_key

required

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

Example: mega_crew

Параметр (path) с ключом экипажа.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Чтение экипажей (таблица)

Получение списка экипажей в виде таблицы.

Authorizations:

ApiKeyAuth

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Название колонки в таблице с экипажами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр экипажей.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
},
"elements": [{"essence_type": "CREW",
"essence_key": "key01",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Удаление экипажей (пачка)

Массовое удаление экипажей.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на удаление экипажа.

Array ([ 0 .. 2001 ] items)

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

Уникальный идентификатор экипажа.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Геоточки экипажей

Получение списка геоточек экипажей.

Authorizations:

ApiKeyAuth

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр экипажей.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (crew_geopoint) [ 0 .. 2001 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
},
"crew_key": "mega_crew"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Свой экипаж APP

Получение информации о своем экипаже (по логину).

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
	performer (object) or nullable (null) Default: null Описание исполнителя.
	transport (object) or nullable (null) Default: null Описание транспорта.
	object (device) Мобильное устройство.
	Array of objects (deal_list) [ 0 .. 30 ] items Связанные с экипажем текущие сделки.

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": null,
"transport": null,
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Deals

Управление сделками.

Сделка - назначение экипажа на конкретный рейс из конкретной волны.

Объект временный, автоматически удаляется после завершения рейса экипажем.

Создание сделки

Создание новой сделки.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание сделки.

crew_key required	string (crew_key) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Уникальный идентификатор экипажа.
wave_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
trip_key required	string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Уникальный идентификатор рейса.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

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"
}
}

Обновление сделки

Обновление информации о сделке.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на обновление сделки.

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

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"
}
}

Чтение сделки

Получение информации о сделке по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

deal_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Уникальный идентификатор сделки.
required	object (deal_specification) Описание сделки.

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"
}
}

Удаление сделки

Удаление сделки.

Authorizations:

ApiKeyAuth

path Parameters

deal_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Свои рейсы APP

Получение списка рейсов, назначенных на экипаж (по логину).

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

Array ([ 0 .. 10 ] items)

required	object (deal) Сделка - назначение экипажа на конкретный рейс из конкретной волны.
required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
trip_status required	string (trip_status) Enum: "FREE" "ASSIGNED" "SENT" … 6 more Example: "FINISHED" Текущее статус рейса: `FREE` - рейс не имеет назначенного экипажа, начальный статус, ожидает назначения оператором `ASSIGNED` - на рейс назначен экипаж, ожидает отправки экипажу оператором `SENT` - рейс отправлен экипажу, ожидает подтверждения получения экипажем `RECEIVED` - рейс получен экипажем, ожидает принятия экипажем `CONFIRMED` - рейс принят экипажем, ожидает начала работ экипажем `REJECTED` - рейс отклонен экипажем, ожидает назначения нового экипажа оператором `EXECUTING` - рейс выполняется экипажем, ожидает завершения экипажем `FINISHED` - рейс завершен - все задачи выполнены, финальный статус `CANCELLED` - рейс отменен оператором, финальный статус
required	object (trip_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": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2026-01-21T09:30:00+03:00",
"to": "2026-01-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2026-01-21T09:30:00+03:00",
"to": "2026-01-21T19:45:00Z"
}
},
"states": [{"time": "2026-01-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_status": "FINISHED",
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2026-01-21T09:30:00+03:00",
"to": "2026-01-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 5.5,
"volume": 4.1,
"capacity_a": 3.7,
"capacity_b": 2.8,
"capacity_c": 2.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [ ],
"roundtrip_statistics": [ ],
"attributes": [ ]
}
}
]

Waves

Управление волнами планирования и исполнения.

Волна состоит из:

Исходные данные для расчета (заказы, исполнители, транспорт, настройки)
Результаты расчета (рейсы, статистика)
Результаты выполнения (факты)

Создание волны

Создание нового волны.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание волны.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Чтение волны

Получение информации о волне по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

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-01-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-01-15T13:56:07.697Z",
"to": "2026-01-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-01-21T09:30:00+03:00",
"to": "2026-01-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-01-15T13:56:07.728Z",
"creation_date": "2026-01-15T13:56:07.728Z"
}

Обновление волны

Переименование \ перемещение волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление описания волны.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

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-01-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-01-15T13:56:07.697Z",
"to": "2026-01-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-01-21T09:30:00+03:00",
"to": "2026-01-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-01-15T13:56:07.728Z",
"creation_date": "2026-01-15T13:56:07.728Z"
}

Удаление волны

Удаление волны по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список волн (таблица)

Получение списка волн в виде таблицы.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Ключ папки, уникальный идентификатор.
filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те файлы, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращаются все файлы в папке. Результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с волнами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items Список волн.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Поиск волн

Глобальный поиск волн по всем вложенным папкам.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те конфигурации, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращается пустой список. По умолчанию результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с волнами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items Список волн.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Дублирование волны

Дублирование волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на дублирование волны.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

string <uuid> (unique_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"

Получение пути волны

Получение пути волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Responses

Response Schema: application/json

required

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

Список папок.

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-01-21T19:45:00Z",
"expiration_date": "2026-01-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Импорт (XLSX)

Импорт новых данных из файла формата XLSX. Если сущность уже присутствует (определяется по ее ключу) - она обновляется. Если нет - создается новая. Временная зона данных берется из файла XLSX.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Данные (XLSX).

string <byte> (file_xlsx)

Файл с данными в формате XLSX.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

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-01-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-01-15T13:56:07.697Z",
"to": "2026-01-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-01-21T09:30:00+03:00",
"to": "2026-01-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-01-15T13:56:07.728Z",
"creation_date": "2026-01-15T13:56:07.728Z"
}

Импорт (JSON)

Импорт новых данных из файла формата VRt.Universal JSON. Если сущность уже присутствует (определяется по ее ключу) - она обновляется. Если нет - создается новая.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные (JSON).

	Array of objects (location_list) [ 0 .. 15001 ] items unique Список локаций, которые используются в заказах и сменах.
	Array of objects (order_list) [ 0 .. 15001 ] items unique Список заказов, которые необходимо выполнить.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Список доступных исполнителей. Исполнитель выполняет заказы используя транспорт.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Список доступного транспорта. Транспорт используется исполнителем рейса для выполнения заказов.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Список назначений.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Список рейсов. Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	plan_statistics (object) or nullable (null) Default: null Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `plan_settings.geo_settings`.
	object (plan_settings) Настройки планирования.
	object (replan_settings) Настройки перепланирования.
	object (actualize_settings) Настройки актуализации.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
required	object (experiment_settings) Настройки эксперимента.
required	object (experiment_statistics) Статистика эксперимента.
	calculation_state (object) or nullable (null) Default: null Текущее состояние расчета (если расчет идет или завершен).
	experiment_check (object) or nullable (null) Default: null Результат проверки загруженных данных.
edit_date required	string <date-time> (file_edit_date) Example: "2026-01-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2026-01-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

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

Экспорт (XLSX)

Экспортировать (XLSX).

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

timezone

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

Default: 0

Example: timezone=3

Целевая временная зона данных.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

Файл с данными в формате XLSX.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Экспорт (JSON)

Экспортировать данные в файл формата VRt.Universal JSON.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Responses

Response Schema: application/json

	Array of objects (location_list) [ 0 .. 15001 ] items unique Список локаций, которые используются в заказах и сменах.
	Array of objects (order_list) [ 0 .. 15001 ] items unique Список заказов, которые необходимо выполнить.
	Array of objects (performer_list) [ 0 .. 15001 ] items unique Список доступных исполнителей. Исполнитель выполняет заказы используя транспорт.
	Array of objects (transport_list) [ 0 .. 15001 ] items unique Список доступного транспорта. Транспорт используется исполнителем рейса для выполнения заказов.
	Array of objects (hardlink_list) [ 0 .. 15001 ] items unique Список назначений.
	Array of objects (trip_list) [ 0 .. 15001 ] items unique Список рейсов. Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
	Array of objects (fact_list) [ 0 .. 15001 ] items unique Список фактов. Факт - это произошедшее событие, которое влияет на дальнейшие выполнение рейсов.
	plan_statistics (object) or nullable (null) Default: null Общая статистика по результату расчета.
	Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации `external_routing` не учитываются параметры `plan_settings.geo_settings`.
	object (plan_settings) Настройки планирования.
	object (replan_settings) Настройки перепланирования.
	object (actualize_settings) Настройки актуализации.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет.

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

Locations

Управление локациями.

Создание локации

Создание локации.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового локации.

key required	string [ 1 .. 1024 ] characters Example: "location_01" Ключ локации, уникальный идентификатор.
required	object (geopoint) Географическая точка.
arrival_duration	string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Example: "PT1H45M" Время на подъезд (парковку) на локации, в формате ISO 8601 duration.
departure_duration	string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Example: "PT1H45M" Время на отъезд от локации, в формате ISO 8601 duration.
	Array of objects (location_timetable) [ 0 .. 30 ] items Расписание работы локации - временные окна доступности и ограничения на пропускную способность. Если список пустой или не указан - локация работает без ограничений.
	location_compatibilities (object) or nullable (null) Default: null Совместимости локации с транспортом.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	location_statistics (object) or nullable (null) Default: null Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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
}
}

Обновление локации

Обновление локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление локации.

key required	string [ 1 .. 1024 ] characters Example: "location_01" Ключ локации, уникальный идентификатор.
required	object (geopoint) Географическая точка.
arrival_duration	string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Example: "PT1H45M" Время на подъезд (парковку) на локации, в формате ISO 8601 duration.
departure_duration	string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)\|(\d+\.\d+Y$))?((\d+M)\|(\d+\.\d... Example: "PT1H45M" Время на отъезд от локации, в формате ISO 8601 duration.
	Array of objects (location_timetable) [ 0 .. 30 ] items Расписание работы локации - временные окна доступности и ограничения на пропускную способность. Если список пустой или не указан - локация работает без ограничений.
	location_compatibilities (object) or nullable (null) Default: null Совместимости локации с транспортом.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	location_statistics (object) or nullable (null) Default: null Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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
}
}

Чтение локации

Получение информации о локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (location) Локация - уникальное географическое местоположение объекта с параметрами доступности.
	location_statistics (object) or nullable (null) Default: null Статистика по загрузке локации.
	object (table_location_fields) Табличные поля локации.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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
}
}

Удаление локации

Удаление локации по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список локаций

Получение списка локаций.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_location_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с локациями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр локаций.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_location) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление локаций (пачка)

Массовое удаление локаций из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление локаций.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Геоточки локаций

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр локаций.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_location_geopoint) [ 0 .. 2001 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
}
}

Метрики по локациям

Расчет общих метрик по выбранным локациям.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_location_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_location_fields) Суммарные значения для полей типов int, double, duration.
	object (table_location_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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

Управление заказами.

Создание заказа

Создание заказа.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

key required	string [ 1 .. 1024 ] characters Example: "order01" Ключ заказа, уникальный идентификатор.
required	Array of objects (demand) [ 1 .. 1000 ] items unique Список заявок.
	Array of objects (cargo) [ 0 .. 1000 ] items unique Default: [] Список грузов, на которые ссылаются заявки данного заказа. Список должен быть пустой, если все заявки заказа имеют тип `WORK`.
	order_compatibilities (object) or nullable (null) Default: null Совместимости заказа с исполнителями и другими заказами.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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-01-08T05:00:00+00:00",
"to": "2026-01-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-01-08T05:00:00+00:00",
"to": "2026-01-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Обновление заказа

Обновление сущности по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

key required	string [ 1 .. 1024 ] characters Example: "order01" Ключ заказа, уникальный идентификатор.
required	Array of objects (demand) [ 1 .. 1000 ] items unique Список заявок.
	Array of objects (cargo) [ 0 .. 1000 ] items unique Default: [] Список грузов, на которые ссылаются заявки данного заказа. Список должен быть пустой, если все заявки заказа имеют тип `WORK`.
	order_compatibilities (object) or nullable (null) Default: null Совместимости заказа с исполнителями и другими заказами.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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-01-08T05:00:00+00:00",
"to": "2026-01-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-01-08T05:00:00+00:00",
"to": "2026-01-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Чтение заказа

Получение информации о заказе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (order) Заказ на перемещение груза, содержит список заявок.
	object (table_order_fields) Табличные поля заказа и заявок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

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-01-08T05:00:00+00:00",
"to": "2026-01-08T07:00:00+00:00"
}
}
]
}
]
},
"fields": {"essence_key": "order_1",
"enabled": true
}
}

Удаление одного заказа

Удаление заказа по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список заказов

Получение списка заказов.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_order_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с заказами.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр заказов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_order) [ 0 .. 15001 ] items Список заказов.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление заказов (пачка)

Удаление заказов из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление заказов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Включение заказов

Включение заказов в расчет.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение заказов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Выключение заказов

Выключение заказов из расчета.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение заказов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Геоточки заказов

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр заказов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_order_geopoint) [ 0 .. 2001 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
}
}

Метрики по заказам

Расчет общих метрик по выбранным заказам.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_order_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_order_fields) Суммарные значения для полей типов int, double, duration.
	object (table_order_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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

Управление исполнителями.

Создание исполнителя

Создание исполнителя.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового исполнителя.

key required	string [ 1 .. 1024 ] characters Example: "performer0001" Ключ исполнителя, уникальный идентификатор.
required	Array of objects (performer_shift) [ 1 .. 15001 ] items unique Список рабочих смен исполнителя.
own_transport_type	string (transport_type) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Тип личного транспорта, на котором исполнитель будет добираться до назначенного на него рабочего транспорта.
	performer_compatibilities (object) or nullable (null) Default: null Совместимости исполнителя с транспортом и заказами.
	performer_limits (object) or nullable (null) Default: null Ограничение на рабочую загрузку исполнителя.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Обновление исполнителя

Обновление исполнителя по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление исполнителя.

key required	string [ 1 .. 1024 ] characters Example: "performer0001" Ключ исполнителя, уникальный идентификатор.
required	Array of objects (performer_shift) [ 1 .. 15001 ] items unique Список рабочих смен исполнителя.
own_transport_type	string (transport_type) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Тип личного транспорта, на котором исполнитель будет добираться до назначенного на него рабочего транспорта.
	performer_compatibilities (object) or nullable (null) Default: null Совместимости исполнителя с транспортом и заказами.
	performer_limits (object) or nullable (null) Default: null Ограничение на рабочую загрузку исполнителя.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Чтение исполнителя

Получение информации об исполнителе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (performer) Исполнитель. Выполняет заказы, используя транспорт.
	object (table_performer_fields) Табличные поля исполнителя и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

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

Удаление исполнителя

Удаление исполнителя по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список исполнителей

Получение списка исполнителей.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_performer_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 12 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с исполнителями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр исполнителей.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_performer) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление исполнителей (пачка)

Массовое удаление исполнителей из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление исполнителей.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Включение исполнителей

Включение исполнителей в расчет.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение исполнителей.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Выключение исполнителей

Выключение исполнителей из расчета.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение исполнителей.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Геоточки исполнителей

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр исполнителей.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_performer_geopoint) [ 0 .. 2001 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
}
}

Метрики по исполнителям

Расчет общих метрик по выбранным исполнителям.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_performer_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_performer_fields) Суммарные значения для полей типов int, double, duration.
	object (table_performer_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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

Управление транспортом.

Создание транспорта

Создание транспорта.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового транспорта.

key required	string [ 1 .. 1024 ] characters Example: "transport001" Ключ транспорта, уникальный идентификатор.
required	Array of objects (transport_shift) [ 1 .. 15001 ] items unique Список рабочих смен транспорта.
transport_type	string (transport_type) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Типы транспорта: `CAR` - легковой автомобиль `TRUCK_1500` - грузовой автомобиль с разрешенной массой не более 1500 кг `TRUCK_3000` - грузовой автомобиль с разрешенной массой не более 3000 кг `TRUCK_5000` - грузовой автомобиль с разрешенной массой не более 5000 кг `TRUCK_10000` - грузовой автомобиль с разрешенной массой не более 10000 кг `TRUCK_20000` - грузовой автомобиль с разрешенной массой не более 20000 кг `TRUCK_10000_L75_H35_W24_6000` - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг `TRUCK_18000_L95_H40_W26_11000` - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг `TRUCK_26000_L120_H40_W26_8000` - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг `TRUCK_GARBAGE_1` - грузовой автомобиль для перевозки мусора (тип 1) `TRUCK_GARBAGE_2` - грузовой автомобиль для перевозки мусора (тип 2) `TUK_TUK` - моторикша `BICYCLE` - велосипед `PEDESTRIAN` - пешеход `PUBLIC_TRANSPORT` - общественный транспорт `TELEPORT` - телепорт (мгновенное перемещение между точками) Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.
	Array of objects (box) [ 0 .. 100 ] items Default: [] Список отсеков транспорта, которые могут вмещать груз.
	transport_compatibilities (object) or nullable (null) Default: null Совместимости транспорта с исполнителями и локациями.
	transport_limits (object) or nullable (null) Default: null Ограничения на загрузку транспорта.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-01-07T21:00:00+00:00",
"to": "2026-01-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-01-07T21:00:00+00:00",
"to": "2026-01-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Обновление транспорта

Обновление транспорта по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление транспорта.

key required	string [ 1 .. 1024 ] characters Example: "transport001" Ключ транспорта, уникальный идентификатор.
required	Array of objects (transport_shift) [ 1 .. 15001 ] items unique Список рабочих смен транспорта.
transport_type	string (transport_type) Default: "CAR" Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Типы транспорта: `CAR` - легковой автомобиль `TRUCK_1500` - грузовой автомобиль с разрешенной массой не более 1500 кг `TRUCK_3000` - грузовой автомобиль с разрешенной массой не более 3000 кг `TRUCK_5000` - грузовой автомобиль с разрешенной массой не более 5000 кг `TRUCK_10000` - грузовой автомобиль с разрешенной массой не более 10000 кг `TRUCK_20000` - грузовой автомобиль с разрешенной массой не более 20000 кг `TRUCK_10000_L75_H35_W24_6000` - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг `TRUCK_18000_L95_H40_W26_11000` - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг `TRUCK_26000_L120_H40_W26_8000` - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг `TRUCK_GARBAGE_1` - грузовой автомобиль для перевозки мусора (тип 1) `TRUCK_GARBAGE_2` - грузовой автомобиль для перевозки мусора (тип 2) `TUK_TUK` - моторикша `BICYCLE` - велосипед `PEDESTRIAN` - пешеход `PUBLIC_TRANSPORT` - общественный транспорт `TELEPORT` - телепорт (мгновенное перемещение между точками) Разрешенная масса - это масса снаряженного транспорта с грузом и водителем, установленная предприятием-изготовителем в качестве максимально допустимой.
	Array of objects (box) [ 0 .. 100 ] items Default: [] Список отсеков транспорта, которые могут вмещать груз.
	transport_compatibilities (object) or nullable (null) Default: null Совместимости транспорта с исполнителями и локациями.
	transport_limits (object) or nullable (null) Default: null Ограничения на загрузку транспорта.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "transport_1",
"shifts": [{"key": "transport_1_shift",
"availability_time": {"from": "2026-01-07T21:00:00+00:00",
"to": "2026-01-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-01-07T21:00:00+00:00",
"to": "2026-01-08T20:59:59+00:00"
}
}
],
"transport_type": "CAR",
"boxes": [{"key": "box_1",
"capacity": {"mass": 300
}
}
]
},
"fields": {"essence_key": "transport_1",
"enabled": true
}
}

Чтение транспорта

Получение информации о транспорте по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (transport) Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.
	object (table_transport_fields) Табличные поля транспорта и его смены.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

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

Удаление транспорта

Удаление транспорта по ее ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список транспорта

Получение списка транспорта.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_transport_column_type) Default: "NAME" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 17 more Example: sort_field=ESSENCE_KEY Название колонки в таблице с транспортом.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр транспорта.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_transport) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление транспорта (пачка)

Массовое удаление транспорта из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление транспорта.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Включение транспорта

Включение транспорта в расчет.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение транспорта.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Выключение транспорта

Выключение транспорта из расчета.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение транспорта.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Геоточки транспорта

Получение списка геоточек.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр транспорта.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_transport_geopoint) [ 0 .. 2001 ] items Список точек.
required	object (table_list_counters) Счетчики по списку сущностей.
required	object (table_list_counters_detail) Счетчики по списку точек.

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
},
"transport_key": "transport_01",
"shift_key": "shift01",
"point_type": "FINISH",
"trip_key": "key01",
"trip_name": "X1-ABC",
"stop_number": 10
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Метрики по транспорту

Расчет общих метрик по выбранному транспорту.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_transport_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_transport_fields) Суммарные значения для полей типов int, double, duration.
	object (table_transport_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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": "TRANSPORT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"availability_time": null,
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"transport_features": "AAA",
"performer_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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": "TRANSPORT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"availability_time": null,
"transport_type": "CAR",
"trip_key": "key01",
"trip_name": "X1-ABC",
"location_keys": "AAA",
"mass": 10,
"volume": 2,
"capacity_a": 1,
"capacity_b": 2,
"capacity_c": 3,
"transport_features": "AAA",
"performer_restrictions": "AAA",
"trips_count": 1,
"shifts_count": 1,
"name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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
}
}
}

Hardlinks

Управление назначениями.

Создание назначения

Создание назначения.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

key required	string [ 1 .. 1024 ] characters Example: "group01" Ключ назначения.
required	Array of objects (hardlink_element) [ 2 .. 1000 ] items Список элементов группы назначения.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
}

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Обновление назначения

Обновление назначения по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

key required	string [ 1 .. 1024 ] characters Example: "group01" Ключ назначения.
required	Array of objects (hardlink_element) [ 2 .. 1000 ] items Список элементов группы назначения.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
}

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Чтение назначения

Получение информации о назначении по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (hardlink) Назначение, необходимое чтобы связать сущности в одну группу. Может состоять из двух сущностей или более. Пример применения: назначение водителя на транспорт (связь смен исполнителя и траспорта). назначение заказа на исполнителя (связь заказа со сменой исполнителя). указание необходимости выполнять несколько заказов в одном рейсе (связь заказов между собой).
	object (table_hardlink_fields) Табличные поля связи и связанных сущностей.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"hardlink": {"key": "hardlink_1",
"links": [{"type": "PERFORMER_SHIFT",
"entity_key": "perf_1"
},
{"type": "TRANSPORT_SHIFT",
"entity_key": "transp_1"
}
]
},
"fields": {"essence_key": "hardlink_1",
"enabled": true
}
}

Удаление назначения

Удаление назначения по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список назначений

Получение списка назначений.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_hardlink_column_type) Default: "ESSENCE_KEY" Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 5 more Example: sort_field=ELEMENTS_COUNT Название колонки в таблице со связями.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр назначений.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_hardlink) [ 0 .. 2001 ] items Список связей.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление назначений (пачка)

Массовое удаление назначений из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление назначений.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Включение назначений

Включение назначений в расчет.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение назначений.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Выключение назначений

Выключение назначений из расчета.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение назначений.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по назначениям

Расчет общих метрик по выбранным назначениям.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_hardlink_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_hardlink_fields) Суммарные значения для полей типов int, double, duration.
	object (table_hardlink_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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": "HARDLINK",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"element_type": "ORDER,PERFORMER_SHIFT",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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": "HARDLINK",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"element_type": "ORDER,PERFORMER_SHIFT",
"elements_count": 1,
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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
}
}
}

Trips

Управление рейсами.

Создание рейса

Создание рейса.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

key required	string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Уникальный идентификатор рейса.
required	object (assigned_performer) Назначенная на определенное время (`shift_time`) смена исполнителя.
required	object (assigned_transport) Назначенная на определенное время (`shift_time`) смена транспорта.
required	Array of objects (trip_state_list) [ 0 .. 15001 ] items Список состояний исполнителя.
waitlist	Array of strings (trip_waitlist) [ 0 .. 15001 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["order02"] Список ключей заказов, назначенных на исполнителя, но не запланированных на определенное время и не учтенных в загрузке транспорта.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"states": [{"time": "2026-01-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
}

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"states": [{"time": "2026-01-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:10:00Z",
"to": "2026-01-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:30:56Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Обновление рейса

Обновление рейса по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

key required	string [ 1 .. 1024 ] characters Example: "trip-0000-9999" Уникальный идентификатор рейса.
required	object (assigned_performer) Назначенная на определенное время (`shift_time`) смена исполнителя.
required	object (assigned_transport) Назначенная на определенное время (`shift_time`) смена транспорта.
required	Array of objects (trip_state_list) [ 0 .. 15001 ] items Список состояний исполнителя.
waitlist	Array of strings (trip_waitlist) [ 0 .. 15001 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["order02"] Список ключей заказов, назначенных на исполнителя, но не запланированных на определенное время и не учтенных в загрузке транспорта.
name	string (name) [ 0 .. 128 ] characters Example: "X1-ABC" Название, информационное поле.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"states": [{"time": "2026-01-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
}

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"states": [{"time": "2026-01-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:10:00Z",
"to": "2026-01-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:30:56Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Чтение рейса

Получение информации о рейсе по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (trip) Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.
required	object (trip_statistics) Статистика по конкретному рейсу.
	object (table_trip_fields) Табличные поля рейса и остановок.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"trip": {"key": "trip_1",
"performer": {"performer_key": "performer_1",
"shift_key": "performer_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"transport": {"transport_key": "transport_1",
"shift_key": "transport_1_shift",
"shift_time": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
}
},
"states": [{"time": "2026-01-08T04:39:34Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39: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"
}
],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_storage",
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T04:39:34Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 0,
"cost": 2000,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:00:00Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_2",
"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3397.1,
"reward": 0,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_2_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_2",
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:10:00Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 17110,
"cost": 3997.1,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:20:56Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_1",
"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 4752.07,
"reward": 1000.1,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [{"box_key": "box_1",
"cargo_key": "order_1_cargos",
"cargo_action_type": "REMOVE"
}
],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["DEPARTURE",
"AROUND_LOCATION"
],
"location_key": "location_client_1",
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:30:56Z",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 27007,
"cost": 5352.07,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ARRIVAL",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:38:49Z",
"flags": ["ON_DEMAND",
"INSIDE_LOCATION",
"INSIDE_LOCATION_WINDOW",
"INSIDE_EVENT_HARD_WINDOW",
"AROUND_LOCATION"
],
"order_key": "order_3",
"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 5895.37,
"reward": 2000.2,
"attributes": [ ]
},
{"time": "2026-01-08T05:53:49Z",
"flags": ["INSIDE_LOCATION",
"AROUND_LOCATION"
],
"location_key": "location_client_3",
"cargo_actions": [ ],
"distance": 34037,
"cost": 6795.37,
"reward": 3000.3,
"attributes": [ ]
}
],
"name": "1-HVFB",
"waitlist": [ ],
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip_1",
"general_statistics": {"cost": 6795.37,
"reward": 3000.3,
"profit": -3795.07,
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT39M15S",
"waiting_time": "PT0S",
"working_time": "PT35M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT1H14M15S",
"distance": 34037
},
"trips_count": 1,
"performers_count": 1,
"orders_count": 3,
"plan_orders_count": 3,
"waitlist_orders_count": 0,
"stops_count": 4,
"locations_count": 4,
"cargo_capacity_sum": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
},
"cargo_capacity_ratio": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"max_transport_load": {"mass": 0.007,
"volume": 1,
"capacity_a": 1,
"capacity_b": 1,
"capacity_c": 1
},
"average_speed": 0,
"round_trips_count": 1
},
"load_statistics": {"total_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_transfer_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
"stop_statistics": [{"location_key": "location_storage",
"stop_demands": [{"demand_key": "demand_1_pickup",
"event_key": "demand_1_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
},
{"demand_key": "demand_2_pickup",
"event_key": "demand_2_pickup_event",
"demand_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T04:39:34Z"
},
"driving_time": "PT0S",
"waiting_time": "PT0S",
"working_time": "PT0S",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT0S",
"distance": 0
},
"upload": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_2",
"stop_demands": [{"demand_key": "demand_2_drop",
"event_key": "demand_2_drop_event",
"demand_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:00:00Z",
"to": "2026-01-08T05:10:00Z"
},
"measurements": {"time_window": {"from": "2026-01-08T04:39:34Z",
"to": "2026-01-08T05:10:00Z"
},
"driving_time": "PT20M26S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT30M26S",
"distance": 17110
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 2,
"capacity": {"mass": 2,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_1",
"stop_demands": [{"demand_key": "demand_1_drop",
"event_key": "demand_1_drop_event",
"demand_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:20:56Z",
"to": "2026-01-08T05:30:56Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:10:00Z",
"to": "2026-01-08T05:30:56Z"
},
"driving_time": "PT10M56S",
"waiting_time": "PT0S",
"working_time": "PT10M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT20M56S",
"distance": 9897
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 1,
"capacity": {"mass": 1,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
},
{"location_key": "location_client_3",
"stop_demands": [{"demand_key": "demand_3_work",
"event_key": "demand_3_work_event",
"demand_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
}
}
],
"stop_time_window": {"from": "2026-01-08T05:38:49Z",
"to": "2026-01-08T05:53:49Z"
},
"measurements": {"time_window": {"from": "2026-01-08T05:30:56Z",
"to": "2026-01-08T05:53:49Z"
},
"driving_time": "PT7M53S",
"waiting_time": "PT0S",
"working_time": "PT15M",
"break_time": "PT0S",
"rest_time": "PT0S",
"arriving_time": "PT0S",
"departure_time": "PT0S",
"total_time": "PT22M53S",
"distance": 7030
},
"upload": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"download": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"max_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"arrival_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
},
"departure_load": {"count": 0,
"capacity": {"mass": 0,
"volume": 0,
"capacity_a": 0,
"capacity_b": 0,
"capacity_c": 0
}
}
}
]
},
"fields": {"essence_key": "trip_1",
"enabled": true
}
}

Удаление рейса

Удаление рейса по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Чтение рейсов (таблица)

Получение списка рейсов.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Default: "TRIP_NAME" Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 34 more Example: sort_field=DISTANCE Название колонки в таблице с рейсами.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_trip) [ 0 .. 2001 ] items Список рейсов.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление рейсов (пачка)

Удаление рейсов из волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление рейсов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Диаграмма рейсов

Получение рейсов для отображения на диаграмме.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_column_type) Default: "TRIP_NAME" Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 34 more Example: sort_field=DISTANCE Название колонки в таблице с рейсами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (web_trip_chart) [ 0 .. 2001 ] items Данные для диаграммы.
required	object (table_list_counters) Счетчики по списку.

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

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

Пути рейсов

Получение путей.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
tracks_type required	string (track_type) Default: "LINE" Enum: "LINE" "ROAD" "CUSTOM" Example: ROAD Тип треков для вывода на карту: `LINE` - соединение точек остановок по прямой `ROAD` - соединение точек остановок по дорогам `EXTERNAL` - пользовательские треки

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр рейсов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (track) [ 0 .. 2001 ] items Список треков.
required	object (table_list_counters) Счетчики по списку.

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

{"tracks": [{"geotrack": [{"latitude": 55.692789,
"longitude": 37.554554,
"time": "2026-01-21T09:30:00+03:00"
},
{"latitude": 55.692788,
"longitude": 37.55467,
"time": "2026-01-21T09:35:00+03:00"
}
],
"trip_key": "trip_01",
"performer_key": "performer_01",
"performer_shift_key": "performer_shift_01",
"transport_key": "transport_01",
"transport_shift_key": "transport_shift_01",
"trip_name": "X1-ABC"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Загрузка пользовательских треков

Загрузка пользовательских треков.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
optional

Список пользовательских треков.

required

Array of objects (track) [ 0 .. 15001 ] items

Список треков.

Responses

Request samples

Payload

Content type

application/json

{"tracks": [{"geotrack": [{"latitude": 55.692789,
"longitude": 37.554554,
"time": "2026-01-21T09:30:00+03:00"
},
{"latitude": 55.692788,
"longitude": 37.55467,
"time": "2026-01-21T09:35:00+03:00"
}
],
"trip_key": "trip_01",
"performer_key": "performer_01",
"performer_shift_key": "performer_shift_01",
"transport_key": "transport_01",
"transport_shift_key": "transport_shift_01",
"trip_name": "X1-ABC"
}
]
}

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Удаление пользовательских треков

Удаление пользовательских всех треков.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по заказам

Расчет общих метрик по выбранным заказам.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_trip_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_trip_fields) Суммарные значения для полей типов int, double, duration.
	object (table_trip_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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": "ROUNDTRIP",
"essence_key": "key01",
"enabled": false,
"trip_verified": true,
"pristine": false,
"trip_name": "X1-ABC",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": null,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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"
},
"trip_status": "FINISHED",
"crew_key": "key01"
},
"fields_avg": {"essence_type": "ROUNDTRIP",
"essence_key": "key01",
"enabled": false,
"trip_verified": true,
"pristine": false,
"trip_name": "X1-ABC",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": null,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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"
},
"trip_status": "FINISHED",
"crew_key": "key01"
},
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Список остановок рейсов

Получение списка остановок рейса.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_trip_stop_column_type) Default: "ESSENCE_KEY" Enum: "ESSENCE_KEY" "DRIVING_TIME" "WAITING_TIME" … 14 more Example: sort_field=LOCATION_NAME Название колонки в таблице с остановками рейса.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр остановок рейса.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_trip_stop) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Доступные экипажи

Получение списка экипажей, которые могут выполнить указанный рейс.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_crew_column_type) Default: "USERNAME" Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more Example: sort_field=DEVICE_ONLINE Название колонки в таблице с экипажами.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр экипажей.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 0 .. 2001 ] items Список.
required	object (table_list_counters) Счетчики по списку.

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",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
},
"elements": [{"essence_type": "CREW",
"essence_key": "key01",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
}
]
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Запуск рейсов (пачка)

Запуск рейсов (пачка). Если список ключей рейсов пустой - запускаются все рейсы из волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на запуск рейсов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

Responses

Request samples

Payload

Content type

application/json

[ ]

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Остановка рейсов (пачка)

Остановка рейсов (пачка). Если список ключей рейсов пустой - останавливаются все рейсы из волны.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на остановку рейсов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

Responses

Request samples

Payload

Content type

application/json

[ ]

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Заказы из рейса APP

Получение заказов из рейса.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

Array ([ 0 .. 15000 ] items)

required

object (order)

Заказ на перемещение груза, содержит список заявок.

Response samples

Content type

application/json

[{"order": {"key": "order01",
"demands": [{"key": "demand_1",
"demand_type": "WORK",
"target_cargos": ["cargo01"
],
"precedence_in_trip": 1,
"precedence_in_order": 1,
"possible_events": [{"key": "event_1",
"location_key": "location_01",
"duration": "PT1H45M",
"reward": 199.9,
"hard_time_window": {"from": "2026-01-21T09:30:00+03:00",
"to": "2026-01-21T19:45:00Z"
},
"soft_time_window": null
}
],
"name": "X1-ABC",
"attributes": [ ]
}
],
"cargos": [ ],
"compatibilities": null,
"name": "X1-ABC",
"attributes": [ ]
}
}
]

Facts

Управление фактами.

Создание факта

Создание факта.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

key required	string [ 1 .. 1024 ] characters Example: "fact_01" Ключ факта.
time required	string <date-time> (fact_time) Example: "2026-01-21T09:30:00+03:00" Дата и время создания факта в формате ISO 8601.
type required	string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 5 more Example: "NEW_LOCATION" Возможные типы фактов: `NEW_LOCATION` - исполнитель изменил свое местоположение в процессе выполнения рейса `ORDER_DONE` - исполнитель закончил выполнять заказ (или заказ был отменен), связанный с заказом груз более не находится в отсеках транспорта `DEMAND_START` - исполнитель начал выполнять заявку `DEMAND_DONE` - исполнитель закончил выполнять заявку `TRIP_RECEIVED` - исполнитель получил рейс `TRIP_CONFIRMED` - исполнитель согласился выполнить рейс `TRIP_REJECTED` - исполнитель отказался выполнить рейс `TRIP_EXECUTED` - исполнитель начал выполнять рейс
trip_key required	string [ 1 .. 1024 ] characters Example: "trip_01" Ключ рейса, к которому относится факт.
order_key	string or null [ 1 .. 1024 ] characters Default: null Example: "order_01" Ключ заказа, обязателен для фактов с типом `ORDER_DONE`.
demand_key	string or null [ 1 .. 1024 ] characters Default: null Example: "order_01_demand_01" Ключ заявки, обязателен для фактов с типами `DEMAND_DONE` и `DEMAND_START`.
performer_key	string or null [ 1 .. 1024 ] characters Default: null Example: "performer_01" Ключ исполнителя, обязателен для фактов с типом `NEW_LOCATION`.
location_key	string or null [ 1 .. 1024 ] characters Default: null Example: "location_01" Ключ локации, обязателен для фактов с типом `NEW_LOCATION`.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2026-01-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2026-01-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Обновление факта

Обновление факта по ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

key required	string [ 1 .. 1024 ] characters Example: "fact_01" Ключ факта.
time required	string <date-time> (fact_time) Example: "2026-01-21T09:30:00+03:00" Дата и время создания факта в формате ISO 8601.
type required	string (fact_type) Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 5 more Example: "NEW_LOCATION" Возможные типы фактов: `NEW_LOCATION` - исполнитель изменил свое местоположение в процессе выполнения рейса `ORDER_DONE` - исполнитель закончил выполнять заказ (или заказ был отменен), связанный с заказом груз более не находится в отсеках транспорта `DEMAND_START` - исполнитель начал выполнять заявку `DEMAND_DONE` - исполнитель закончил выполнять заявку `TRIP_RECEIVED` - исполнитель получил рейс `TRIP_CONFIRMED` - исполнитель согласился выполнить рейс `TRIP_REJECTED` - исполнитель отказался выполнить рейс `TRIP_EXECUTED` - исполнитель начал выполнять рейс
trip_key required	string [ 1 .. 1024 ] characters Example: "trip_01" Ключ рейса, к которому относится факт.
order_key	string or null [ 1 .. 1024 ] characters Default: null Example: "order_01" Ключ заказа, обязателен для фактов с типом `ORDER_DONE`.
demand_key	string or null [ 1 .. 1024 ] characters Default: null Example: "order_01_demand_01" Ключ заявки, обязателен для фактов с типами `DEMAND_DONE` и `DEMAND_START`.
performer_key	string or null [ 1 .. 1024 ] characters Default: null Example: "performer_01" Ключ исполнителя, обязателен для фактов с типом `NEW_LOCATION`.
location_key	string or null [ 1 .. 1024 ] characters Default: null Example: "location_01" Ключ локации, обязателен для фактов с типом `NEW_LOCATION`.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Request samples

Payload

Content type

application/json

{"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2026-01-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
}

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2026-01-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Чтение факта

Получение информации о факте по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

Responses

Response Schema: application/json

required	object (fact) Факт о заказе - совершенное действие с заказом или его частью (заявкой).
	object (table_fact_fields) Табличные поля факта.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items Список связанных сущностей.

Response samples

Content type

application/json

{"fact": {"key": "fact_01",
"type": "NEW_LOCATION",
"time": "2026-01-07T22:00:00Z",
"trip_key": "trip_for_performer_1",
"performer_key": "performer_1",
"location_key": "performer_1_current_location"
},
"fields": {"essence_key": "fact_01",
"enabled": true
}
}

Удаление одного факта

Удаление факта по его ключу.

Authorizations:

ApiKeyAuth

path Parameters

file_key required	string <uuid> (unique_key) Example: 11111111-2222-3333-4444-555555555555 Ключ файла, уникальный идентификатор.
essence_key required	string (basic_essence_key) [ 1 .. 1024 ] characters Example: key01 Ключ, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Список фактов

Получение списка фактов.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_fact_column_type) Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more Example: sort_field=ESSENCE_KEY Название колонки в таблице со фактами.
sort_customfield	string (table_customfields_column_type) Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more Example: sort_customfield=STRING_1 Название дополнительной колонки в таблице.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Request Body schema: application/json
optional

Фильтр фактов.

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

Default: []

Список фильтров.

Responses

Response Schema: application/json

required	Array of objects (table_fact) [ 0 .. 2001 ] items Список связей.
required	object (table_list_counters) Счетчики по списку.

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
}
}
}

Удаление фактов (пачка)

Массовое удаление фактов из файла.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на удаление фактов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Включение фактов

Включение фактов в расчет.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение фактов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Выключение фактов

Выключение фактов из расчета.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение фактов.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Ключ сущности, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Метрики по фактам

Расчет общих метрик по выбранным фактам.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Ключ файла, уникальный идентификатор.

Request Body schema: application/json
required

Данные для расчета метрик. Если указаны ключи сущностей - метрики считаются по ним. Если ключи не указаны - метрики считаются по всем сущностям, которые попадают под фильтры.

keys	Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ] Example: ["key01"] Список ключей сущностей.
	Array of objects (table_fact_filter) [ 0 .. 50 ] items Default: [] Список фильтров.

Responses

Response Schema: application/json

	object (table_fact_fields) Суммарные значения для полей типов int, double, duration.
	object (table_fact_fields) Средние значения для полей типов int, double, duration. Для расчета среднего учитываются только поля, которые имеют значение.
required	object (table_list_counters) Счетчики по списку.

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": "FACT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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": "FACT",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"type": "NEW_LOCATION",
"order_key": "key01",
"demand_key": "key01",
"performer_key": "key01",
"location_key": "key01",
"trip_key": "key01",
"trip_name": "X1-ABC",
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2026-01-21T18:00:00+03:00",
"datetime_1": "2026-01-21T18:00:00+03:00",
"datetime_2": "2026-01-21T18:00:00+03:00",
"datetime_3": "2026-01-21T18:00:00+03:00",
"datetime_4": "2026-01-21T18:00:00+03:00",
"datetime_5": "2026-01-21T18:00:00+03:00",
"datetime_6": "2026-01-21T18:00:00+03:00",
"datetime_7": "2026-01-21T18:00:00+03:00",
"datetime_8": "2026-01-21T18:00:00+03:00",
"datetime_9": "2026-01-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
}
}
}

Analytics

Аналитика и прогноз.

Reports

Отчетность.

User

Пользовательские настройки.

Установка активного ключа настроек пользователя

Установка активного ключа настроек пользователя.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

Ключ настроек, уникальный идентификатор.

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Request samples

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Чтение списка настроек пользователя

Чтение списка ключей настроек пользователя.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Создание настроек пользователя

Создание настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

property name*

additional property

any

Responses

Response Schema: application/json

property name*

additional property

any

Request samples

Payload

Content type

application/json

{"key1": "value1"
}

Response samples

Content type

application/json

{"key1": "value1"
}

Чтение настроек пользователя

Чтение настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

Content type

application/json

{"key1": "value1"
}

Обновление настроек пользователя

Обновление настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

property name*

additional property

any

Responses

Response Schema: application/json

property name*

additional property

any

Request samples

Payload

Content type

application/json

{"key1": "value1"
}

Response samples

Content type

application/json

{"key1": "value1"
}

Удаление настроек пользователя

Удаление всех настроек пользователя.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

CustomFields

Настройки конвертации пользовательских полей.

В таблице предусмотрены дополнительные колонки для отображения значений из атрибутов.

Данная настройка определяет правила конвертации значений атрибутов в соответствующие типизированные поля.

Конвертации происходит при чтении данных - поэтому правила конвертации не влияют на данные и их можно изменять в любой момент.

Установка активного ключа настроек полей

Установка активного ключа настроек полей.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

Ключ настроек, уникальный идентификатор.

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Request samples

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Чтение списка настроек полей

Чтение списка ключей настроек пользовательских полей.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Создание настроек полей

Создание настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Request samples

Payload

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Чтение настроек полей

Чтение настройки пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Обновление настроек полей

Обновление настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/json
required

Новые настройки.

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Responses

Response Schema: application/json

required

Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

Список правил конвертации пользовательских полей.

Request samples

Payload

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Response samples

Content type

application/json

{"rules": [{"entity_type": "LOCATION",
"source_attribute_key": "max_trailer_weight",
"target_customfield": "INT_1",
"translations": {"ru": "Максимальная масса прицепа (кг)",
"en": "Maximum trailer weight (kg)"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_name",
"target_customfield": "STRING_1",
"translations": {"ru": "Название стоянки прицепов",
"en": "Trailer name"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_duration",
"target_customfield": "DURATION_1",
"translations": {"ru": "Время расцепки прицепов",
"en": "Trailer action duration"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_creation_date",
"target_customfield": "DATETIME_1",
"translations": {"ru": "Дата основания",
"en": "Creation Date"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_cost",
"target_customfield": "FLOAT_1",
"translations": {"ru": "Стоимость хранения",
"en": "Storage Cost"
}
},
{"entity_type": "LOCATION",
"source_attribute_key": "trailer_state",
"target_customfield": "BOOL_1",
"translations": {"ru": "Наличие парковки для прицепа",
"en": "Availability of trailer parking"
}
}
]
}

Удаление настроек полей

Удаление настроек пользовательских полей.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

CustomIcons

Настройки иконок.

Установка активного ключа настроек иконок

Установка активного ключа настроек иконок.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Новый ключ.

string (settings_key) [ 1 .. 1024 ] characters

Ключ настроек, уникальный идентификатор.

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Request samples

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Чтение списка настроек иконок

Чтение списка ключей настроек пользовательских иконок.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

settings_keys required	Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ] Example: ["path-key-01"] Список ключей настроек.
active_key	string or null (settings_key_null) [ 1 .. 1024 ] characters Example: "path-key-01" Ключ текущей активной настройки. Ключ из списка `settings_keys` или null (если нет активной настройки).

Response samples

Content type

application/json

{"settings_keys": ["path-key-01"
],
"active_key": "path-key-01"
}

Создание настроек иконок

Создание настроек пользовательских иконок.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Новые настройки.

string <byte> (file_zip)

ZIP-архив с данными.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Чтение настроек иконок

Чтение настройки пользовательских иконок.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP-архив с данными.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Обновление настроек иконок

Обновление настроек пользовательских иконок.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

Request Body schema: application/octet-stream
required

Новые настройки.

string <byte> (file_zip)

ZIP-архив с данными.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Удаление настроек иконок

Удаление настроек пользовательских иконок.

Authorizations:

ApiKeyAuth

path Parameters

settings_key

required

string (settings_key) [ 1 .. 1024 ] characters

Example: path-key-01

Ключ пользовательских настроек, уникальный идентификатор.

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-01-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

CustomScenarios

Настройки сценариев.

System

Системные функции. Вспомогательный функционал, общий для всех сервисов.

Проверка доступности

Проверка доступности сервиса.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

Текущий показатель здоровья сервиса.

0.0 означает неготовность сервиса выполнять задачи.
1.0 означает полную готовность сервиса для выполнения задач.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Получение версии сервиса

Получение версии сервиса.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами. Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. Изменяется при обновлении документации и исправлении ошибок.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

Получение документации

Получение файла с документацией на этот сервис.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

Название файла.

Responses

Response Schema:
text/html

string (file_html)

Файл с данными в формате HTML.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key_one",
"detail": null
}

VRt.Monitor [MT] (7.28.3096)

Описание

Модель состояний рейса

Факты

Диаграмма сущностей

Explorer

Создание папки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Чтение структуры папок

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Обновление папки

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление папки

Authorizations:

path Parameters

Responses

Response samples

Информация о папке

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Получение пути папки

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Создание папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получение ключа папки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Получение ключа файла

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление файлов (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Счетчики файловой системы

Authorizations:

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/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