Редактирует несколько маршрутов
Добавляет информацию о новых маршрутах в базу данных или обновляет информацию о существующих при совпадении их номеров.
HTTP-запрос
POST https://courier.yandex.ru/api/v1/companies/{company_id}/routes-batch
Path-параметры
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
* Обязательный параметр
Тело запроса
[ { "courier_id": integer, "courier_number": string, "custom_fields": [ { "key": string, "value": string } ], "date": string, "depot_id": integer, "depot_number": string, "id": integer, "imei": integer, "imei_str": string, "number": string, "rented_courier_id": string, "route_finish": string, "route_start": string, "routing_mode": string, "tracking_start_h": integer } ]
Скопировано
Представление
Поля
custom_fields[] | array Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10. |
custom_fields[]. | string Ключ пользовательского поля. Должен соответствовать одному из пользовательский полей маршрута, заданных в настройках компании. |
custom_fields[]. | string Значение пользовательского поля. |
date | string Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте. |
id | integer ID маршрута, используемый в запросах к API Мониторинга. |
imei | integer Номер GPS трекера, установленного на транспортном средстве, выполняющем маршрут. |
imei_str | string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера. |
number | string Номер маршрута. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
rented_courier_id | string ID нанятого курьера, используемый в запросах к API Мониторинга. |
route_finish | string Время окончания маршрута относительно |
route_start | string Время начала маршрута относительно
|
routing_mode | string Способ передвижения. Возможные значения:
|
tracking_start_h | integer Отслеживание маршрута начнётся за Минимальное значение: |
courier_id | integer ID курьера, выполняющего доставку по маршруту. Запрос должен содержать |
courier_number | string Номер курьера. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать |
depot_id | integer ID склада, с которого будет начинаться маршрут. Запрос должен содержать |
depot_number | string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать |
custom_fields[] | array Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10. |
custom_fields[]. | string Ключ пользовательского поля. Должен соответствовать одному из пользовательский полей маршрута, заданных в настройках компании. |
custom_fields[]. | string Значение пользовательского поля. |
date | string Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте. |
id | integer ID маршрута, используемый в запросах к API Мониторинга. |
imei | integer Номер GPS трекера, установленного на транспортном средстве, выполняющем маршрут. |
imei_str | string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера. |
number | string Номер маршрута. Используется для синхронизации с учетной системой компании, выполняющей доставку. |
rented_courier_id | string ID нанятого курьера, используемый в запросах к API Мониторинга. |
route_finish | string Время окончания маршрута относительно |
route_start | string Время начала маршрута относительно
|
routing_mode | string Способ передвижения. Возможные значения:
|
tracking_start_h | integer Отслеживание маршрута начнётся за Минимальное значение: |
courier_id | integer ID курьера, выполняющего доставку по маршруту. Запрос должен содержать |
courier_number | string Номер курьера. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать |
depot_id | integer ID склада, с которого будет начинаться маршрут. Запрос должен содержать |
depot_number | string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать |
* Обязательный параметр
Ответы
Код 200
Информация о маршрутах зарегистрирована в базе данных или обновлена.
Код 401
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
Код 403
Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.
Код 404
Ошибка поиска объекта. Объект не найден.
Код 422
Неверный ввод. Операция не может быть выполнена.
Код 504
Ошибка при работе с API. Повторите запрос.