Получить интервалы отгрузок

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

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

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

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

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

Параметры:

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

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

client_id Число

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

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

order_id Число

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

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

sender_id Число

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

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

warehouse_id Число

Идентификатор склада службы доставки.

shipment_type Строка

Способ отгрузки.

Допустимые значения:
  • withdraw — забор.
  • import — самопривоз.
shipment_date Строка

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

Должна быть указана в формате «YYYY-MM-DD».

delivery_name Строка

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

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

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

client_id Число

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

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

order_id Число

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

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

sender_id Число

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

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

warehouse_id Число

Идентификатор склада службы доставки.

shipment_type Строка

Способ отгрузки.

Допустимые значения:
  • withdraw — забор.
  • import — самопривоз.
shipment_date Строка

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

Должна быть указана в формате «YYYY-MM-DD».

delivery_name Строка

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

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&order_id=12345&sender_id=8098&delivery_name=Strizh&shipment_date=2016-06-17&shipment_type=withdraw&warehouse_id=123
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&order_id=12345&sender_id=8098&delivery_name=Strizh&shipment_date=2016-06-17&shipment_type=withdraw&warehouse_id=123' 'https://delivery.yandex.ru/api/last/getIntervals'

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

{
  "status":"ok",
  "data":
    {
      "schedules":
        [
          {
            "id":"82660",
            "schedule_weekday_id":"20540812",
            "warehouse_id":"9805",
            "schedule":
              {
              "id":"20540812",
                
                "from":"10:00:00",
                "to":"22:00:00",
                "is_white":"1"
              }
          }
        ],
      "days_off":[]
   }
}
Ключ Тип значения Описание
status Строка

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

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

Расписание отгрузок.

days_off Массив Служебное поле.
Ключи объекта schedules
id Строка Служебное поле.
schedule_weekday_id Строка Идентификатор дня недели.
warehouse_id Массив Идентификатор склада службы доставки.
schedule Массив Временной интервал.
Ключи объекта schedule
id Строка Идентификатор временного интервала.
from Строка Начальное время интервала.
to Строка Конечное время интервала.
is_white Строка

Использование временного интервала.

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

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

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

Расписание отгрузок.

days_off Массив Служебное поле.
Ключи объекта schedules
id Строка Служебное поле.
schedule_weekday_id Строка Идентификатор дня недели.
warehouse_id Массив Идентификатор склада службы доставки.
schedule Массив Временной интервал.
Ключи объекта schedule
id Строка Идентификатор временного интервала.
from Строка Начальное время интервала.
to Строка Конечное время интервала.
is_white Строка

Использование временного интервала.

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