Получает информацию о заказе
Получает информацию о заказах на определенную дату.
HTTP-запрос
GET https://courier.yandex.ru/api/v1/companies/{company_id}/verification\
?date={string}\
&order_number={string}\
&depot_id={integer}\
&route_id={integer}
Path-параметры
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
* Обязательный параметр
Query-параметры
date | string Дата доставки заказа в формате YYYY-MM-DD. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба). |
order_number | string Номер заказа в учетной системе компании, выполняющей доставку. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба). |
depot_id | integer ID склада, используемый в запросах к API Мониторинга. Минимальное значение: |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
date | string Дата доставки заказа в формате YYYY-MM-DD. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба). |
order_number | string Номер заказа в учетной системе компании, выполняющей доставку. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба). |
depot_id | integer ID склада, используемый в запросах к API Мониторинга. Минимальное значение: |
route_id | integer ID маршрута, используемый в запросах к API Мониторинга. |
* Обязательный параметр
Ответы
Код 200
Список заказов получен.
[ { "address": string, "comments": string, "confirmed_at": string, "courier_name": string, "courier_number": string, "customer_name": string, "delivered_at": string, "depot_id": integer, "depot_number": string, "description": string, "lat": number, "lon": number, "order_id": integer, "order_number": string, "phone": string, "route_number": string, "status": string, "status_log": [ { "point": { "lat": number, "lon": number }, "status": string, "timestamp": number } ], "time_interval": string } ]
Скопировано
Представление
Поля
address | string Адрес доставки в текстовом формате. |
comments | string Комментарии к заказу. |
confirmed_at | string Время подтверждения заказа, в формате ISO 8601. |
courier_name | string Имя курьера. |
courier_number | string Уникальный номер курьера, совпадающий с номером в базе данных компании, выполняющей доставку. |
customer_name | string Имя заказчика. |
delivered_at | string Время доставки заказа, в формате ISO 8601. |
depot_id | integer ID склада, используемый в запросах к API Мониторинга. |
depot_number | string Уникальный номер склада, совпадающий с номером в базе данных компании, выполняющей доставку. |
description | string Описание заказа. |
lat | number Широта точки доставки. |
lon | number Долгота точки доставки. |
order_id | integer ID заказа, используемый в запросах к API Мониторинга. |
order_number | string Уникальный номер заказа, совпадающий с номером в базе данных компании, выполняющей доставку. |
phone | string Номер телефона клиента, если вы не используете сущность Customer. |
route_number | string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку. |
status | string Текущий статус заказа. Возможные значения:
|
status_log[] | array Информация об изменениях в статусе заказа. |
status_log[]. | object |
status_log[]. | number Широта точки внесения изменений. |
status_log[]. | number Долгота точки внесения изменений. |
status_log[]. | string Текущий статус заказа. Возможные значения:
|
status_log[]. | number UNIX timestamp времени внесения изменений. |
time_interval | string Желаемый интервал времени доставки в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS. |
address | string Адрес доставки в текстовом формате. |
comments | string Комментарии к заказу. |
confirmed_at | string Время подтверждения заказа, в формате ISO 8601. |
courier_name | string Имя курьера. |
courier_number | string Уникальный номер курьера, совпадающий с номером в базе данных компании, выполняющей доставку. |
customer_name | string Имя заказчика. |
delivered_at | string Время доставки заказа, в формате ISO 8601. |
depot_id | integer ID склада, используемый в запросах к API Мониторинга. |
depot_number | string Уникальный номер склада, совпадающий с номером в базе данных компании, выполняющей доставку. |
description | string Описание заказа. |
lat | number Широта точки доставки. |
lon | number Долгота точки доставки. |
order_id | integer ID заказа, используемый в запросах к API Мониторинга. |
order_number | string Уникальный номер заказа, совпадающий с номером в базе данных компании, выполняющей доставку. |
phone | string Номер телефона клиента, если вы не используете сущность Customer. |
route_number | string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку. |
status | string Текущий статус заказа. Возможные значения:
|
status_log[] | array Информация об изменениях в статусе заказа. |
status_log[]. | object |
status_log[]. | number Широта точки внесения изменений. |
status_log[]. | number Долгота точки внесения изменений. |
status_log[]. | string Текущий статус заказа. Возможные значения:
|
status_log[]. | number UNIX timestamp времени внесения изменений. |
time_interval | string Желаемый интервал времени доставки в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS. |
* Обязательный параметр
Код 401
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
Код 403
У вас нет доступа к этому объекту.
Код 422
Неверный ввод. Операция не может быть выполнена.
Код 504
Ошибка при работе с API. Повторите запрос.