Gets delivery quality information with pagination
Gets information about the delivery quality with pagination.
Request
GET
https://courier.yandex.ru/api/v2/companies/{company_id}/courier-quality
Path parameters
Name |
Description |
company_id* |
Type: integer Company ID used in requests to the Track & Trace API. |
Query parameters
Name |
Description |
date |
Type: string<date> The route's date in YYYY-MM-DD format. Fields |
depot_id |
Type: integer ID of the depot where the route starts. Min value: |
max_results |
Type: integer Maximum number of entities to be returned. Default: Min value: Max value: |
page_token |
Type: string Pagination token, can either be omitted or equal to next_page_token from the body of previos response. |
route_id |
Type: integer ID of the route. Fields Min value: |
types |
Type: string<list_of_types> Comma-separated list of point types to use in report. Available types are "order", "depot", "garage". Default "order". |
with_deleted_couriers |
Type: boolean Include deleted couriers in the report. |
Responses
200 OK
Report on the delivery quality received.
Body
application/json
{
"next_page_token": "string",
"results": [
{
"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"
},
{
"type": "string",
"route_date": "string",
"route_number": "string",
"courier_name": "string",
"courier_number": "string",
"courier_deleted": false,
"depot_number": "string",
"segment_distance_m": 0,
"lat": 0,
"lon": 0,
"arrived_at": "string",
"left_at": "string",
"transit_idle_duration": 0,
"location_idle_duration": 0,
"service_duration_s": 0
},
{
"type": "string",
"route_date": "string",
"route_number": "string",
"courier_name": "string",
"courier_number": "string",
"courier_deleted": false,
"garage_number": "string",
"lat": 0,
"lon": 0,
"segment_distance_m": 0,
"transit_idle_duration": 0,
"location_idle_duration": 0
}
]
}
Name |
Description |
results* |
Type: (CourierQualityOrderItem or CourierQualityDepotItem or CourierQualityGarageItem)[] |
next_page_token |
Type: string If present, then there is a next page, and, to get the next page, this url can be called with |
CourierQualityOrderItem
Name |
Description |
air_distance |
Type: number<float> The distance between the order coordinates and the courier location in which the order status was changed to |
arrived_at |
Type: string<datetime> The time when the courier first entered the area in the specified radius from the delivery point, in ISO 8601 format. |
courier_deleted |
Type: boolean Courier status, deleted or not. |
courier_name |
Type: string Name of the courier fulfilling the order. |
courier_number |
Type: string ID of the courier fulfilling the order. |
customer_name |
Type: string Customer's name. Max length: |
delivery_comment |
Type: string Order delivery rating comment. Max length: |
delivery_lat |
Type: number<float> Latitude of order delivery location. |
delivery_lon |
Type: number<float> Longitude of order delivery location. |
delivery_not_in_interval |
Type: boolean Indicates whether the order was completed outside of the agreed timeframe. Returns |
delivery_rating |
Type: number<int> Order delivery rating. Min value: Max value: |
depot_number |
Type: string The unique number of the depot that handles the order. |
far_from_point |
Type: boolean Indicates that items were delivered far away from the specified point. Returns |
lat |
Type: number<float> Latitude of order location. |
late_call_before_delivery |
Type: boolean Indicates that the call to the customer was late. Returns |
left_at |
Type: string<datetime> The time when the courier last left the delivery point, in ISO 8601 format. |
location_idle_duration |
Type: number<float> Duration of idle events at order location. |
lon |
Type: number<float> Longitude of order location. |
no_call_before_delivery |
Type: boolean Indicates that the customer didn't get a call before the order was completed. Returns |
not_in_order |
Type: boolean Indicates that the delivery was completed in an unexpected order. Returns |
order_address |
Type: string Order delivery address. |
order_amount |
Type: number<float> Order price in rubles. |
order_comments |
Type: string Order comments. |
order_completed_at |
Type: string<datetime> The time when information about the order was recorded, in ISO 8601 format. |
order_confirmed_at |
Type: string<datetime> Time when delivery was agreed on and the order was switched to the |
order_interval |
Type: OrderInterval[] |
order_number |
Type: string Order number in the delivery company database. |
order_payment_status |
Type: string Payment status. Possible values:
Enum: |
order_payment_type |
Type: string Payment method. Possible values:
Enum: |
order_shared_with_companies |
Type: SharedWithCompany[] |
order_status |
Type: string The current order status. Possible values:
|
order_status_comments |
Type: OrderStatusUpdateComment[] |
order_visited_at |
Type: string<datetime> Date and time when the courier spent |
order_volume |
Type: number<float> Order volume. |
order_weight |
Type: number<float> Order weight. |
phone |
Type: string The recipient's phone number. |
refined_lat |
Type: number<float> Latitude of the real (refined by courier) delivery point. |
refined_lon |
Type: number<float> Logitude of the real (refined by courier) delivery point. |
route_date |
Type: string<date> The route's date in YYYY-MM-DD format. |
route_imei |
Type: integer The number of the GPS tracker of the courier fulfilling the order. |
route_imei_str |
Type: string String representation of numeric number of a GPS tracker. Should be used in case integer overflow of numeric number of a GPS tracker value in the programming language used. If defined in request, this takes precedence over the value of integer number of a GPS tracker field. |
route_number |
Type: string Unique route number that matches the number in the delivery company's database. |
route_routing_mode |
Type: string Transportation method. Possible values:
|
segment_distance_m |
Type: number<float> Distance the courier went from their last visited location. |
service_duration_s |
Type: integer Expected time the courier will need to pass the order to the recipient, including going up to the floor and receiving payment. |
shared_service_duration_s |
Type: integer Service duration at the location, which can be shared with other orders at the same location. Shared service duration can include operations as parking a car, delivering documents, etc. |
suggested_order_number |
Type: number The number of the order that should be delivered according to route. |
time_interval_error |
Type: number<float> The amount of time the delivery window was exceeded, in seconds. |
transit_idle_duration |
Type: number<float> Duration of idle events in transit from last visited location. |
type |
Type: string Object type |
used_mark_delivered_radius |
Type: number<float> The value of Max value: |
CourierQualityDepotItem
Name |
Description |
arrived_at |
Type: string<datetime> The time when the courier first entered the area in the specified radius from the depot, in ISO 8601 format. |
courier_deleted |
Type: boolean Courier status, deleted or not. |
courier_name |
Type: string Name of the courier fulfilling the order. |
courier_number |
Type: string ID of the courier fulfilling the order. |
depot_number |
Type: string The unique number of the depot. |
lat |
Type: number<float> Latitude of depot location. |
left_at |
Type: string<datetime> The time when the courier last left the depot, in ISO 8601 format. |
location_idle_duration |
Type: number<float> Duration of idle events at depot location. |
lon |
Type: number<float> Longitude of depot location. |
route_date |
Type: string<date> The route's date in YYYY-MM-DD format. |
route_number |
Type: string Unique route number that matches the number in the delivery company's database. |
segment_distance_m |
Type: number<float> Distance the courier went from their last visited location. |
service_duration_s |
Type: integer Time spent dispatching goods in the depot, in seconds. This time is independent from the time required to load orders. |
transit_idle_duration |
Type: number<float> Duration of idle events in transit from last visited location. |
type |
Type: string Object type |
CourierQualityGarageItem
Name |
Description |
courier_deleted |
Type: boolean Courier status, deleted or not. |
courier_name |
Type: string Name of the courier fulfilling the order. |
courier_number |
Type: string ID of the courier fulfilling the order. |
garage_number |
Type: string The unique number of the garage. |
lat |
Type: number<float> Latitude of garage location. |
location_idle_duration |
Type: number<float> Duration of idle events at garage location. |
lon |
Type: number<float> Longitude of garage location. |
route_date |
Type: string<date> The route's date in YYYY-MM-DD format. |
route_number |
Type: string Unique route number that matches the number in the delivery company's database. |
segment_distance_m |
Type: number<float> Distance the courier went from their last visited location. |
transit_idle_duration |
Type: number<float> Duration of idle events in transit from last visited location. |
type |
Type: string Object type |
OrderInterval
Name |
Description |
end |
Type: string<datetime> The end of the agreed delivery interval, in ISO 8601 format. |
start |
Type: string<datetime> The start of the agreed delivery window, in ISO 8601 format. |
SharedWithCompany
Name |
Description |
id |
Type: integer ID of the company that also receives order information. |
name |
Type: string Name of the company. |
number |
Type: string Number of the company. |
OrderStatusUpdateComment
Name |
Description |
comment |
Type: string Comment for order status update event. |
id |
Type: integer ID of the order status update event. |
status |
Type: string The current order status. Possible values:
|
401 Unauthorized
Authorization error. Make sure that the request header contains the correct OAuth token.
422 Unprocessable Entity
Incorrect input. The operation can't be performed.