Задает порядок доставки заказов в маршруте

Набор заказов должен включать в себя все заказы маршрута. Чтобы задать последовательность, можно использовать либо список с ID заказов '[id1, id2, ...]', либо объект с ID заказов '{"order_ids": [id1, id2, ...]}', либо объект с номерами заказов '{"order_numbers": ["number1", "number2", ...]}'.

Request

POST

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

Path parameters

Name

Description

company_id*

Type: integer

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

route_id*

Type: integer

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

Body

application/json
[
    4789,
    4790,
    5245
]

integer[]

Responses

200 OK

Маршрут успешно построен в указанном порядке.

401 Unauthorized

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

403 Forbidden

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

404 Not Found

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

409 Conflict

Не удается задать маршрут доставки в указанном порядке, так как некоторые заказы уже были доставлены. Ответ содержит информацию об ошибке и о том, с чего начать последовательность доставки.

422 Unprocessable Entity

Неверный ввод, например отсутствуют обязательные параметры или список заказов не соответствует списку заказов в маршруте. Операция не может быть выполнена.

504 Gateway Timeout

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