Gets order information

Gets information about orders for a specific date.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/verification

Path parameters

Name

Description

company_id*

Type: integer<int64>

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

Query parameters

Name	Description
date	Type: string<date> Delivery date in YYYY-MM-DD format. You should specify either 'date' or 'order_number', or both.
depot_id	Type: integer<int64> Depot ID used in requests to the Track & Trace API. Min value: `1`
order_number	Type: string Order number in the delivery company's system. You should specify either 'date' or 'order_number', or both.
route_id	Type: integer<int64> The ID of the route that is used in requests to the Track & Trace API.

Responses

200 OK

The list of orders was received.

Body

application/json

[
    {
        "address": "string",
        "comments": "string",
        "confirmed_at": "string",
        "courier_name": "string",
        "courier_number": "string",
        "customer_name": "string",
        "delivered_at": "string",
        "depot_id": 0,
        "depot_number": "string",
        "description": "string",
        "lat": 0,
        "lon": 0,
        "order_id": 0,
        "order_number": "string",
        "phone": "string",
        "route_number": "string",
        "status": "string",
        "status_log": [
            {
                "point": {
                    "lat": 0,
                    "lon": 0
                },
                "status": "string",
                "timestamp": 0
            }
        ],
        "time_interval": "string"
    }
]

VerificationItem[]

VerificationItem

Name	Description
address	Type: string Delivery address in text format. Max length: `1023`
comments	Type: string Order comments.
confirmed_at	Type: string<datetime> Order confirmation time, in ISO 8601 format.
courier_name	Type: string Name of the courier. Max length: `255`
courier_number	Type: string Unique courier number that matches the number in the delivery company's database.
customer_name	Type: string Customer name. Max length: `1023`
delivered_at	Type: string<datetime> Order delivery time, in ISO 8601 format.
depot_id	Type: integer<int64> Depot ID used in requests to the Track & Trace API.
depot_number	Type: string Unique depot number that matches the number in the delivery company's database.
description	Type: string Order description. Max length: `1023`
lat	Type: number<float> Latitude of the delivery point.
lon	Type: number<float> Longitude of the delivery point.
order_id	Type: integer<int64> Order ID used in requests to the Track & Trace API.
order_number	Type: string Unique order number that matches the number in the delivery company's database.
phone	Type: string Customer's phone number, for when you do not use the Customer object.
route_number	Type: string Unique route number that matches the route number in the delivery company's database.
status	Type: 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.
status_log	Type: StatusLog[] Information about order status changes.
time_interval	Type: string Desired delivery time interval in "T - T" or "T-T" time format, where T represents time in HH, HH:MM or HH:MM:SS format.

StatusLog

Name	Description
point	Type: StatusLogLocation
status	Type: 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.
timestamp	Type: number<float> The time when changes were made (UNIX timestamp).

StatusLogLocation

Name

Description

lat

Type: number<float>

Latitude of the point where changes were made.

lon

Type: number<float>

Longitude of the point where changes were made.

401 Unauthorized

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

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input. The operation can't be performed.

504 Gateway Timeout

Error working with the API. Repeat the request.

Was the article helpful?

Overview