Остатки

Остаток варианта на точке: прочитать уровни, установить физический остаток после пересчёта, принять или списать товар.

Загружаем поисковый индекс…

Остатки

Объекты

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
  • inventory_levelInventoryLevelобязательно

    Уровень остатка пары после записи.

Методы

Остатки по точкам, изменённые с указанного момента

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_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • variant_idinteger

    Только остатки этого варианта.

    Минимум:
    1
  • location_idinteger

    Только остатки этой точки.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив InventoryLevelобязательно

    Записи страницы.

  • 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"
Пример ответа · 200
{
  "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-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же 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

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
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
Тело запроса — 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"
}
Пример ответа · 200
{
  "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-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же 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

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
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
Тело запроса — 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
}
Пример ответа · 200
{
  "status": "applied",
  "inventory_level": {
    "variant_id": 0,
    "location_id": 0,
    "on_hand": "string",
    "reserved": "string",
    "available": "string",
    "updated_at": "2026-01-15T12:00:00Z"
  }
}