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

Ресурсы API

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

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

HTTP-запрос

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

Path-параметры

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

* Обязательный параметр

Ответы

Код 200

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

{
  "address": string,
  "amount": number,
  "comments": string,
  "company_id": integer,
  "confirmed_at": string,
  "customer_name": string,
  "delivered_at": string,
  "eta_type": string,
  "history": [
    {
      "event": string,
      "position": {
        "lat": number,
        "lon": number,
        "time": string
      },
      "source": {
        "initiator": string
      },
      "time": string,
      "timestamp": number,
      "used_mark_delivered_radius": number
    }
  ],
  "id": integer,
  "lat": number,
  "lon": number,
  "mark_delivered_radius": number,
  "number": string,
  "order_status_comments": [
    {
      "comment": string,
      "id": integer,
      "status": string
    }
  ],
  "payment_type": string,
  "phone": string,
  "refined_lat": number,
  "refined_lon": number,
  "route_id": integer,
  "service_duration_s": integer,
  "shared_service_duration_s": integer,
  "shared_with_companies": [
    {
      "id": integer,
      "name": string,
      "number": string
    }
  ],
  "shared_with_company_ids": [
    number
  ],
  "status": string,
  "status_log": [
    {
      "point": {
        "lat": number,
        "lon": number
      },
      "status": string,
      "timestamp": number
    }
  ],
  "time_interval": string,
  "time_interval_secs": [
    number
  ],
  "time_window": {
    "end": string,
    "start": string
  },
  "volume": number,
  "weight": number,
  "x-description-en": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

address *	string Адрес доставки в текстовом формате.
amount	number Стоимость заказа в рублях.
comments	string Комментарии к заказу.
company_id	integer ID компании, используемый в запросах к API Мониторинга.
confirmed_at	string Время, когда заказ был согласован.
customer_name	string Имя заказчика.
delivered_at	string Время, когда информация о выполнении заказа была зафиксирована в системе Яндекс.Курьер.
eta_type	string Тип ETA. Влияет на время оповещения и автоматического определения доставки. `arrival_time`: отсчёт ведётся от момента прибытия курьера на точку; `delivery_time`: отсчёт начинается не раньше начала окна доставки.
history[]	array История событий, изменяющих статус заказа.
history[].event	string Название случившегося события. Возможные значения: ORDER_CREATED, START, ORDER_BECAME_NEXT, STATUS_UPDATE, INTERVAL_UPDATE, ARRIVAL, ORDER_VISIT, DEPARTURE.
history[].position	object Позиция курьера. Появляется только в событиях ARRIVAL, ORDER_VISIT, DEPARTURE.
history[].position.lat *	number Широта позиции курьера.
history[].position.lon *	number Долгота позиции курьера.
history[].position.time	string Время события на клиенте в формате ISO 8601.
history[].source	object Источник события. Отображается только в событии STATUS_UPDATE.
history[].source.initiator	string Инициатор события, возможные значения: yandex, app, user_api.
history[].time	string Время события в формате ISO 8601.
history[].timestamp	number Время события (UNIX-формат).
history[].used_mark_delivered_radius	number Значение order.mark_delivered_radius или depot.mark_delivered_radius или company.mark_delivered_radius, которое использовалось для пометки заказа как посещенного. Только для событий ARRIVAL, ORDER_VISIT, DEPARTURE. Минимальное значение: `0`. Максимальное значение: `2000`.
id	integer ID заказа, используемый в запросах к API Мониторинга.
lat *	number Широта точки доставки.
lon *	number Долгота точки доставки.
mark_delivered_radius	number Радиус в метрах. Если `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 метров от местоположения заказа. Минимальное значение: `0`. Максимальное значение: `2000`.
number *	string Номер заказа. Используется для синхронизации с учетной системой компании, выполняющей доставку.
order_status_comments[]	array
order_status_comments[].comment	string Комментарий к событию обновления статуса заказа.
order_status_comments[].id	integer ID события обновления статуса заказа.
order_status_comments[].status	string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
payment_type	string Тип оплаты. Возможные значения: cash — Оплата наличными. card — Оплата банковской картой. prepaid — Заказ оплачен, дополнительной оплаты не требуется.
phone	string Телефон получателя.
refined_lat	number Широта реальной (уточнённой курьером) точки доставки.
refined_lon	number Долгота реальной (уточнённой курьером) точки доставки.
route_id	integer ID маршрута, используемый в запросах к API Мониторинга.
service_duration_s	integer Ожидаемое время, потраченное курьером на отгрузку товара получателю, в том числе чтобы подняться на этаж и получить оплату. Значение по умолчанию: 600 секунд.
shared_service_duration_s	integer Продолжительность обслуживания в точке доставки, которая может быть разделена с другими заказами в том же месте. Общая продолжительность обслуживания может включать такие операции, как парковка, доставка документов и другие. Значение по умолчанию: 0 секунд.
shared_with_companies[]	array
shared_with_companies[].name	string Название компании.
shared_with_companies[].number *	string Номер компании.
shared_with_companies[].id	integer ID компании, используемый в запросах к API Мониторинга.
shared_with_company_ids[]	array ID компаний, которые могут получить доступ к информации о заказе. Предоставляется следующая информация: Полная информация о заказе. Общее описание маршрута, частью которого является заказ. Общее описание склада, используемого в заказе. Общая информация о компании, выполняющей доставку (название и логотип). Если определены оба поля `shared_with_company_numbers` и `shared_with_company_ids`, используется `shared_with_company_numbers`.
status	string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
status_log[]	array
status_log[].point	object
status_log[].point.lat *	number Широта точки внесения изменений.
status_log[].point.lon *	number Долгота точки внесения изменений.
status_log[].status	string Текущий статус заказа. Возможные значения: new - заказ был создан. confirmed - установлен срок доставки заказа (подтверждено получателем). finished - заказ доставлен. partially_finished - заказ был доставлен только частично. Для установки статуса заказа в `partially_finished` флаг `company.partially_finished_status_enabled` должен иметь значение `true`. cancelled - заказ был отменен. postponed - заказ отложен или курьер не смог связаться с клиентом.
status_log[].timestamp	number UNIX timestamp времени внесения изменений.
time_interval *	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[]	array значение `time_interval`, преобразованное в секунды с полуночи.
time_window	object Допустимое окно доставки заказа в формате ISO 8601.
time_window.end	string
time_window.start	string
volume	number Объем заказа.
weight	number Вес заказа.
x-description-en	string Описание заказа.

* Обязательный параметр

Код 401

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

Код 403

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

Код 404

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

Код 422

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

Код 504

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

Пример

Responses:

{
  "history": [
    {
      "time": "2019-05-27T17:18:52+03:00"
    }
  ],
  "time_window": {
    "end": "2019-03-06T17:16:30+03:00",
    "start": "2019-03-06T17:15:00+03:00"
  }
}
Скопировано

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

Добавляет заказ

Получает несколько заказов

В этой статье

HTTP-запрос Path-параметры Ответы Код 200 Представление Поля Код 401 Код 403 Код 404 Код 422 Код 504 Пример

Добавляет заказ

Получает несколько заказов