Gets delivery quality information

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields

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}

Path Parameters

company_id *

integer

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

company_id *

integer

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

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".

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".

Responses

Code 200

Report on the delivery quality received.

{
  "air_distance": number,
  "arrived_at": string,
  "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,
  "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,
  "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_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.

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_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.