Получает информацию о качестве доставки
Получает информацию о качестве доставки.
Request
GET
https://courier.yandex.ru/api/v1/companies/{company_id}/courier-quality
Path parameters
Name |
Description |
company_id* |
Type: integer<int64> ID компании, используемый в запросах к API Мониторинга. |
Query parameters
Name |
Description |
date |
Type: string<date> Дата маршрута, в формате YYYY-MM-DD. |
depot_id |
Type: integer<int64> ID склада, с которого будет начинаться маршрут. Min value: |
route_id |
Type: integer<int64> ID маршрута. Min value: |
types |
Type: string<list_of_types> Список типов точек, которые будут участвовать в отчёте. Значения перечисляются через запятую. Доступные типы — |
with_deleted_couriers |
Type: boolean Включить в отчет удаленных курьеров. Default: |
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> Расстояние между координатами заявки и тем местоположением курьера, в котором курьер перевел заказ в состояние |
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: |
delivery_comment |
Type: string Комментарий к оценке качества доставки. Max length: |
delivery_lat |
Type: number<float> Широта точки вручения заказа. |
delivery_lon |
Type: number<float> Долгота точки вручения заказа. |
delivery_not_in_interval |
Type: boolean Признак того, что заказ был выполнен вне согласованного срока. Eсли заказ не был доставлен в указанный срок, возвращает |
delivery_rating |
Type: integer<int32> Оценка качества доставки. Min value: Max value: |
depot_number |
Type: string Уникальный номер склада, с которого выполнялся заказ. |
far_from_point |
Type: boolean Признак, указывающий что товары были доставлены далеко от указанной точки. Возвращает значение |
lat |
Type: number<float> Широта точки заказа. |
late_call_before_delivery |
Type: boolean Указывает на поздний звонок клиенту. Возвращает |
left_at |
Type: string<datetime> Время, когда курьер в последний раз покинул точку доставки, в формате ISO 8601. |
location_idle_duration |
Type: number<float> Общая продолжительность простоев на точке заказа. |
lon |
Type: number<float> Долгота точки заказа. |
no_call_before_delivery |
Type: boolean Указывает, что клиент не получил звонок до завершения заказа. Возвращает |
not_in_order |
Type: boolean Указывает, что поставка была выполнена в незапланированном порядке. Возвращает значение |
order_address |
Type: string Адрес доставки. |
order_amount |
Type: number<float> Стоимость заказа в рублях. Min value: |
order_comments |
Type: string Комментарии к заказу. |
order_completed_at |
Type: string<datetime> Время, когда информация о заказе была сохранена, в формате ISO 8601. |
order_confirmed_at |
Type: string<datetime> Время, когда доставка была согласована и заказ был переведен в статус |
order_interval |
Type: OrderInterval[] |
order_number |
Type: string Номер заказа в базе данных компании, выполняющей доставку. |
order_payment_status |
Type: string Состояние оплаты. Возможные значения:
Enum: |
order_payment_type |
Type: string Способ оплаты. Возможные значения:
Enum: |
order_shared_with_companies |
Type: SharedWithCompany[] |
order_status |
Type: string Текущий статус заказа. Возможные значения:
|
order_status_comments |
Type: OrderStatusUpdateComment[] |
order_visited_at |
Type: string<datetime> Дата и время, когда курьер провел |
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 Способ передвижения. Возможные значения:
|
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 Тип объекта |
used_mark_delivered_radius |
Type: number<float> Значение Min value: Max value: |
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 Тип объекта - |
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 Тип объекта - |
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 Текущий статус заказа. Возможные значения:
|
401 Unauthorized
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
422 Unprocessable Entity
Неверный ввод. Операция не может быть выполнена.
No longer supported, please use an alternative and newer version.