Создать заявку на забор

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

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

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

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

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&warehouse_from_id=<идентификатор склада отправления>
&interval=<идентификатор интервала отгрузки>
&shipment_date=<дата отгрузки>
&delivery_name=<название службы доставки или единого склада>
&volume=<общий объем заказов>
&weight=<общий вес заказов>
[&warehouse_to_id=<идентификатор склада назначения>]
[&requisite_id=<идентификатор реквизитов магазина>]
[&sort=<сортировка на едином складе>]
[&comment=<дополнительное описание>]

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

warehouse_from_id Число

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

interval Число

Идентификатор интервала отгрузки.

shipment_date Строка

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

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

delivery_name Строка

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

volume Число

Общий объем заказов (в метрах кубических).

weight Строка

Общий вес заказов (в килограммах).

Необязательные
warehouse_to_id Число

Идентификатор склада, на который нужно отгрузить заказы.

requisite_id Строка

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

sort Строка

Необходимость сортировки на едином складе.

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

Параметр обязателен, если delivery_name принимает значение fulfillment_Strizh.

comment Строка

Дополнительное описание.

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

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

client_id Число

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

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

sender_id Число

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

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

warehouse_from_id Число

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

interval Число

Идентификатор интервала отгрузки.

shipment_date Строка

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

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

delivery_name Строка

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

volume Число

Общий объем заказов (в метрах кубических).

weight Строка

Общий вес заказов (в килограммах).

Необязательные
warehouse_to_id Число

Идентификатор склада, на который нужно отгрузить заказы.

requisite_id Строка

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

sort Строка

Необходимость сортировки на едином складе.

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

Параметр обязателен, если delivery_name принимает значение fulfillment_Strizh.

comment Строка

Дополнительное описание.

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

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

client_id=215000001&sender_id=8098&secret_key=6f08ebd49a996fcb6666fc130f491a2d&warehouse_from_id=4450&interval=&weight=5&volume=0.6&delivery_name=Axiomus&shipment_date=2016-06-20&interval=25984
cURL
curl  -d 'client_id=215000001&sender_id=8098&secret_key=6f08ebd49a996fcb6666fc130f491a2d&warehouse_from_id=4450&interval=&weight=5&volume=0.6&delivery_name=Axiomus&shipment_date=2016-06-20&interval=25984' 'https://delivery.yandex.ru/api/last/createWithdraw'

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

{
  "status":"ok",
  "data":
    { 
      "parcel":
        {
          "id":"178608",
          "withdraw_id":"137460",
          "external_id":null,
          "status":"1",
          "requisite_id":"9",
          "created":"2017-01-27 10:24:56",
          "shipment_date":"2017-01-29",
          "warehouse_from_id":"2872",
          "warehouse_to_id":"9805",
          "volume":"10.000000",
          "weight":"10.00",
          "delivery":"delivery_Strizh",
          "to_yd_warehouse":0
        }
    }
}
Ключ Тип значения Описание
status Строка

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

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

ID заявки на отгрузку.

external_id Строка

Номер заявки на отгрузку в службе доставки.

status Строка

Статус заявки на отгрузку.

requisite_id Строка

ID реквизитов магазина.

created Строка

Дата создания заявки на отгрузку.

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

shipment_date Строка

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

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

warehouse_from_id Строка

ID склада магазина.

warehouse_to_id Строка

Идентификатор склада, на который нужно отгрузить заказы.

volume Строка

Общий объем заказов (в метрах кубических).

weight Строка

Общий вес заказов (в килограммах).

delivery Строка

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

to_yd_warehouse Строка

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

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

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

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

ID заявки на отгрузку.

external_id Строка

Номер заявки на отгрузку в службе доставки.

status Строка

Статус заявки на отгрузку.

requisite_id Строка

ID реквизитов магазина.

created Строка

Дата создания заявки на отгрузку.

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

shipment_date Строка

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

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

warehouse_from_id Строка

ID склада магазина.

warehouse_to_id Строка

Идентификатор склада, на который нужно отгрузить заказы.

volume Строка

Общий объем заказов (в метрах кубических).

weight Строка

Общий вес заказов (в килограммах).

delivery Строка

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

to_yd_warehouse Строка

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

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