Получить данные о заказе

Запрос позволяет получить данные о заказе.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

Синтаксис запроса

POST /api/last/getOrderInfo
Host: delivery.yandex.ru 
Content-Type: application/x-www-form-urlencoded
... 

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&order_id=<идентификатор заказа>

Параметры:

Параметр Тип Значение
Обязательные
secret_key Строка

Секретный ключ.

client_id Число

Идентификатор аккаунта в Яндекс.Доставке.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

sender_id Число

Идентификатор магазина.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

order_id Число

Идентификатор заказа.

Значение можно получить с помощью запроса Получить список заказов магазина.

Параметр Тип Значение
Обязательные
secret_key Строка

Секретный ключ.

client_id Число

Идентификатор аккаунта в Яндекс.Доставке.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

sender_id Число

Идентификатор магазина.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

order_id Число

Идентификатор заказа.

Значение можно получить с помощью запроса Получить список заказов магазина.

Пример запроса

POST /api/last/getOrderInfo HTTP/1.1
Host: delivery.yandex.ru
Content-Type: application/x-www-form-urlencoded
...

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&order_id=215000019
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&order_id=215000019' 'https://delivery.yandex.ru/api/last/getOrderInfo'

Структура ответа

{
  "status":"ok",
  "data":
  { 
    "id":"949401",
    "sender_id":"3",
    "recipient_id":"948807",
    "parcel_id":null,
    "fulfillment_parcel_id":null,
    "documentable_id":"1095804",
    "billing_entity_id":"1204392",
    "status_id": "1",
    "previous_regular_status_id": null,
    "delivery_interval_id": "3394",
    "num": "3",
    "weight": "0.300",
    "length": "28",
    "width": "35",
    "height": "6",
    "assessed_value": "0.00",
    "total_cost": 0,
    "comment": "",
    "created": "2016-12-16 16:15:12",
    "updated": null,
    "warehouse_id": null,
    "delivery_id": "1510",
    "fulfillment_id": null,
    "return_fulfillment_id": null,
    "tariff_id": "1459",
    "tariff_changed": null,
    "delivery_num": null,
    "fulfillment_num": null,
    "return_fulfillment_num": null,
    "delivery_order_status": "0",
    "delivery_status_update": "0000-00-00 00:00:00",
    "delivery_method": "PICKUP",
    "user_id": "71",
    "requisite_id": "9",
    "to_yd_warehouse": "1",
    "cancelled": "0",
    "amount_prepaid": "5946.00",
    "cash_service_percent": "0.022000",
    "fact_weight": null,
    "is_trackable": "0",
    "trackable_date": null,
    "archived": "0",
    "offer_days": "3-4",
    "offer_min_day": "3",
    "offer_max_day": "4",
    "estimated_delivery_date": "2016-12-21",
    "estimated_delivery_date_max": "2016-12-22",
    "resource_id": "79",
    "is_manual_delivery_cost": "0",
    "billing_order_created": "0",
    "status": "DRAFT",
    "delivery_interval":
      { 
        "id": "3394",
        "day": "1",
        "from": "10:00:00",
        "to": "18:00:00"
      },
    "charges":
      [
        { 
          "id": "4203741", 
          "billing_entity_id": "1204392",
          "service_id": "1",
          "type": "CASH_COMISSION",
          "amount": "0.00",
          "charge_from": "SENDER",
          "fact": "0",
          "created": "2016-12-16 16:15:12",
          "updated": null,
          "service":
            { /* hide:data/charges/service */
              "id": "1",
              "name": "",
              "code": "CASH_SERVICE",
              "description": null,
              "is_optional": "0",
              "active": "0"
            }
        },
        ...
      ],
    "offer":
      { 
        "tariff":
          { 
            "cost": 175
          },
        "cost": 646,
        "costWithRules": 646,
        "services":
          [
            { 
              "name": "",
              "cost": "0.00"
            }   
          ]
      },
    "items_cost": 5300
}
}
Ключ Тип значения Описание
status Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Объект Данные ответа.
Ключи объекта data
id Строка Идентификатор заказа.
sender_id Строка Идентификатор магазина.
recipient_id Строка Идентификатор получателя.
parcel_id Строка Идентификатор отгрузки.
fulfillment_parcel_id Строка Идентификатор отгрузки в службе доставки.
documentable_id Строка Служебное поле.
billing_entity_id Строка Идентификатор списания средств за заказ.
status_id Строка Идентификатор текущего статуса заказа.
previous_regular_status_id Строка Идентификатор предыдущего статуса заказа.
delivery_interval_id Строка Идентификатор временного интервала доставки.
num Строка Номер заказа в магазине.
weight Строка Вес заказа (в килограммах).
length Строка Длина заказа (в сантиметрах).
width Строка Ширина заказа (в сантиметрах).
height Строка Высота заказа (в сантиметрах).
assessed_value Строка Объявленная ценность заказа (в рублях).
total_cost Число Общая стоимость заказа (в рублях).
comment Строка Дополнительное описание.
created Строка

Дата создания черновика заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

updated Строка

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

Указана в формате «YYYY-MM-DD hh:mm:ss».

warehouse_id Строка Идентификатор склада магазина.
delivery_id Строка Идентификатор службы доставки.
fulfillment_id Строка Идентификатор единого склада.
return_fulfillment_id Строка Идентификатор возврата.
tariff_id Строка Идентификатор тарифа службы доставки.
tariff_changed Строка

Служебное поле.

delivery_num Строка Номер заказа в службе доставки.
fulfillment_num Строка Номер заказа на едином складе.
return_fulfillment_num Строка Служебное поле.
delivery_order_status Строка

Информация о том, доставлен ли заказ получателю.

Возможные значения:
  • 0 — заказ не доставлен получателю.
  • 1 — заказ доставлен получателю.
delivery_status_update Строка

Дата последнего изменения статуса заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

delivery_method Строка

Способ доставки заказа.

Возможные значения:
user_id Число Идентификатор аккаунта в Яндекс.Доставке.
requisite_id Число Идентификатор реквизитов магазина.
to_yd_warehouse Строка

Склад, на который осуществляется отгрузка.

Возможные значения:
  • 0 — склад службы доставки.
  • 1 — единый склад.
cancelled Строка

Информация об отмене заказа.

Возможные значения:
  • 0 — заказ не отменен.
  • 1 — заказ отменен.
amount_prepaid Число

Сумма стопроцентной предоплаты по заказу (в рублях).

Сумма состоит из общей стоимости всех товаров заказа и стоимости доставки с получателя.

cash_service_percent Число Агентское вознаграждение (в рублях).
fact_weight Число Вес заказа (в килограммах).
is_trackable Строка

Обновление статуса заказа службой доставки.

Возможные значения:
  • false — служба доставки не обновляла статус.
  • true — служба доставки обновляла статус.
trackable_date Строка

Дата, когда служба доставки последний раз обновила статус заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

archived Строка

Перемещение заказа в архив.

Возможные значения:
  • 0 — заказ не в архиве.
  • 1 — заказ в архиве.
offer_days Строка Срок доставки заказа (в днях).
offer_min_day Число Минимальный срок доставки заказа (в днях).
offer_max_day Число Максимальный срок доставки заказа (в днях).
estimated_delivery_date Строка

Начальная дата срока доставки.

Формат: «YYYY-MM-DD».

estimated_delivery_date_max Строка

Конечная дата срока доставки.

Формат: «YYYY-MM-DD».

resource_id Строка Служебное поле.
is_manual_delivery_cost Строка

Способ формирования стоимости доставки.

Возможные значения:
  • 0 — учитываются условия, указанные в личном кабинете Яндекс.Доставки (в разделе Настройки, на вкладке Доставка).
  • 1 — стоимость доставки устанавливается вручную.
billing_order_created Строка

Служебное поле.

status Строка

Статус заказа (кодовое название).

Возможные значения:
  • DRAFT — заказ доступен для редактирования.
  • CREATED — заказ проверен и отправлен в службу доставки.
  • SENDER_SENT — заказ ожидает подтверждения от службы доставки.
  • DELIVERY_LOADED — заказ подтвержден службой доставки.
  • SENDER_WAIT_FULFILMENT — заказ ожидается на едином складе.
  • SENDER_WAIT_DELIVERY — заказ ожидается в службе доставки.
  • FULFILMENT_LOADED — заказ подтвержден единым складом.
  • FULFILMENT_ARRIVED — заказ находится на едином складе.
  • FULFILMENT_PREPARED — заказ готов к передаче в службу доставки.
  • FULFILMENT_TRANSMITTED — заказ передан в службу доставки.
  • DELIVERY_AT_START — заказ находится на складе службы доставки.
  • DELIVERY_TRANSPORTATION — заказ доставляется.
  • DELIVERY_ARRIVED — заказ находится в населенном пункте получателя.
  • DELIVERY_TRANSPORTATION_RECIPIENT — заказ доставляется по населенному пункту получателя.
  • DELIVERY_ARRIVED_PICKUP_POINT — заказ находится в пункте самовывоза.
  • DELIVERY_DELIVERED — заказ доставлен получателю.
  • RETURN_PREPARING — заказ готовится к возврату.
  • RETURN_ARRIVED_DELIVERY — заказ возвращен на склад службы доставки.
  • RETURN_ARRIVED_FULFILMENT — заказ возвращен на единый склад.
  • RETURN_PREPARING_SENDER — заказ возвращается в магазин.
  • RETURN_RETURNED — заказ возвращен в магазин.
  • LOST — заказ утерян в процессе доставки.
  • UNEXPECTED — статус заказа уточняется.
  • CANCELED — заказ отменен.
  • ERROR — произошла ошибка.
delivery_interval Объект Временной интервал доставки заказа.
recipient Объект Данные о получателе.
charges Массив Список услуг.
offer Объект Данные о стоимости доставки и услуг.
items_cost Число Общая стоимость товаров заказа (в рублях).
Ключи объекта data/delivery_interval
id Строка Идентификатор временного интервала.
day Строка

День недели.

Возможные значения:
  • 1 — понедельник.
  • 2 — вторник.
  • 3 — среда.
  • 4 — четверг.
  • 5 — пятница.
  • 6 — суббота.
  • 7 — воскресенье.
from Строка Начальное время интервала.
to Строка Конечное время интервала.
Ключи объектов массива data/charges
id Строка Идентификатор списания средств за услугу.
billing_entity_id Строка

Идентификатор списания средств за заказ.

service_id Строка Идентификатор услуги.
type Строка

Тип списания средств.

Возможные значения:
  • SERVICE — за услугу.
  • DELIVERY — за доставку заказа покупателю.
  • WITHDRAW — за забор.
  • CASH_COMMISSION — агентское вознаграждение.
amount Строка Сумма платежа (в рублях).
charge_from Строка

Источник списания средств.

Возможные значения:
  • SENDER — магазин.
  • RECIPIENT — получатель.
fact Строка

Служебное поле.

created Строка

Дата создания записи об услуге.

Указана в формате «YYYY-MM-DD hh:mm:ss».

updated Строка

Дата последнего изменения записи об услуге.

Указана в формате «YYYY-MM-DD hh:mm:ss».

service Объект Данные об услуге.
Ключи объекта data/offer
tariff Объект Стоимость доставки по тарифу (без учета услуг).
cost Число

Стоимость доставки (в рублях).

costWithRules Число Стоимость доставки с учетом правил магазина (в рублях).
services Массив Список услуг.
Ключи объекта data/charges/service
id Строка Идентификатор услуги.
name Строка

Название услуги.

Возможные значения:
  • «Вознаграждение за перечисление денежных средств»;
  • «Ожидание курьера»;
  • «Услуга Объявленная ценность»;
  • «Упаковка по заявке клиента»;
  • «Переупаковка по причине испорченной коробки, поступившей на склад сортировки без заявки магазина»;
  • «Сортировка на едином складе»;
  • «Комплектация заказа»;
  • «Платное хранение»;
  • «Возврат на единый склад»;
  • «Не известно»;
  • «Сортировка возврата»;
  • «Другие услуги».
code Строка

Кодовое название услуги.

Возможные значения:
  • CASH_SERVICE — вознаграждение за перечисление денежных средств.
  • WAIT_20 — ожидание курьера.
  • INSURANCE — объявление ценности заказа.
  • PACK — упаковка заказа.
  • REPACK — переупаковка заказа.
  • SORT — сортировка на едином складе.
  • COMPLECT — комплектация заказа.
  • STORAGE — хранение заказа.
  • RETURN — возврат заказа на единый склад.
  • UNDEFINED — неизвестная услуга.
  • RETURN_SORT — сортировка возвращенного заказа.
  • OTHER — другая услуга.
description Строка Описание услуги.
is_optional Строка

Обязательность услуги.

Возможные значения:
  • 0 — услуга необязательна.
  • 1 — услуга обязательна.
active Строка Служебное поле.
Ключи объекта data/offer/tariff
cost Число

Стоимость доставки по тарифу (без учета услуг).

Указана в рублях.

Ключи объектов массива data/offer/services
name Строка

Название услуги.

Возможные значения:
  • «Вознаграждение за перечисление денежных средств»;
  • «Ожидание курьера»;
  • «Услуга Объявленная ценность»;
  • «Упаковка по заявке клиента»;
  • «Переупаковка по причине испорченной коробки, поступившей на склад сортировки без заявки магазина»;
  • «Сортировка на едином складе»;
  • «Комплектация заказа»;
  • «Платное хранение»;
  • «Возврат на единый склад»;
  • «Не известно»;
  • «Сортировка возврата»;
  • «Другие услуги».
cost Число

Стоимость услуги (в рублях).

Ключ Тип значения Описание
status Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Объект Данные ответа.
Ключи объекта data
id Строка Идентификатор заказа.
sender_id Строка Идентификатор магазина.
recipient_id Строка Идентификатор получателя.
parcel_id Строка Идентификатор отгрузки.
fulfillment_parcel_id Строка Идентификатор отгрузки в службе доставки.
documentable_id Строка Служебное поле.
billing_entity_id Строка Идентификатор списания средств за заказ.
status_id Строка Идентификатор текущего статуса заказа.
previous_regular_status_id Строка Идентификатор предыдущего статуса заказа.
delivery_interval_id Строка Идентификатор временного интервала доставки.
num Строка Номер заказа в магазине.
weight Строка Вес заказа (в килограммах).
length Строка Длина заказа (в сантиметрах).
width Строка Ширина заказа (в сантиметрах).
height Строка Высота заказа (в сантиметрах).
assessed_value Строка Объявленная ценность заказа (в рублях).
total_cost Число Общая стоимость заказа (в рублях).
comment Строка Дополнительное описание.
created Строка

Дата создания черновика заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

updated Строка

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

Указана в формате «YYYY-MM-DD hh:mm:ss».

warehouse_id Строка Идентификатор склада магазина.
delivery_id Строка Идентификатор службы доставки.
fulfillment_id Строка Идентификатор единого склада.
return_fulfillment_id Строка Идентификатор возврата.
tariff_id Строка Идентификатор тарифа службы доставки.
tariff_changed Строка

Служебное поле.

delivery_num Строка Номер заказа в службе доставки.
fulfillment_num Строка Номер заказа на едином складе.
return_fulfillment_num Строка Служебное поле.
delivery_order_status Строка

Информация о том, доставлен ли заказ получателю.

Возможные значения:
  • 0 — заказ не доставлен получателю.
  • 1 — заказ доставлен получателю.
delivery_status_update Строка

Дата последнего изменения статуса заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

delivery_method Строка

Способ доставки заказа.

Возможные значения:
user_id Число Идентификатор аккаунта в Яндекс.Доставке.
requisite_id Число Идентификатор реквизитов магазина.
to_yd_warehouse Строка

Склад, на который осуществляется отгрузка.

Возможные значения:
  • 0 — склад службы доставки.
  • 1 — единый склад.
cancelled Строка

Информация об отмене заказа.

Возможные значения:
  • 0 — заказ не отменен.
  • 1 — заказ отменен.
amount_prepaid Число

Сумма стопроцентной предоплаты по заказу (в рублях).

Сумма состоит из общей стоимости всех товаров заказа и стоимости доставки с получателя.

cash_service_percent Число Агентское вознаграждение (в рублях).
fact_weight Число Вес заказа (в килограммах).
is_trackable Строка

Обновление статуса заказа службой доставки.

Возможные значения:
  • false — служба доставки не обновляла статус.
  • true — служба доставки обновляла статус.
trackable_date Строка

Дата, когда служба доставки последний раз обновила статус заказа.

Указана в формате «YYYY-MM-DD hh:mm:ss».

archived Строка

Перемещение заказа в архив.

Возможные значения:
  • 0 — заказ не в архиве.
  • 1 — заказ в архиве.
offer_days Строка Срок доставки заказа (в днях).
offer_min_day Число Минимальный срок доставки заказа (в днях).
offer_max_day Число Максимальный срок доставки заказа (в днях).
estimated_delivery_date Строка

Начальная дата срока доставки.

Формат: «YYYY-MM-DD».

estimated_delivery_date_max Строка

Конечная дата срока доставки.

Формат: «YYYY-MM-DD».

resource_id Строка Служебное поле.
is_manual_delivery_cost Строка

Способ формирования стоимости доставки.

Возможные значения:
  • 0 — учитываются условия, указанные в личном кабинете Яндекс.Доставки (в разделе Настройки, на вкладке Доставка).
  • 1 — стоимость доставки устанавливается вручную.
billing_order_created Строка

Служебное поле.

status Строка

Статус заказа (кодовое название).

Возможные значения:
  • DRAFT — заказ доступен для редактирования.
  • CREATED — заказ проверен и отправлен в службу доставки.
  • SENDER_SENT — заказ ожидает подтверждения от службы доставки.
  • DELIVERY_LOADED — заказ подтвержден службой доставки.
  • SENDER_WAIT_FULFILMENT — заказ ожидается на едином складе.
  • SENDER_WAIT_DELIVERY — заказ ожидается в службе доставки.
  • FULFILMENT_LOADED — заказ подтвержден единым складом.
  • FULFILMENT_ARRIVED — заказ находится на едином складе.
  • FULFILMENT_PREPARED — заказ готов к передаче в службу доставки.
  • FULFILMENT_TRANSMITTED — заказ передан в службу доставки.
  • DELIVERY_AT_START — заказ находится на складе службы доставки.
  • DELIVERY_TRANSPORTATION — заказ доставляется.
  • DELIVERY_ARRIVED — заказ находится в населенном пункте получателя.
  • DELIVERY_TRANSPORTATION_RECIPIENT — заказ доставляется по населенному пункту получателя.
  • DELIVERY_ARRIVED_PICKUP_POINT — заказ находится в пункте самовывоза.
  • DELIVERY_DELIVERED — заказ доставлен получателю.
  • RETURN_PREPARING — заказ готовится к возврату.
  • RETURN_ARRIVED_DELIVERY — заказ возвращен на склад службы доставки.
  • RETURN_ARRIVED_FULFILMENT — заказ возвращен на единый склад.
  • RETURN_PREPARING_SENDER — заказ возвращается в магазин.
  • RETURN_RETURNED — заказ возвращен в магазин.
  • LOST — заказ утерян в процессе доставки.
  • UNEXPECTED — статус заказа уточняется.
  • CANCELED — заказ отменен.
  • ERROR — произошла ошибка.
delivery_interval Объект Временной интервал доставки заказа.
recipient Объект Данные о получателе.
charges Массив Список услуг.
offer Объект Данные о стоимости доставки и услуг.
items_cost Число Общая стоимость товаров заказа (в рублях).
Ключи объекта data/delivery_interval
id Строка Идентификатор временного интервала.
day Строка

День недели.

Возможные значения:
  • 1 — понедельник.
  • 2 — вторник.
  • 3 — среда.
  • 4 — четверг.
  • 5 — пятница.
  • 6 — суббота.
  • 7 — воскресенье.
from Строка Начальное время интервала.
to Строка Конечное время интервала.
Ключи объектов массива data/charges
id Строка Идентификатор списания средств за услугу.
billing_entity_id Строка

Идентификатор списания средств за заказ.

service_id Строка Идентификатор услуги.
type Строка

Тип списания средств.

Возможные значения:
  • SERVICE — за услугу.
  • DELIVERY — за доставку заказа покупателю.
  • WITHDRAW — за забор.
  • CASH_COMMISSION — агентское вознаграждение.
amount Строка Сумма платежа (в рублях).
charge_from Строка

Источник списания средств.

Возможные значения:
  • SENDER — магазин.
  • RECIPIENT — получатель.
fact Строка

Служебное поле.

created Строка

Дата создания записи об услуге.

Указана в формате «YYYY-MM-DD hh:mm:ss».

updated Строка

Дата последнего изменения записи об услуге.

Указана в формате «YYYY-MM-DD hh:mm:ss».

service Объект Данные об услуге.
Ключи объекта data/offer
tariff Объект Стоимость доставки по тарифу (без учета услуг).
cost Число

Стоимость доставки (в рублях).

costWithRules Число Стоимость доставки с учетом правил магазина (в рублях).
services Массив Список услуг.
Ключи объекта data/charges/service
id Строка Идентификатор услуги.
name Строка

Название услуги.

Возможные значения:
  • «Вознаграждение за перечисление денежных средств»;
  • «Ожидание курьера»;
  • «Услуга Объявленная ценность»;
  • «Упаковка по заявке клиента»;
  • «Переупаковка по причине испорченной коробки, поступившей на склад сортировки без заявки магазина»;
  • «Сортировка на едином складе»;
  • «Комплектация заказа»;
  • «Платное хранение»;
  • «Возврат на единый склад»;
  • «Не известно»;
  • «Сортировка возврата»;
  • «Другие услуги».
code Строка

Кодовое название услуги.

Возможные значения:
  • CASH_SERVICE — вознаграждение за перечисление денежных средств.
  • WAIT_20 — ожидание курьера.
  • INSURANCE — объявление ценности заказа.
  • PACK — упаковка заказа.
  • REPACK — переупаковка заказа.
  • SORT — сортировка на едином складе.
  • COMPLECT — комплектация заказа.
  • STORAGE — хранение заказа.
  • RETURN — возврат заказа на единый склад.
  • UNDEFINED — неизвестная услуга.
  • RETURN_SORT — сортировка возвращенного заказа.
  • OTHER — другая услуга.
description Строка Описание услуги.
is_optional Строка

Обязательность услуги.

Возможные значения:
  • 0 — услуга необязательна.
  • 1 — услуга обязательна.
active Строка Служебное поле.
Ключи объекта data/offer/tariff
cost Число

Стоимость доставки по тарифу (без учета услуг).

Указана в рублях.

Ключи объектов массива data/offer/services
name Строка

Название услуги.

Возможные значения:
  • «Вознаграждение за перечисление денежных средств»;
  • «Ожидание курьера»;
  • «Услуга Объявленная ценность»;
  • «Упаковка по заявке клиента»;
  • «Переупаковка по причине испорченной коробки, поступившей на склад сортировки без заявки магазина»;
  • «Сортировка на едином складе»;
  • «Комплектация заказа»;
  • «Платное хранение»;
  • «Возврат на единый склад»;
  • «Не известно»;
  • «Сортировка возврата»;
  • «Другие услуги».
cost Число

Стоимость услуги (в рублях).