Gets delivery quality information

Gets information about the delivery quality.

HTTP Request

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

Path Parameters

company_id *

integer

Company ID used in requests to the Track & Trace API.

* Required parameter

Query Parameters

date *	string The route's date in YYYY-MM-DD format.
depot_id	integer ID of the depot where the route starts. Minimum value: `1`.
types	string Comma-separated list of point types to use in report. Available types are "order", "depot", "garage". Default "order".
with_deleted_couriers	boolean Include deleted couriers in the report.

* Required parameter

Responses

Code 200

Report on the delivery quality received.

{
  "air_distance": number,
  "arrived_at": string,
  "courier_deleted": boolean,
  "courier_name": string,
  "courier_number": string,
  "customer_name": string,
  "delivery_lat": number,
  "delivery_lon": number,
  "delivery_not_in_interval": boolean,
  "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_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
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

air_distance	number The distance between the order coordinates and the courier location in which the order status was changed to "finished" or "partially_finished", in a straight line in meters.
arrived_at	string The time when the courier first entered the area in the specified radius from the delivery point, in ISO 8601 format.
courier_deleted	boolean Courier status, deleted or not.
courier_name	string Name of the courier fulfilling the order.
courier_number	string ID of the courier fulfilling the order.
customer_name	string Customer's name.
delivery_lat	number Latitude of order delivery location.
delivery_lon	number Longitude of order delivery location.
delivery_not_in_interval	boolean Indicates whether the order was completed outside of the agreed timeframe. Returns `true` if the order was not delivered within the specified timeframe.
depot_number	string The unique number of the depot that handles the order.
far_from_point	boolean Indicates that items were delivered far away from the specified point. Returns `true` if the distance between the actual delivery point and the one specified in the order is more than 200 meters.
lat	number Latitude of order location.
late_call_before_delivery	boolean Indicates that the call to the customer was late. Returns `true` if the call was made less than 30 minutes before completing the order.
left_at	string The time when the courier last left the delivery point, in ISO 8601 format.
location_idle_duration	number Duration of idle events at order location.
lon	number Longitude of order location.
no_call_before_delivery	boolean Indicates that the customer didn't get a call before the order was completed. Returns `true` if the courier didn't call before the order was completed or canceled.
not_in_order	boolean Indicates that the delivery was completed in an unexpected order. Returns `true` if the delivery wasn't completed in the order specified in the Track & Trace API.
order_address	string Order delivery address.
order_comments	string Order comments.
order_completed_at	string The time when information about the order was recorded, in ISO 8601 format.
order_confirmed_at	string Time when delivery was agreed on and the order was switched to the confirmed status, in ISO 8601 format.
order_interval[]	array
order_interval[].end	string The end of the agreed delivery interval, in ISO 8601 format.
order_interval[].start	string The start of the agreed delivery window, in ISO 8601 format.
order_number	string Order number in the delivery company database.
order_shared_with_companies[]	array
order_shared_with_companies[].id	integer ID of the company that also receives order information.
order_shared_with_companies[].name	string Name of the company.
order_shared_with_companies[].number	string Number of the company.
order_status	string The current order status. Possible values: new — The order was created. confirmed — The order delivery time was set (confirmed with recipient). finished — The order was delivered. partially_finished — The order was delivered only partially. Order status can be set to `partially_finished` only for companies with `company.partially_finished_status_enabled` flag equals `true`. cancelled — The order was canceled. postponed — The order is postponed or the courier couldn't contact the customer.
order_status_comments[]	array
order_status_comments[].comment	string Comment for order status update event.
order_status_comments[].id	integer ID of the order status update event.
order_status_comments[].status	string The current order status. Possible values: new — The order was created. confirmed — The order delivery time was set (confirmed with recipient). finished — The order was delivered. partially_finished — The order was delivered only partially. Order status can be set to `partially_finished` only for companies with `company.partially_finished_status_enabled` flag equals `true`. cancelled — The order was canceled. postponed — The order is postponed or the courier couldn't contact the customer.
order_visited_at	string Date and time when the courier spent mark_delivered_service_time_coefficient * (order.service_duration_s + order.shared_service_duration_s) seconds within mark_delivered_radius meters from the delivery point. Specified in ISO 8601 format, based on data from the tracker or mobile app.
order_volume	number Order volume.
order_weight	number Order weight.
phone	string The recipient's phone number.
refined_lat	number Latitude of the real (refined by courier) delivery point.
refined_lon	number Logitude of the real (refined by courier) delivery point.
route_date	string The route's date in YYYY-MM-DD format.
route_imei	integer IMEI number of the GPS tracker of the courier fulfilling the order.
route_imei_str	string String representation of numeric IMEI. Should be used in case integer overflow of numeric IMEI value in the programming language used. If defined in request, this takes precedence over the value of integer IMEI field.
route_number	string Unique route number that matches the number in the delivery company's database.
route_routing_mode	string Transportation method. Possible values: `driving` - courier drives a car. `truck` - courier drives a truck. `transit` - courier uses public transport and walks. `walking` - courier walks.
segment_distance_m	number Distance the courier went from their last visited location.
service_duration_s	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	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	number The number of the order that should be delivered according to route.
time_interval_error	number The amount of time the delivery window was exceeded, in seconds.
transit_idle_duration	number Duration of idle events in transit from last visited location.
type	string Object type `order`.
used_mark_delivered_radius	number The value of order.mark_delivered_radius or depot.mark_delivered_radius or company.mark_delivered_radius that was used to mark the order as visited. Returns `null` until the order is visited. Minimum value: `0`. Maximum value: `2000`.
arrived_at	string The time when the courier first entered the area in the specified radius from the depot, in ISO 8601 format.
courier_deleted	boolean Courier status, deleted or not.
courier_name	string Name of the courier fulfilling the order.
courier_number	string ID of the courier fulfilling the order.
depot_number	string The unique number of the depot.
lat	number Latitude of depot location.
left_at	string The time when the courier last left the depot, in ISO 8601 format.
location_idle_duration	number Duration of idle events at depot location.
lon	number Longitude of depot location.
route_date	string The route's date in YYYY-MM-DD format.
route_number	string Unique route number that matches the number in the delivery company's database.
segment_distance_m	number Distance the courier went from their last visited location.
service_duration_s	integer Time spent dispatching goods in the depot, in seconds. This time is independent from the time required to load orders.
transit_idle_duration	number Duration of idle events in transit from last visited location.
type	string Object type `depot`.
courier_deleted	boolean Courier status, deleted or not.
courier_name	string Name of the courier fulfilling the order.
courier_number	string ID of the courier fulfilling the order.
garage_number	string The unique number of the garage.
lat	number Latitude of garage location.
location_idle_duration	number Duration of idle events at garage location.
lon	number Longitude of garage location.
route_date	string The route's date in YYYY-MM-DD format.
route_number	string Unique route number that matches the number in the delivery company's database.
segment_distance_m	number Distance the courier went from their last visited location.
transit_idle_duration	number Duration of idle events in transit from last visited location.
type	string Object type `garage`.

* Required parameter

Code 401

Authorization error. Make sure that the request header contains the correct OAuth token.

Code 422

Incorrect input. The operation can't be performed.