Получить список служб доставки

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

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

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

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

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&type=<тип склада>
&forImport=<возможность самопривоза>
&forWithdraw=<возможность забора>
&with_days_off=<недопустимые даты>
&with_methods_info=<данные о типах отгрузки>
&sender_region_filter=<склады  в регионе магазина>

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

type Строка

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

Допустимые значения:
  • delivery — склад службы доставки.
  • fulfillment — единый склад.
Необязательные
forImport Строка

Возможность самопривоза.

Допустимые значения:
  • 0 — самопривоз невозможен.
  • 1 — самопривоз возможен.
forWithdraw Строка

Возможность забора.

Допустимые значения:
  • 0 — забор невозможен.
  • 1 — забор возможен.
with_days_off Строка

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

Допустимые значения:
  • 0 — не учитывать.
  • 1 — учитывать.
with_methods_info Строка

Учет возможных типов отгрузки.

Допустимые значения:
  • 0 — не учитывать.
  • 1 — учитывать.
sender_region_filter Строка

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

Допустимые значения:
  • 0 — не учитывать.
  • 1 — учитывать.
Параметр Тип Значение
Обязательные
secret_key Строка

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

client_id Число

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

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

sender_id Число

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

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

type Строка

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

Допустимые значения:
  • delivery — склад службы доставки.
  • fulfillment — единый склад.
Необязательные
forImport Строка

Возможность самопривоза.

Допустимые значения:
  • 0 — самопривоз невозможен.
  • 1 — самопривоз возможен.
forWithdraw Строка

Возможность забора.

Допустимые значения:
  • 0 — забор невозможен.
  • 1 — забор возможен.
with_days_off Строка

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

Допустимые значения:
  • 0 — не учитывать.
  • 1 — учитывать.
with_methods_info Строка

Учет возможных типов отгрузки.

Допустимые значения:
  • 0 — не учитывать.
  • 1 — учитывать.
sender_region_filter Строка

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

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

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&type=fulfillment
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&type=fulfillment' 'https://delivery.yandex.ru/api/last/getDeliveries'

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

{
  "status":"ok",
  "data":
    {
      "deliveries":
        [
          {
            "id":"1385",
            "name":"в ПЭК",
            "unique_name":"delivery_PEK",
            "type":"delivery",
            "warehouses":
              [
                {
                  "id":"10328",
                  "address":""
                }
              ]
          }
        ]
    }
}
Ключ Тип значения Описание
status Строка

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

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

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

unique_name Строка

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

type Строка

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

Возможные значения:
  • fulfillment — единый склад.
  • delivery — склад службы доставки.
warehouses Массив Склады службы доставки.
Ключи объекта warehouses
id Строка Идентификатор склада.
address Строка

Адрес склада.

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

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

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

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

unique_name Строка

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

type Строка

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

Возможные значения:
  • fulfillment — единый склад.
  • delivery — склад службы доставки.
warehouses Массив Склады службы доставки.
Ключи объекта warehouses
id Строка Идентификатор склада.
address Строка

Адрес склада.