Получает заказ

Возвращает информацию о заказе по его ID.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании, используемый в запросах к API Мониторинга.

order_id*

Type: integer<int64>

ID заказа, используемый в запросах к API Мониторинга.

Responses

200 OK

Информация о заказе получена.

Body

application/json

{
    "address": "string",
    "amount": 0,
    "comments": "string",
    "customer_name": "string",
    "description": "string",
    "lat": 0,
    "lon": 0,
    "number": "string",
    "customer_number": "string",
    "payment_type": "cash",
    "payment_status": "paid",
    "phone": "string",
    "route_id": 0,
    "service_duration_s": 0,
    "shared_service_duration_s": 0,
    "status": "string",
    "volume": 0,
    "weight": 0,
    "shared_with_company_ids": [
        0
    ],
    "mark_delivered_radius": null,
    "eta_type": null,
    "sms_delivery_confirmation": null,
    "company_id": 0,
    "confirmed_at": "string",
    "delivered_at": "string",
    "history": [
        {
            "event": "string",
            "timestamp": 0,
            "time": "2019-05-27T17:18:52+03:00",
            "position": {
                "lat": 0,
                "lon": 0,
                "time": "string"
            },
            "used_mark_delivered_radius": 0,
            "source": {
                "initiator": "string"
            }
        }
    ],
    "id": 0,
    "status_log": [
        {
            "point": {
                "lat": 0,
                "lon": 0
            },
            "status": "string",
            "timestamp": 0
        }
    ],
    "shared_with_companies": [
        {
            "number": "string",
            "name": "string",
            "id": 0
        }
    ],
    "order_status_comments": [
        {
            "id": 0,
            "status": "string",
            "comment": "string"
        }
    ],
    "refined_lat": 0,
    "refined_lon": 0,
    "time_interval": "string",
    "time_interval_secs": [
        0
    ],
    "time_window": {
        "start": "2019-03-06T17:15:00+03:00",
        "end": "2019-03-06T17:16:30+03:00"
    }
}

Name	Description
address	Type: string Адрес доставки в текстовом формате.
amount	Type: number<float> Стоимость заказа в рублях. Min value: `0`
comments	Type: string Комментарии к заказу.
company_id	Type: integer<int64> ID компании, используемый в запросах к API Мониторинга.
confirmed_at	Type: string<datetime> Время, когда заказ был согласован.
customer_name	Type: string Имя заказчика. Max length: `1023`
customer_number	Type: string Номер клиента в базе данных компании, выполняющей доставку. Max length: `128`
delivered_at	Type: string<datetime> Время, когда информация о выполнении заказа была зафиксирована в системе Яндекс.Курьер.
description	Type: string Описание заказа. Max length: `1023`
eta_type	Type: string Тип ETA. Влияет на время оповещения и автоматического определения доставки. `arrival_time` — отсчёт ведётся от момента прибытия курьера на точку; `delivery_time` — отсчёт начинается не раньше начала окна доставки. Default: `null`
history	Type: OrderHistoryItem[] История событий, изменяющих статус заказа.
id	Type: integer ID заказа, используемый в запросах к API Мониторинга.
lat	Type: number<float> Широта точки доставки.
lon	Type: number<float> Долгота точки доставки.
mark_delivered_radius	Type: number<float> Радиус в метрах. Если `null`, используется `depot.mark_delivered_radius` или `company.mark_delivered_radius`. Заказ помечается как доставленный автоматически, если значение `mark_delivered_enabled` равно `true`, а курьер провел не менее `mark_delivered_service_time_coefficient * (order.service_duration_s + order.shared_service_duration_s)` секунд в пределах `mark_delivered_radius` метров от местоположения заказа. Default: `null` Min value: `0` Max value: `10000`
number	Type: string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку. Max length: `80`
order_status_comments	Type: OrderStatusUpdateComment[]
payment_status	Type: string Состояние оплаты. Возможные значения: `paid` — заказ оплачен. `unpaid` — заказ не оплачен. Enum: `paid`, `unpaid`, `null`
payment_type	Type: string Тип оплаты. Возможные значения: `cash` — оплата наличными. `card` — оплата банковской картой. `prepaid` — заказ оплачен, дополнительной оплаты не требуется. `yandex_pay` — оплата заказа через Яндекс Пэй. Снаружи этот способ оплаты задать нельзя. Enum: `cash`, `card`, `prepaid`, `yandex_pay`, `null`
phone	Type: string Телефон получателя.
refined_lat	Type: number<float> Широта реальной (уточнённой курьером) точки доставки.
refined_lon	Type: number<float> Долгота реальной (уточнённой курьером) точки доставки.
route_id	Type: integer<int64> ID маршрута, используемый в запросах к API Мониторинга.
service_duration_s	Type: integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. Значение по умолчанию: 600 секунд.
shared_service_duration_s	Type: integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. Общая продолжительность обслуживания может включать такие операции, как парковка, доставка документов и другие. Значение по умолчанию: 0 секунд.
shared_with_companies	Type: CompanyNumber[]
shared_with_company_ids	Type: number[] ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация: Полная информация о заказе. Общее описание маршрута, частью которого является заказ. Общее описание склада, используемого в заказе. Общая информация о компании, выполняющей доставку (название и логотип). Если определены оба поля `shared_with_company_numbers` и `shared_with_company_ids`, используется `shared_with_company_numbers`.
sms_delivery_confirmation	Type: boolean Нужно ли курьеру подтверждать доставку кодом из СМС Default: `null`
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
status_log	Type: StatusLog[]
time_interval	Type: string Желаемое окно доставки заказа. Поддерживаются следующие форматы: "T - T" или "T-T", где T - это время в формате ЧЧ, ЧЧ:ММ, или ЧЧ:ММ:СС. ISO 8601, например, 2018-09-06T10:15:00+03:00/2018-09-06T12:45:00+03:00.
time_interval_secs	Type: number[] Значение `time_interval`, преобразованное в секунды с полуночи.
time_window	Type: OrderGetWithNotificatons_time_window Допустимое окно доставки заказа в формате ISO 8601.
volume	Type: number<float> Объем заказа.
weight	Type: number<float> Вес заказа.

OrderHistoryItem

Name	Description
event	Type: string Название случившегося события. Возможные значения: ORDER_CREATED, START, ORDER_BECAME_NEXT, STATUS_UPDATE, INTERVAL_UPDATE, ARRIVAL, ORDER_VISIT, DEPARTURE.
position	Type: OrderHistoryPosition Позиция курьера. Появляется только в событиях ARRIVAL, ORDER_VISIT, DEPARTURE.
source	Type: OrderStatusUpdateSource Источник события. Отображается только в событии STATUS_UPDATE.
time	Type: string<datetime> Время события в формате ISO 8601. Example: `2019-05-27T17:18:52+03:00`
timestamp	Type: number<float> Время события (UNIX-формат).
used_mark_delivered_radius	Type: number<float> Значение order.mark_delivered_radius или depot.mark_delivered_radius или company.mark_delivered_radius, которое использовалось для пометки заказа как посещенного. Только для событий ARRIVAL, ORDER_VISIT, DEPARTURE. Min value: `0` Max value: `10000`

OrderStatusUpdateComment

Name	Description
comment	Type: string Комментарий к событию обновления статуса заказа.
id	Type: integer ID события обновления статуса заказа.
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.

CompanyNumber

Name	Description
number*	Type: string Номер компании.
id	Type: integer ID компании, используемый в запросах к API Мониторинга.
name	Type: string Название компании. Max length: `80`

StatusLog

Name	Description
point	Type: StatusLogLocation
status	Type: string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
timestamp	Type: number<float> UNIX timestamp времени внесения изменений.

OrderGetWithNotificatons_time_window

Допустимое окно доставки заказа в формате ISO 8601.

Name

Description

end

Type: string<datetime>

Example: 2019-03-06T17:16:30+03:00

start

Type: string<datetime>

Example: 2019-03-06T17:15:00+03:00

OrderHistoryPosition

Позиция курьера. Появляется только в событиях ARRIVAL, ORDER_VISIT, DEPARTURE.

Name	Description
lat	Type: number<float> Широта позиции курьера.
lon	Type: number<float> Долгота позиции курьера.
time	Type: string<datetime> Время события на клиенте в формате ISO 8601.

OrderStatusUpdateSource

Источник события. Отображается только в событии STATUS_UPDATE.

Name

Description

initiator

Type: string

Инициатор события, возможные значения: yandex, app, user_api.

StatusLogLocation

Name

Description

lat

Type: number<float>

Широта точки внесения изменений.

lon

Type: number<float>

Долгота точки внесения изменений.

401 Unauthorized

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

403 Forbidden

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

404 Not Found

Ошибка поиска объекта. Объект не найден.

422 Unprocessable Entity

Неверный ввод. Операция не может быть выполнена.

504 Gateway Timeout

Ошибка при работе с API. Повторите запрос.

Was the article helpful?

Удаляет заказ

Редактирует заказ