Platitun · API · Склад автовыдачи · Пополнить склад

Пополнить склад

POST /api/v1/listings/{number}/stock

Область ключа: stock · изменяет данные, нужен заголовок Idempotency-Key

Единицы склада — это то, что получит покупатель: код, ссылка, пара «почта и пароль». Они шифруются при записи, и обратно их не прочитать даже вам.

Пополнение склада — самое частое действие программы, и повтор при разрыве связи здесь дороже всего: две тысячи единиц вместо тысячи. Заголовок Idempotency-Key обязателен, и повтор с тем же ключом вернёт прежний ответ.

Поля запроса

Поле	Тип	Что это
`items` обязательно	`array`	Список строк — по одной на единицу склада.

Поля ответа

Поле	Тип	Что это
`added`	`integer`	Сколько единиц принято.
`free`	`integer`	Сколько теперь свободно.

Поводы отказа

Отказ по правилам приходит как {"error":"rejected","refusal":{"kind":"…"}} с кодом 409. Общие для всех путей отказы — в разделе правил.

Код	Что случилось и что делать
`not_found`	Записи нет или она не ваша. Условие владения стоит в самом запросе к базе, поэтому чужая запись выглядит как отсутствующая.
`stock_empty`	Список единиц склада пуст. Пустое пополнение ничего не меняет, поэтому оно отвергается, а не проходит молча.
`stock_too_many`	За один раз столько единиц не принимается. Разбейте пополнение на части.
`vault_off`	Сейф площадки не настроен, и хранить секреты негде. Это наша беда, а не ваша: напишите в поддержку.
`bad_request`	Запрос собран неверно: не хватает обязательного поля или значение не того вида. Подробность — в поле detail.

Рядом в этом разделе

GET /api/v1/listings/{number}/stock — Что на складе