Получает уведомления о заказе

Возвращает список объектов уведомлений о заказах, созданных в течение указанного интервала времени. Чтобы гарантировать, что запрос с одной и той же парой from / to, отправленный в разное время, возвращает один и тот же список объектов уведомления, to должно быть не менее двух минут в прошлом. Максимально допустимый интервал времени между from и to составляет 30 минут.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/order-notifications

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

Name	Description
from*	Type: string<datetime> Начало временного интервала, за который запрашиваются уведомления, в формате ISO 8601. Например - '2020-09-06T10:15:00+03:00'.
to*	Type: string<datetime> Конец временного интервала, за который запрашиваются уведомления, в формате ISO 8601. Например - '2020-09-06T10:20:00+03:00'.
page	Type: integer Номер страницы базы данных. Каждая страница содержит 1000 объектов уведомлений, упорядоченных по времени создания. Default: `1` Min value: `1`

Responses

200 OK

Список объектов уведомлений, созданных между from и to (from <= время создания < to). Объекты уведомлений предоставляются как для заказов, принадлежащих компании, так и для заказов, совместно используемых компанией.

Body

application/json

[
    {
        "id": 0,
        "type": "string",
        "eta": "string",
        "time": "2020-03-06T14:15:10.000Z",
        "widget_url": "string",
        "order_id": 0,
        "order_number": "string",
        "route_id": 0,
        "route_number": "string",
        "owner_company_id": 0,
        "owner_company_name": "string"
    }
]

OrderNotificationsItem[]

OrderNotificationsItem

Name	Description
eta	Type: string Ожидаемое время до места назначения на момент создания уведомления, в формате ISO 8601. Может вернуть `null`, если курьер нарушил предопределенную последовательность заказов или если время доставки еще не было вычислено.
id	Type: integer ID уведомления.
order_id	Type: integer<int64> ID заказа, используемый в запросах к API Мониторинга.
order_number	Type: string Номер заказа в базе данных компании, выполняющей доставку.
owner_company_id	Type: integer<int64> ID компании, создавшей заказ.
owner_company_name	Type: string Название компании, создавшей заказ.
route_id	Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга.
route_number	Type: string Номер маршрута в базе данных компании, выполняющей доставку.
time	Type: string<datetime> Время на сервере на момент создания объекта уведомления, в формате ISO 8601. Example: `Fri Mar 06 2020 17:15:10 GMT+0300 (Moscow Standard Time)`
type	Type: string Тип уведомления. Возможные значения: shift_start, nearby.
widget_url	Type: string URL виджета отслеживания транспортных средств.

401 Unauthorized

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

403 Forbidden

У вас нет доступа к этому объекту.

422 Unprocessable Entity

Ошибка в вводных данных. Например, from и to отстоят друг от друга более чем на 30 минут.