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

Ресурсы API

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

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/order-notifications\
?from={string}\
&to={string}\
&page={integer}

Path-параметры

company_id *

integer

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

* Обязательный параметр

Query-параметры

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

* Обязательный параметр

Ответы

Код 200

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

[
  {
    "eta": string,
    "id": integer,
    "order_id": integer,
    "order_number": string,
    "owner_company_id": integer,
    "owner_company_name": string,
    "route_id": integer,
    "route_number": string,
    "time": string,
    "type": string,
    "widget_url": string
  }
]
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

eta	string Ожидаемое время до места назначения на момент создания уведомления, в формате ISO 8601. Может вернуть `null`, если курьер нарушил предопределенную последовательность заказов или если время доставки еще не было вычислено.
id	integer ID уведомления.
order_id	integer ID заказа, используемый в запросах к API Мониторинга.
order_number	string Номер заказа в базе данных компании, выполняющей доставку.
owner_company_id	integer ID компании, создавшей заказ.
owner_company_name	string Название компании, создавшей заказ.
route_id	integer ID маршрута, используемый в запросах к API Мониторинга.
route_number	string Номер маршрута в базе данных компании, выполняющей доставку.
time	string Время на сервере на момент создания объекта уведомления, в формате ISO 8601.
type	string Тип уведомления. Возможные значения: shift_start, nearby.
widget_url	string URL виджета отслеживания транспортных средств.

* Обязательный параметр

Код 401

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

Код 403

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

Код 422

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

Пример

Responses:

{
  "time": "2020-03-06T17:15:10+03:00"
}
Скопировано

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

order-notifications

orders

В этой статье

HTTP-запрос Path-параметры Query-параметры Ответы Код 200 Представление Поля Код 401 Код 403 Код 422 Пример

order-notifications

orders