Получить список заказов магазина

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

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

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

POST /api/last/getSenderOrders
Host: delivery.yandex.ru
Content-Type: application/x-www-form-urlencoded
...
  
secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
[&order_ids=<идентификаторы заказов>]
[&deliveries=<названия служб доставки>]
[&shops=<идентификаторы магазинов>
[&statuses=<статусы заказов>]
[&page=<номер страницы>]

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

Необязательные
order_ids Строка

Идентификаторы заказов, разделенные запятой (например, «215000001%2C215000002»).

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

deliveries Строка

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

shops Строка

Идентификаторы магазинов, разделенные запятой (например, «215000001%2C215000002»).

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

statuses Строка

Кодовые названия статусов заказов, разделенные запятыми.

Допустимые значения:
  • 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 — произошла ошибка.
page Число

Номер страницы ответа.

На одной странице отображается 200 заказов.

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&deliveries=Strizh%2CBoxberry&shops=8098&statuses=CREATED%2CCANCELED
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&deliveries=Strizh%2CBoxberry&shops=8098&statuses=CREATED%2CCANCELED' 'https://delivery.yandex.ru/api/last/getSenderOrders'

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

{
  "status":"ok",
  "data":
  {
    "orders":
      [
        { 
          "sender_id":"3",
          "order_id":"300112477",
          "num":"123",
          "order_date":"2017-01-12 16:57:02",
          "status":"SENDER_WAIT_FULFILMENT",
          "shipment_date":"2017-01-12",
          "delivery":
            {
              "unique_name":"delivery_Strizh"
            },
          "recipient":
            {
              "last_name":"Иванов",
              "first_name":"Александр"
            },
          "items":
            [   
              {
                "name":"Одеяло 200х160",
                "cost":"232.00",
                "weight":"0",
                "width":"0",
                "height":"0",
                "length":"0"
              },
              ...
            ]
        },
        ...
      ]
  }
}
Ключ Тип значения Описание
status Строка

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

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Объект Данные ответа.
Ключи объекта data
orders Массив Данные о заказах.
Ключи объектов массива data/orders
sender_id Строка Идентификатор магазина.
order_id Строка

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

num Строка Номер заказа.
order_date Строка

Дата оформления заказа.

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

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 — произошла ошибка.
shipment_date Строка

Дата отгрузки.

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

delivery Объект Данные о службе доставки.
recipient Объект Данные о получателе заказа.
items Массив Данные о товарах заказа.
Ключи объекта delivery
unique_name Строка

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

Ключи объекта recipient
last_name Строка

Фамилия получателя.

first_name Строка

Имя получателя.

Ключи объектов массива items
name Строка

Наименование товара.

cost Строка

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

weight Строка Вес заказа (в килограммах).
width Строка Ширина заказа (в сантиметрах).
height Строка Высота заказа (в сантиметрах).
length Строка Длина заказа (в сантиметрах).