Gets order information

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 422
    5. Code 504

Gets information about orders for a specific date.

HTTP Request

GET https://courier.yandex.ru/api/v1/companies/{company_id}/verification\
?date={string}\
&order_number={string}\
&depot_id={integer}\
&route_id={integer}

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

Delivery date in YYYY-MM-DD format. You should specify either 'date' or 'order_number', or both.

order_number

string

Order number in the delivery company's system. You should specify either 'date' or 'order_number', or both.

depot_id

integer

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

Minimum value: 1.

route_id

integer

The ID of the route that is used in requests to the Track & Trace API.

date

string

Delivery date in YYYY-MM-DD format. You should specify either 'date' or 'order_number', or both.

order_number

string

Order number in the delivery company's system. You should specify either 'date' or 'order_number', or both.

depot_id

integer

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

Minimum value: 1.

route_id

integer

The ID of the route that is used in requests to the Track & Trace API.

Responses

Code 200

The list of orders was received.

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

Representation

Collapse all
Expand all

Fields

address

string

Delivery address in text format.

comments

string

Order comments.

confirmed_at

string

Order confirmation time, in ISO 8601 format.

courier_name

string

Name of the courier.

courier_number

string

Unique courier number that matches the number in the delivery company's database.

customer_name

string

Customer name.

delivered_at

string

Order delivery time, in ISO 8601 format.

depot_id

integer

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

depot_number

string

Unique depot number that matches the number in the delivery company's database.

description

string

Order description.

lat

number

Latitude of the delivery point.

lon

number

Longitude of the delivery point.

order_id

integer

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

order_number

string

Unique order number that matches the number in the delivery company's database.

phone

string

Customer's phone number, for when you do not use the Customer object.

route_number

string

Unique route number that matches the route number in the delivery company's database.

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.

status_log[]

array

Information about order status changes.

status_log[].point

object

status_log[].point.lat

number

Latitude of the point where changes were made.

status_log[].point.lon

number

Longitude of the point where changes were made.

status_log[].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.

status_log[].timestamp

number

The time when changes were made (UNIX timestamp).

time_interval

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.

address

string

Delivery address in text format.

comments

string

Order comments.

confirmed_at

string

Order confirmation time, in ISO 8601 format.

courier_name

string

Name of the courier.

courier_number

string

Unique courier number that matches the number in the delivery company's database.

customer_name

string

Customer name.

delivered_at

string

Order delivery time, in ISO 8601 format.

depot_id

integer

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

depot_number

string

Unique depot number that matches the number in the delivery company's database.

description

string

Order description.

lat

number

Latitude of the delivery point.

lon

number

Longitude of the delivery point.

order_id

integer

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

order_number

string

Unique order number that matches the number in the delivery company's database.

phone

string

Customer's phone number, for when you do not use the Customer object.

route_number

string

Unique route number that matches the route number in the delivery company's database.

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.

status_log[]

array

Information about order status changes.

status_log[].point

object

status_log[].point.lat

number

Latitude of the point where changes were made.

status_log[].point.lon

number

Longitude of the point where changes were made.

status_log[].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.

status_log[].timestamp

number

The time when changes were made (UNIX timestamp).

time_interval

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.

Code 401

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

Code 403

You do not have access to this object.

Code 422

Incorrect input. The operation can't be performed.

Code 504

Error working with the API. Repeat the request.