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

Удаляет информацию об указанном маршруте из базы данных.

Request

DELETE

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

Path parameters

Name

Description

company_id*

Type: integer

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

route_id*

Type: integer

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

Responses

200 OK

Информация о маршруте удалена.

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_violated_route": false,
    "company_id": 0,
    "courier_id": 0,
    "depot_id": 0
}

Name	Description
company_id	Type: integer ID компании, используемый в запросах к API Мониторинга.
courier_id	Type: integer ID курьера, выполняющего доставку по маршруту.
courier_violated_route	Type: boolean Указывает, посещает ли курьер заказы в порядке, отличном от предопределенной последовательности заказов.
custom_fields	Type: CustomField[] Список пользовательских полей маршрута. Максимальное количество пользовательских полей - 10. Max items: `10`
date	Type: string<date> Дата исполнения маршрута в формате YYYY-MM-DD. Нельзя менять при наличии заказов в маршруте.
depot_id	Type: integer ID склада, с которого будет начинаться маршрут.
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 Отслеживание маршрута начнётся за `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`. Max value: `24`

CustomField

Name

Description

key

Type: string

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

Max length: 255

value

Type: string

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

Max length: 255

401 Unauthorized

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

403 Forbidden

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

404 Not Found

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

422 Unprocessable Entity

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

504 Gateway Timeout

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