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

Получает информацию о качестве доставки.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer

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

Query parameters

Name	Description
date	Type: string<date> Дата маршрута, в формате YYYY-MM-DD.
depot_id	Type: integer ID склада, с которого будет начинаться маршрут. Min value: `1`
route_id	Type: integer ID маршрута. Min value: `1`
types	Type: string<list_of_types> Список типов точек, которые будут участвовать в отчёте. Значения перечисляются через запятую. Доступные типы — `order`, `depot`, `garage`. По умолчанию `order`.
with_deleted_couriers	Type: boolean Включить в отчет удаленных курьеров.

Responses

200 OK

Получен отчет о качестве доставки.

Body

application/json

[
    {
        "type": "string",
        "courier_name": "string",
        "courier_number": "string",
        "courier_deleted": false,
        "order_number": "string",
        "order_status": "string",
        "order_address": "string",
        "depot_number": "string",
        "route_number": "string",
        "route_imei": 0,
        "route_imei_str": "string",
        "customer_name": "string",
        "air_distance": 0,
        "arrived_at": "string",
        "left_at": "string",
        "order_visited_at": "string",
        "order_confirmed_at": "string",
        "order_completed_at": "string",
        "order_amount": 0,
        "order_payment_type": "cash",
        "order_payment_status": "paid",
        "far_from_point": false,
        "no_call_before_delivery": false,
        "late_call_before_delivery": false,
        "time_interval_error": 0,
        "delivery_not_in_interval": false,
        "not_in_order": false,
        "suggested_order_number": 0,
        "order_interval": [
            {
                "end": "string",
                "start": "string"
            }
        ],
        "segment_distance_m": 0,
        "used_mark_delivered_radius": 0,
        "order_status_comments": [
            {
                "id": 0,
                "status": "string",
                "comment": "string"
            }
        ],
        "route_routing_mode": "string",
        "route_date": "string",
        "order_weight": 0,
        "order_volume": 0,
        "order_comments": "string",
        "order_shared_with_companies": [
            {
                "id": 0,
                "name": "string",
                "number": "string"
            }
        ],
        "delivery_lat": 0,
        "delivery_lon": 0,
        "lat": 0,
        "lon": 0,
        "refined_lat": 0,
        "refined_lon": 0,
        "transit_idle_duration": 0,
        "location_idle_duration": 0,
        "service_duration_s": 0,
        "shared_service_duration_s": 0,
        "phone": "string",
        "delivery_rating": 0,
        "delivery_comment": "string"
    }
]

(CourierQualityOrderItem or CourierQualityDepotItem or CourierQualityGarageItem)[]

CourierQualityOrderItem

Name	Description
air_distance	Type: number<float> Расстояние между координатами заявки и тем местоположением курьера, в котором курьер перевел заказ в состояние `finished` или `partially_finished`, по прямой в метрах.
arrived_at	Type: string<datetime> Момент времени, когда курьер впервые оказался в указанном радиусе от точки доставки, в формате ISO 8601.
courier_deleted	Type: boolean Статус курьера, удален или нет, выполняющего заказ.
courier_name	Type: string Имя курьера, выполняющего заказ.
courier_number	Type: string ID курьера, выполняющего заказ.
customer_name	Type: string Имя заказчика. Max length: `1023`
delivery_comment	Type: string Комментарий к оценке качества доставки. Max length: `3000`
delivery_lat	Type: number<float> Широта точки вручения заказа.
delivery_lon	Type: number<float> Долгота точки вручения заказа.
delivery_not_in_interval	Type: boolean Признак того, что заказ был выполнен вне согласованного срока. Eсли заказ не был доставлен в указанный срок, возвращает `true`.
delivery_rating	Type: number<int> Оценка качества доставки. Min value: `1` Max value: `5`
depot_number	Type: string Уникальный номер склада, с которого выполнялся заказ.
far_from_point	Type: boolean Признак, указывающий что товары были доставлены далеко от указанной точки. Возвращает значение `true`, если расстояние между фактической и указанной в заказе точкой доставки составляет более 200 метров.
lat	Type: number<float> Широта точки заказа.
late_call_before_delivery	Type: boolean Указывает на поздний звонок клиенту. Возвращает `true`, если звонок был сделан менее чем за 30 минут до завершения заказа.
left_at	Type: string<datetime> Время, когда курьер в последний раз покинул точку доставки, в формате ISO 8601.
location_idle_duration	Type: number<float> Общая продолжительность простоев на точке заказа.
lon	Type: number<float> Долгота точки заказа.
no_call_before_delivery	Type: boolean Указывает, что клиент не получил звонок до завершения заказа. Возвращает `true`, если курьер не позвонил до завершения или отмены заказа.
not_in_order	Type: boolean Указывает, что поставка была выполнена в незапланированном порядке. Возвращает значение `true`, если доставка была выполнена в порядке, отличающемся от указанного в API Мониторинга.
order_address	Type: string Адрес доставки.
order_amount	Type: number<float> Стоимость заказа в рублях.
order_comments	Type: string Комментарии к заказу.
order_completed_at	Type: string<datetime> Время, когда информация о заказе была сохранена, в формате ISO 8601.
order_confirmed_at	Type: string<datetime> Время, когда доставка была согласована и заказ был переведен в статус `confirmed`, в формате ISO 8601.
order_interval	Type: OrderInterval[]
order_number	Type: string Номер заказа в базе данных компании, выполняющей доставку.
order_payment_status	Type: string Состояние оплаты. Возможные значения: `paid` — заказ оплачен. `unpaid` — заказ не оплачен. Enum: `paid`, `unpaid`, `null`
order_payment_type	Type: string Способ оплаты. Возможные значения: `cash` — оплата наличными курьеру. `card`— оплата банковской картой курьеру. `prepaid` — предоплата (заказ был оплачен ранее). `yandex_pay` — оплата заказа через Яндекс Пэй. Снаружи этот способ оплаты задать нельзя. Enum: `cash`, `card`, `prepaid`, `yandex_pay`, `null`
order_shared_with_companies	Type: SharedWithCompany[]
order_status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
order_status_comments	Type: OrderStatusUpdateComment[]
order_visited_at	Type: string<datetime> Дата и время, когда курьер провел `mark_delivered_service_time_coefficient * (order.service_duration_s + order.shared_service_duration_s)` секунд в пределах `mark_delivered_radius` метров от точки доставки. Указано в формате ISO 8601, на основании данных с GPS-трекера или мобильного приложения.
order_volume	Type: number<float> Объем заказа.
order_weight	Type: number<float> Вес заказа.
phone	Type: string Телефон получателя.
refined_lat	Type: number<float> Широта реальной (уточнённой курьером) точки доставки.
refined_lon	Type: number<float> Долгота реальной (уточнённой курьером) точки доставки.
route_date	Type: string<date> Дата маршрута в формате YYYY-MM-DD.
route_imei	Type: integer Номер GPS-трекера курьера, выполняющего заказ.
route_imei_str	Type: string Строковое представление числового номера GPS-трекера. Должно использоваться в случае целочисленного переполнения номера GPS-трекера в используемом языке программирования. Если это поле определено в запросе, его значение имеет приоритет над значением числового поля номера GPS-трекера.
route_number	Type: string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку.
route_routing_mode	Type: string Способ передвижения. Возможные значения: `driving` - курьер управляет автомобилем. `truck` - курьер управляет грузовиком. `transit` - курьер пользуется общественным транспортом и ходит пешком. `walking` - курьер ходит пешком.
segment_distance_m	Type: number<float> Расстояние, пройденное курьером от предыдущей точки маршрута.
service_duration_s	Type: integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату.
shared_service_duration_s	Type: integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. Общая продолжительность обслуживания может включать такие операции, как парковка, доставка документов и другие.
suggested_order_number	Type: number Номер заказа, который должен быть доставлен в соответствии с маршрутом.
time_interval_error	Type: number<float> На сколько было нарушено окно доставки, в секундах.
transit_idle_duration	Type: number<float> Общая продолжительность простоев в пути от предыдущей точки маршрута.
type	Type: string Тип объекта `order`.
used_mark_delivered_radius	Type: number<float> Значение `order.mark_delivered_radius` или `depot.mark_delivered_radius` или `company.mark_delivered_radius`, которое использовалось для пометки заказа как посещенного. Возвращает `null` до тех пор, пока заказ не будет посещен. Max value: `10000`

CourierQualityDepotItem

Name	Description
arrived_at	Type: string<datetime> Момент времени, когда курьер впервые оказался в указанном радиусе от склада, в формате ISO 8601.
courier_deleted	Type: boolean Статус курьера, удален или нет, выполняющего заказ.
courier_name	Type: string Имя курьера, выполняющего заказ.
courier_number	Type: string ID курьера, выполняющего заказ.
depot_number	Type: string Уникальный номер склада.
lat	Type: number<float> Широта точки склада.
left_at	Type: string<datetime> Время, когда курьер в последний раз покинул склад, в формате ISO 8601.
location_idle_duration	Type: number<float> Общая продолжительность простоев на точке склада.
lon	Type: number<float> Долгота точки склада.
route_date	Type: string<date> Дата маршрута в формате YYYY-MM-DD.
route_number	Type: string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку.
segment_distance_m	Type: number<float> Расстояние, пройденное курьером от предыдущей точки маршрута.
service_duration_s	Type: integer Время, затраченное на отправку товара на складе, в секундах. Это время не зависит от времени, необходимого для загрузки заказов.
transit_idle_duration	Type: number<float> Общая продолжительность простоев в пути от предыдущей точки маршрута.
type	Type: string Тип объекта - `depot`.

CourierQualityGarageItem

Name	Description
courier_deleted	Type: boolean Статус курьера, удален или нет, выполняющего заказ.
courier_name	Type: string Имя курьера, выполняющего заказ.
courier_number	Type: string ID курьера, выполняющего заказ.
garage_number	Type: string Уникальный номер гаража.
lat	Type: number<float> Широта точки гаража.
location_idle_duration	Type: number<float> Общая продолжительность простоев на точке гаража.
lon	Type: number<float> Долгота точки гаража.
route_date	Type: string<date> Дата маршрута в формате YYYY-MM-DD.
route_number	Type: string Уникальный номер маршрута, совпадающий с номером в базе данных компании, выполняющей доставку.
segment_distance_m	Type: number<float> Расстояние, пройденное курьером от предыдущей точки маршрута.
transit_idle_duration	Type: number<float> Общая продолжительность простоев в пути от предыдущей точки маршрута.
type	Type: string Тип объекта - `garage`.

OrderInterval

Name

Description

end

Type: string<datetime>

Конец согласованного интервала доставки, в формате ISO 8601.

start

Type: string<datetime>

Начало согласованного окна доставки, в формате ISO 8601.

SharedWithCompany

Name	Description
id	Type: integer ID компании, которая также получит информацию о заказе.
name	Type: string Название компании.
number	Type: string Номер компании.

OrderStatusUpdateComment

Name	Description
comment	Type: string Комментарий к событию обновления статуса заказа.
id	Type: integer ID события обновления статуса заказа.
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.

401 Unauthorized

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

422 Unprocessable Entity

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