Оформить заказ

Запрос позволяет отправить данные о заказе, дате и способе его отгрузки в службу доставки. В Яндекс.Доставке заказ будет переведен из статуса DRAFT в CREATED.

Чтобы оформить заказ:
  • он должен быть в статусе DRAFT;

  • все его данные должны быть заполнены (с помощью запроса Обновить черновик заказа или в личном кабинете Яндекс.Доставки).

После оформления заказа можно:

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

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

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

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

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

order_ids Строка

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

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

shipment_date Строка

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

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

type Строка

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

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

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

client_id Число

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

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

sender_id Число

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

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

order_ids Строка

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

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

shipment_date Строка

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

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

type Строка

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

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

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001%2C215000002&sender_id=8098&order_ids=215000103&shipment_date=2016-07-01&type=withdraw
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001%2C215000002&sender_id=8098&order_ids=215000103&shipment_date=2016-07-01&type=withdraw' 'https://delivery.yandex.ru/api/last/confirmSenderOrders'

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

{
 "status":"ok",
 "data":
   {
     "result":
       {
         "error":[],
         "success":
           [
             {
               "parcel_id":"172539",
               "orders":
                 [
                   "1158459"
                 ]
             }
           ]
       }
   }
}
Ключ Тип значения Описание
status Строка

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

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

Данные об отгрузке и заказах, входящих в нее.

Ключи объекта success
parcel_id Строка Идентификатор отгрузки.
orders Массив

Идентификаторы заказов, входящих в отгрузку.

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

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

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

Данные об отгрузке и заказах, входящих в нее.

Ключи объекта success
parcel_id Строка Идентификатор отгрузки.
orders Массив

Идентификаторы заказов, входящих в отгрузку.