Отменить заказ

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

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

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

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

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

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

order_id Число

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

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

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

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

client_id Число

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

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

sender_id Число

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

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

order_id Число

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

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

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&order_id=215000019
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=215000001&sender_id=8098&order_id=215000019' 'https://delivery.yandex.ru/api/last/deleteOrder'

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

Запрос выполнен успешно
{
  "status":"ok",
  "data":"ok"
}
Ключ Тип значения Описание
status Строка

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

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Строка

Факт отмены заказа.

Возможное значение — ok.

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

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

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Строка

Факт отмены заказа.

Возможное значение — ok.

Запрос выполнен с ошибкой
{
  "status":"error",
  "data":
    {
      "errors":
        {
          "order_id":"Заказ в этом статусе удалить нельзя"
        }
    },
  "error":"ERROR_WRONG_PARAMS"
}
Ключ Тип значения Описание
status Строка

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

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

Тип ошибки.

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

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

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

Тип ошибки.

Возможные значения:
  • RUNTIME_ERROR — сбой работы API.
  • ERROR_WRONG_PARAMS — другая ошибка.