Редактирует несколько маршрутов

Добавляет информацию о новых маршрутах в базу данных или обновляет информацию о существующих при совпадении их номеров.

Request

POST

https://courier.yandex.ru/api/v1/companies/{company_id}/routes-batch

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании, используемый в запросах к API Мониторинга.

Body

application/json

[
    {
        "custom_fields": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "date": "string",
        "id": 0,
        "imei": 0,
        "rented_courier_id": "string",
        "imei_str": "string",
        "number": "string",
        "route_start": "string",
        "route_finish": "string",
        "routing_mode": "string",
        "tracking_start_h": 0,
        "courier_id": 0,
        "courier_number": "string",
        "depot_id": 0,
        "depot_number": "string"
    }
]

RouteModify[]

RouteModify

Name	Description
courier_id	Type: integer<int64> ID курьера, выполняющего доставку по маршруту. Запрос должен содержать `courier_id` или `courier_number`. Если указаны и `courier_id`, и `courier_number`, используется `courier_number`.
courier_number	Type: string Номер курьера. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать `courier_id` или `courier_number`. Если указаны и `courier_id`, и `courier_number`, используется `courier_number`.
custom_fields	Type: CustomField[] Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10. Min items: `0` Max items: `10`
date	Type: string<date> Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте.
depot_id	Type: integer<int64> ID склада, с которого будет начинаться маршрут. Запрос должен содержать `depot_id` или `depot_number`. Если указаны и `depot_id`, и `depot_number`, используется `depot_number`.
depot_number	Type: string Номер склада. Используется для синхронизации с учетной системой компании, выполняющей доставку. Запрос должен содержать `depot_id` или `depot_number`. Если указаны и `depot_id`, и `depot_number`, используется `depot_number`.
id	Type: integer ID маршрута, используемый в запросах к API Мониторинга.
imei	Type: integer Номер GPS трекера, установленного на транспортном средстве, выполняющем маршрут.
imei_str	Type: string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера.
number	Type: string Номер маршрута. Используется для синхронизации с учетной системой компании, выполняющей доставку.
rented_courier_id	Type: string ID нанятого курьера, используемый в запросах к API Мониторинга.
route_finish	Type: string Время окончания маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано, позиции курьеров, отправленные GPS-трекерами и приложением, будут записаны только до указанного времени.
route_start	Type: string Время начала маршрута относительно `date`, в формате [d.]HH:MM:SS. Если указано: GPS-трекеры и приложения начнут записывать информацию только после `route_start - tracking_start_h`. Событие START истории заказов будет добавлено в историю заказов только после указанного времени. SMS-уведомления об изменении статуса заказа, если они включены, будут отправляться клиентам только по истечении указанного времени.
routing_mode	Type: string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
tracking_start_h	Type: integer<int32> Отслеживание маршрута начнётся за `tracking_start_h` часов до начала маршрута. Если `route.route_start` определено, GPS-трекеры и приложения начнут записывать информацию только после `route.route_start - route.tracking_start_h`, если `route.tracking_start_h` определено, иначе после `route.route_start - company.tracking_start_h`. Min value: `0` Max value: `24`

CustomField

Name

Description

key

Type: string

Ключ пользовательского поля. Должен соответствовать одному из пользовательский полей маршрута, заданных в настройках компании.

Max length: 255

value

Type: string

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

Max length: 255

Responses

200 OK

Информация о маршрутах зарегистрирована в базе данных или обновлена.

401 Unauthorized

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

403 Forbidden

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

404 Not Found

Ошибка поиска объекта. Объект не найден.

422 Unprocessable Entity

Неверный ввод. Операция не может быть выполнена.

504 Gateway Timeout

Ошибка при работе с API. Повторите запрос.

Was the article helpful?

Добавляет маршрут

Удаляет маршрут