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

Ресурсы API

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

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/courier-quality\
?date={string}\
&depot_id={integer}\
&route_id={integer}\
&types={string}\
&with_deleted_couriers={boolean}

Path-параметры

company_id *

integer

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

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

Query-параметры

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

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

Ответы

Код 200

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

{
  "air_distance": number,
  "arrived_at": string,
  "courier_deleted": boolean,
  "courier_name": string,
  "courier_number": string,
  "customer_name": string,
  "delivery_comment": string,
  "delivery_lat": number,
  "delivery_lon": number,
  "delivery_not_in_interval": boolean,
  "delivery_rating": number,
  "depot_number": string,
  "far_from_point": boolean,
  "garage_number": string,
  "lat": number,
  "late_call_before_delivery": boolean,
  "left_at": string,
  "location_idle_duration": number,
  "lon": number,
  "no_call_before_delivery": boolean,
  "not_in_order": boolean,
  "order_address": string,
  "order_comments": string,
  "order_completed_at": string,
  "order_confirmed_at": string,
  "order_interval": [
    {
      "end": string,
      "start": string
    }
  ],
  "order_number": string,
  "order_payment_status": string,
  "order_payment_type": string,
  "order_shared_with_companies": [
    {
      "id": integer,
      "name": string,
      "number": string
    }
  ],
  "order_status": string,
  "order_status_comments": [
    {
      "comment": string,
      "id": integer,
      "status": string
    }
  ],
  "order_visited_at": string,
  "order_volume": number,
  "order_weight": number,
  "phone": string,
  "refined_lat": number,
  "refined_lon": number,
  "route_date": string,
  "route_imei": integer,
  "route_imei_str": string,
  "route_number": string,
  "route_routing_mode": string,
  "segment_distance_m": number,
  "service_duration_s": integer,
  "shared_service_duration_s": integer,
  "suggested_order_number": number,
  "time_interval_error": number,
  "transit_idle_duration": number,
  "type": string,
  "used_mark_delivered_radius": number
}
Скопировано

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

Свернуть всё

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

Поля

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

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

Код 401

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

Код 422

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

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

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

courier_report

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

В этой статье

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

courier_report

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