Золотенков

Отменить заказ покупателя.

POST https://mrp.zolotenkov.ru/api/external/v1/sales-orders/{id}/cancel

Требуемое право ключа: write:sales.order.cancel

Помечает заказ как несостоявшуюся сделку: status становится CANCELLED, в заказ записывается присланная причина и момент отмены. Склад при этом не трогается, а отгруженное остается отгруженным. Повторная отмена ничего не меняет — причина и дата первой отмены сохраняются.

Параметры пути

  • id целое число обязателен

    id заказа покупателя

Заголовки

  • Idempotency-Key строка обязателен

    Обязателен. Повтор с тем же ключом возвращает прежний ответ. Ответ на повтор помечен заголовком Idempotency-Replayed: true.

Тело запроса

Формат — application/json.

  • reason строка обязателен

    Почему сделка не состоялась. Свободный текст, обязателен.

Ответы

  • 200 Заказ отменен
  • 400 Тело запроса — не JSON-объект либо причина не передана или пуста (validation_failed)
  • 401 Ключ не передан, недействителен или отозван
  • 403 У ключа нет права write:sales.order.cancel
  • 404 В этом учете такого заказа нет
  • 409 Idempotency-Key повторен с другим телом
  • 422 Заказ уже выполнен и отмене не подлежит (sales_order_cancel_not_allowed)
  • 429 Исчерпан суточный предел документов ключа (document_quota_exceeded) либо частота обращений