Остатки
Остаток варианта на точке: прочитать уровни, установить физический остаток после пересчёта, принять или списать товар.
Остатки
Объекты
InventoryLevel
variant_idintegerобязательноID варианта. Вместе с location_id определяет уровень остатка; у пары, которой нет в списке, остаток нулевой.
location_idintegerобязательноID точки магазина.
on_handstringобязательноФизический остаток точки по всем её ячейкам, десятичной строкой в единице варианта. Установка остатка называет и сверяет именно его.
reservedstringобязательноКоличество, зарезервированное под заказы, десятичной строкой в единице варианта.
availablestringобязательноСколько можно продать: остаток, доступный к отбору, минус резерв, десятичной строкой. Отрицательный, если продано больше, чем было.
updated_atstring (date-time) или nullобязательноКогда остаток менялся последний раз; null, если по паре ещё не было движений.
InventoryChange
statusstringобязательноИсход записи: applied — остаток изменился; unchanged — остаток уже был таким; pending_approval — списание ждёт подтверждения в магазине: on_hand ещё прежний, а available уже без удержанного количества.
- Значения:
appliedunchangedpending_approval
Уровень остатка пары после записи.
Методы
Остатки по точкам, изменённые с указанного момента
get/inventory-levels
Scope: inventory:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
variant_idintegerТолько остатки этого варианта.
- Минимум:
- 1
location_idintegerТолько остатки этой точки.
- Минимум:
- 1
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/inventory-levels" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"variant_id": 0,
"location_id": 0,
"on_hand": "string",
"reserved": "string",
"available": "string",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Установить физический остаток варианта на точке
post/inventory-levels/set
Scope: inventory:write
Параметры
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
variant_idintegerобязательноID варианта. Вместе с location_id определяет уровень остатка; у пары, которой нет в списке, остаток нулевой.
location_idintegerобязательноID точки магазина.
commentstring или nullКомментарий движения.
- Макс. длина:
- 500
lot_numberstring или nullПартия, в которую идёт разница, у варианта с учётом партий.
- Макс. длина:
- 64
expires_atstring (date) или nullСрок годности новой партии, в часовом поясе магазина.
on_handstringобязательноФизический остаток точки по всем её ячейкам, десятичной строкой в единице варианта. Установка остатка называет и сверяет именно его.
- Макс. длина:
- 32
- Шаблон:
^-?\d{1,15}(\.\d{1,15})?$
expected_on_handstringобязательноФизический остаток, от которого вы считали, десятичной строкой. Если остаток с тех пор изменился, запрос получит 409 stock_on_hand_changed и ничего не изменит.
- Макс. длина:
- 32
- Шаблон:
^-?\d{1,15}(\.\d{1,15})?$
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает InventoryChange
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 409
stock_held_by_write_offsОстаток удержан списаниями на подтверждении - 409
stock_on_hand_changedОстаток изменился - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/inventory-levels/set" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"variant_id": 0,
"location_id": 0,
"comment": "string",
"lot_number": "string",
"expires_at": "2026-01-15",
"on_hand": "string",
"expected_on_hand": "string"
}{
"status": "applied",
"inventory_level": {
"variant_id": 0,
"location_id": 0,
"on_hand": "string",
"reserved": "string",
"available": "string",
"updated_at": "2026-01-15T12:00:00Z"
}
}Оприходовать или списать остаток на точке
post/inventory-levels/adjust
Scope: inventory:write
Параметры
Заголовок
Idempotency-KeystringУникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.
- Мин. длина:
- 1
- Макс. длина:
- 255
- Пример:
8e03978e-40d5-43e8-bc93-6894a57f9324
Тело запроса application/json
variant_idintegerобязательноID варианта. Вместе с location_id определяет уровень остатка; у пары, которой нет в списке, остаток нулевой.
location_idintegerобязательноID точки магазина.
commentstring или nullКомментарий движения; обязателен, если его требует причина списания.
- Макс. длина:
- 500
lot_numberstring или nullУ прихода варианта с учётом партий — партия; новая получает expires_at. Без номера товар ложится в новую партию с автономером, как при приёмке.
- Макс. длина:
- 64
expires_atstring (date) или nullСрок годности новой партии, в часовом поясе магазина.
reasonstringобязательноrestock — товар пришёл, delta больше нуля; write_off — товар списывается по причине магазина (write_off_reason_id), delta меньше нуля.
- Значения:
restockwrite_off
deltastringобязательноИзменение физического остатка, десятичной строкой в единице варианта. Уменьшить остаток без причины списания нельзя: исправление неверного пересчёта — через установку остатка.
- Макс. длина:
- 32
- Шаблон:
^-?\d{1,15}(\.\d{1,15})?$
write_off_reason_idintegerУ write_off — причина (/v1/write-off-reasons); она должна быть selectable.
Ответы
200Успешно
Заголовки
Idempotent-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.
- Значения:
true
application/json
Возвращает InventoryChange
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает ConflictProblem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/inventory-levels/adjust" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"variant_id": 0,
"location_id": 0,
"comment": "string",
"lot_number": "string",
"expires_at": "2026-01-15",
"reason": "restock",
"delta": "string",
"write_off_reason_id": 0
}{
"status": "applied",
"inventory_level": {
"variant_id": 0,
"location_id": 0,
"on_hand": "string",
"reserved": "string",
"available": "string",
"updated_at": "2026-01-15T12:00:00Z"
}
}