Золотенков

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

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

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

Меняет только переданные поля заказа. Завершенный заказ изменению не подлежит.

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

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

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

Заголовки

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

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

Тело запроса

Формат — application/json.

  • currency строка необязателен может быть пустым
  • customer_id целое число необязателен может быть пустым
  • customer_reference строка необязателен может быть пустым

    «Доп. № заказа клиента», до 255 символов. Пробелы по краям отрезаются. Пустая строка стирает номер — то же значение, что и пустое поле в карточке заказа; null и отсутствие поля его не трогают.

  • delivery_date дата и время необязателен может быть пустым
  • items массив объектов необязателен может быть пустым

    Прислали items — набор строк заказа заменяется присланным целиком: строки, которых в нем нет, из заказа удаляются. Не прислали — строки не трогаются вовсе.

  • items.discount_pct десятичная дробь необязателен может быть пустым

    Скидка строки в процентах, от 0 до 100; отсутствие поля означает ноль.

  • items.item_variant_id целое число обязателен
  • items.price десятичная дробь обязателен

    Цена за единицу без НДС и без скидки строки.

  • items.quantity десятичная дробь обязателен
  • items.storage_place_id целое число необязателен может быть пустым

    Склад отгрузки строки, номер из GET /storage-places. Не прислали — строке ставится склад продаж по умолчанию: склад из настроек продаж, а если он не задан — склад с отметкой «по умолчанию», затем склад с наименьшим номером. У строки заказа склад есть всегда.

  • items.tax_rate десятичная дробь необязателен может быть пустым

    Ставка НДС в процентах; отсутствие поля и ноль означают «налога нет».

  • notes строка необязателен может быть пустым
  • priority целое число необязателен может быть пустым
  • shipping_fee объект необязателен

Ответы

  • 200 Заказ изменен
  • 400 Некорректное тело либо ссылка на строку другого клиента
  • 401 Ключ не передан, недействителен или отозван
  • 403 У ключа нет права write:sales.order.update
  • 404 В этом учете такого заказа или покупателя нет
  • 409 Заказ уже завершен (sales_order_not_editable) либо Idempotency-Key повторен с другим телом
  • 422 Правка задевает строку, отгруженную в закрытом учетном периоде: ее нельзя удалить, заменить в ней товар, изменить цену или НДС, а количество — сделать меньше отгруженного там (inventory_period_closed)
  • 429 Превышена частота обращений. Задержка до повтора — в заголовке Retry-After