Получить статусы заказов

Запрос позволяет получить статусы для:
  • заданного набора заказов;

  • заказов, статус которых был установлен в заданный интервал.

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

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

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

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&orders_id=<идентификаторы заказов>
[&transition_date_from=<начальная дата установки статуса>
[&transition_date_to=<конечная дата установки статуса>]
[&transition_status=<статус заказа>]
[&order_id_from=<идентификатор заказа>]

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

orders_id Строка

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

Идентификаторы можно получить с помощью запроса Получить список заказов магазина. Количество идентификаторов в строке должно быть не больше 50.

Если параметр указан, то transition_date_from, transition_date_to, order_id_from и transition_status не учитываются.

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

Дата установки статуса, с которой следует начать поиск.

Дату можно получить с помощью запроса Получить статусы заказа. Дата должна быть указана в формате «YYYY-MM-DD».

Количество дней между значением данного параметра и transition_date_to должно быть не больше 7.

transition_date_to Строка

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

Дату можно получить с помощью запроса Получить статусы заказа. Дата должна быть указана в формате «YYYY-MM-DD».

Количество дней между transition_date_from и значением данного параметра должно быть не больше 7.

order_id_from Число

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

История статусов будет найдена для заказов, идентификаторы которых больше указанного.

transition_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 — произошла ошибка.
Параметр Тип Значение
Обязательные
secret_key Строка

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

client_id Число

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

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

sender_id Число

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

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

orders_id Строка

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

Идентификаторы можно получить с помощью запроса Получить список заказов магазина. Количество идентификаторов в строке должно быть не больше 50.

Если параметр указан, то transition_date_from, transition_date_to, order_id_from и transition_status не учитываются.

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

Дата установки статуса, с которой следует начать поиск.

Дату можно получить с помощью запроса Получить статусы заказа. Дата должна быть указана в формате «YYYY-MM-DD».

Количество дней между значением данного параметра и transition_date_to должно быть не больше 7.

transition_date_to Строка

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

Дату можно получить с помощью запроса Получить статусы заказа. Дата должна быть указана в формате «YYYY-MM-DD».

Количество дней между transition_date_from и значением данного параметра должно быть не больше 7.

order_id_from Число

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

История статусов будет найдена для заказов, идентификаторы которых больше указанного.

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

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=3&orders_id=215000001%2C215000002
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=8098&orders_id=215000001%2C215000002' 'https://delivery.yandex.ru/api/last/searchSenderOrdersStatuses'

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

{
  "status":"ok",
  "data":
    {
      "orders":
        [
          {
            "order_id":"300114065",
            "order_num":"14",
            "statuses":
              [
                {
                  "update_id":"8187043",
                  "time":"2017-01-19 16:48:55",
                  "uniform_status":"DRAFT",
                  "description":""
                },
                {
                  "update_id":"8187069",
                  "time":"2017-01-19 16:59:11",
                  "uniform_status":"CREATED",
                  "description":""
                },
                {
                  "update_id":"8187071",
                  "time":"2017-01-19 17:00:26",
                  "uniform_status":"DELIVERY_LOADED",
                  "description":""
                },
                {
                  "update_id":"8187081",
                  "time":"2017-01-19 17:01:46",
                  "uniform_status":"FULFILMENT_LOADED",
                  "description":""
                }
              ]
          }
        ]
    }
}
Ключ Тип значения Описание
status Строка

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

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

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

order_num Строка Номер заказа.
statuses Массив Статусы заказа.
Ключи объекта statuses
update_id Строка

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

time Строка

Дата и время установки статуса.

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

uniform_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 — произошла ошибка.
description Строка Дополнительные описание.
Ключ Тип значения Описание
status Строка

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

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

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

order_num Строка Номер заказа.
statuses Массив Статусы заказа.
Ключи объекта statuses
update_id Строка

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

time Строка

Дата и время установки статуса.

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

uniform_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 — произошла ошибка.
description Строка Дополнительные описание.