Получает информацию о заказе

Получает информацию о заказах на определенную дату.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

Name	Description
date	Type: string<date> Дата доставки заказа в формате YYYY-MM-DD. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба).
depot_id	Type: integer<int64> ID склада, используемый в запросах к API Мониторинга. Min value: `1`
order_number	Type: string Номер заказа в учетной системе компании, выполняющей доставку. В запросе обязательно должен присутствовать параметр 'date' или 'order_number' (или оба).
route_id	Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга.

Responses

200 OK

Список заказов получен.

Body

application/json

[
    {
        "address": "string",
        "comments": "string",
        "confirmed_at": "string",
        "courier_name": "string",
        "courier_number": "string",
        "customer_name": "string",
        "delivered_at": "string",
        "depot_id": 0,
        "depot_number": "string",
        "description": "string",
        "lat": 0,
        "lon": 0,
        "order_id": 0,
        "order_number": "string",
        "phone": "string",
        "route_number": "string",
        "status": "string",
        "status_log": [
            {
                "point": {
                    "lat": 0,
                    "lon": 0
                },
                "status": "string",
                "timestamp": 0
            }
        ],
        "time_interval": "string"
    }
]

VerificationItem[]

VerificationItem

Name	Description
address	Type: string Адрес доставки в текстовом формате. Max length: `1023`
comments	Type: string Комментарии к заказу.
confirmed_at	Type: string<datetime> Время подтверждения заказа, в формате ISO 8601.
courier_name	Type: string Имя курьера. Max length: `255`
courier_number	Type: string Уникальный номер курьера, совпадающий с номером в базе данных компании, выполняющей доставку.
customer_name	Type: string Имя заказчика. Max length: `1023`
delivered_at	Type: string<datetime> Время доставки заказа, в формате ISO 8601.
depot_id	Type: integer<int64> ID склада, используемый в запросах к API Мониторинга.
depot_number	Type: string Уникальный номер склада, совпадающий с номером в базе данных компании, выполняющей доставку.
description	Type: string Описание заказа. Max length: `1023`
lat	Type: number<float> Широта точки доставки.
lon	Type: number<float> Долгота точки доставки.
order_id	Type: integer<int64> ID заказа, используемый в запросах к API Мониторинга.
order_number	Type: string Уникальный номер заказа, совпадающий с номером в базе данных компании, выполняющей доставку.
phone	Type: string Номер телефона клиента, если вы не используете сущность Customer.
route_number	Type: string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку.
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
status_log	Type: StatusLog[] Информация об изменениях в статусе заказа.
time_interval	Type: string Желаемый интервал времени доставки в формате "T - T" или "T-T", где T – время в формате HH, HH:MM или HH:MM:SS.

StatusLog

Name	Description
point	Type: StatusLogLocation
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
timestamp	Type: number<float> UNIX timestamp времени внесения изменений.

StatusLogLocation

Name

Description

lat

Type: number<float>

Широта точки внесения изменений.

lon

Type: number<float>

Долгота точки внесения изменений.

401 Unauthorized

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

403 Forbidden

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

422 Unprocessable Entity

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

504 Gateway Timeout

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

Was the article helpful?

Обзор