---
metadata:
- name: generator
content: Diplodoc Platform v5.52.0
alternate:
- https://yandex.kz/routing/doc/en/vrp/add-task.md
- https://yandex.kz/routing/doc/kk/vrp/add-task.md
- https://yandex.kz/routing/doc/ru/vrp/add-task.md
- href: ru/vrp/add-task.md
type: text/markdown
title: Markdown version
- href: llms.txt
type: text/markdown
title: llms.txt
title: Яндекс Маршрутизация — интеграция с API — структура запроса
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.kz/routing/doc/ru/llms.txt
# Добавление задачи
При планировании через API параметры передаются сервису Маршрутизации в теле запроса в формате JSON. Поставить задачу в очередь на обработку можно с помощью метода `/add/mvrp`, подробнее см. в разделе со [спецификацией](https://yandex.ru/routing/doc/ru/vrp/redoc/index.html#operation/addMVRPTask).
Чтобы получить результат выполнения задачи на нужном языке, добавьте параметр `lang` в конец запроса на добавление задачи. Параметр определяет язык всех полей ответа, включая причины нераспределения заказов. Допустимые значения:
- `ru` — русский язык;
- `en` — английский язык.
**Примеры запроса**:
{% list tabs %}
- С API-ключом
```bash
curl -H "Content-Type: application/json" -X POST -d <тело-запроса> https://courier.yandex.ru/vrs/api/v1/add/mvrp?apikey=<ваш-API-ключ>&lang=ru
```
- С OAuth-токеном
```bash
curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X POST -d <тело-запроса> https://courier.yandex.ru/api/v1/vrs/add/mvrp?lang=ru
```
{% endlist %}
Для отправки API-запросов вы можете использовать коллекцию [Routing API](https://doc-static.yandex.net/src/dev/routing/postman-collection/routeq-api-postman-collection-ru.zip). Подробнее о том, как загрузить коллекцию в Postman или Bruno, см. на странице [Работа с готовой коллекцией запросов](https://yandex.kz/routing/doc/ru/vrp/upload-api-collection.md).
## Описание тела запроса {#request-structure}
{% cut "Структура JSON" %}
```json
{
"depot": {
// Описывает склад, если он один.
},
"depots": [
// Описывает склады, если их несколько.
],
"locations": [
// Описывает заказы.
],
"vehicles": [
// Описывает транспортные средства.
"planned_route": {
// Описывает заранее запланированные пункты назначения без указания последовательности посещения.
}
],
"options": {
// Описывает опции маршрутизации.
"incompatible_load_types": [
// Описывает несовместимые типы заказов.
],
"location_groups": [
// Описывает группы заказов.
]
},
"zones": [
// Описывает геозоны (если не используются геозоны из интерфейса).
]
}
```
{% endcut %}
#|
||**Объект/массив** | **Описание** | **Соответствие листам Excel** | **Обязательность** ||
||`depot`
`depots` | [Склад](https://yandex.kz/routing/doc/ru/vrp/properties-of-depot.md)
**Depot** и **Depots** — взаимоисключающие объекты, допускается только один из них. | [Depot или Depots](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#depot-depots) | ||
||`locations` | [Заказ](https://yandex.kz/routing/doc/ru/vrp/properties-of-orders.md) | [Orders](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#orders) | ||
||`vehicles` | [Транспортное средство](https://yandex.kz/routing/doc/ru/vrp/properties-of-vehicles.md) | [Vehicles](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#vehicles) | ||
||`planned_route` | [Запланированный маршрут](https://yandex.kz/routing/doc/ru/vrp/properties-of-vehicles-routes.md#planned-route) | [Routes](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#routes) | ||
||`options` | [Опции маршрутизации](https://yandex.kz/routing/doc/ru/vrp/routing-options_index-page.md) | [Options](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#options) | ||
||`incompatible_load_types` | [Несовместимость заказов](https://yandex.kz/routing/doc/ru/vrp/properties-of-orders.md) | [Incompatible_order_types](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#incompatible-order-types) | ||
||`location_groups` | [Группировка заказов](https://yandex.kz/routing/doc/ru/vrp/grouping-locations.md) | [Location_groups](https://yandex.kz/routing/doc/ru/vrp/excel-fill-guide.md#location-groups) | ||
||`zones` | [Геозоны](https://yandex.kz/routing/doc/ru/vrp/geozones.md) | - | ||
|#
\* Обязательные объекты/массивы объектов при планировании через API. Не относится к соответствующим листам Excel.
{% note info %}
Объекты в теле запроса могут включать ссылки на [пресеты](https://yandex.kz/routing/doc/ru/vrp/presets.md) (заранее определенные наборы настроек).
{% endnote %}
Минимальный набор параметров по каждому из объектов:
- склады `depots`:
- идентификатор `id`;
- координаты `point.lat`, `point.lon`;
- временное окно `time_window` или несколько временных окон `time_windows`, если склад работает с перерывами.
- заказы `locations`:
- идентификатор `id`;
- координаты `point.lat`, `point.lon`;
- временное окно выполнения заказа `time_window` или несколько временных окон `time_windows`;
- жесткость временного окна `hard_window`;
- сервисное время (время на выполнение заказа) `service_duration_s`.
- курьеры и автомобили `vehicles`:
- идентификатор `id`;
- способ передвижения (пешком, на общественном транспорте, на легковом или грузовом автомобиле) `routing_mode`;
- необходимость возврата на склад после завершения маршрута `return_to_depot`.
- параметры алгоритма планирования `options`:
- часовой пояс `time_zone`.
## Остановка задачи {#stop-planning}
Чтобы остановить задачу планирования до ее завершения, отправьте запрос с помощью метода [/cancel/mvrp](https://yandex.ru/routing/doc/ru/vrp/redoc/index.html#operation/postMVRPTaskCancel).
В запросе укажите:
* `id` — ID задачи;
* `apikey` — API-ключ, который указан в настройках компании. Подробнее об API-ключах см. в разделе [Ключ API](https://yandex.kz/routing/doc/ru/vrp/authorization.md#api-key).
**Запрос:**
```
curl -X POST https://courier.yandex.ru/vrs/api/v1/cancel/mvrp/{id-задачи}?apikey= -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-OAuth-токен>"
```
Написать в службу поддержки