Ревизии
Ревизии остатков точки: охват, слепой счёт и статус от черновика до проведения. Строки — отдельной лентой.
Ревизии
Объекты
Stocktake
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
numberstring или nullобязательноНомер ревизии в магазине.
location_idintegerобязательноID точки ревизии (/v1/locations).
statusstringобязательноdraft — идёт счёт; committing — коррекции пишутся фоном; committed — проведена, коррекции — движения склада с document.type = stocktake; voided — черновик отменён, движений нет. Сбой проведения возвращает ревизию в draft.
- Значения:
draftcommittingcommittedvoided
blindbooleanобязательноСлепой счёт: пока ревизия в draft, учёт и расхождение её строк — null.
coverageobjectобязательноЧто считают.
Поля · 2
typestringобязательноfull — вся точка; category — выбранные категории; selection — позиции, набранные в ходе счёта.
- Значения:
fullcategoryselection
category_idsмассив integer или nullобязательноID категорий (/v1/categories) у охвата category; у прочих null.
notestring или nullобязательноЗаметка к ревизии; null, если её нет.
submitted_atstring (date-time) или nullобязательноКогда счётчик передал ревизию на проведение; null — не передавал.
committed_atstring (date-time) или nullобязательноКогда применены коррекции; null — ревизия не проведена.
voided_atstring (date-time) или nullобязательноКогда черновик отменили; null — не отменяли.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Ревизии остатков: охват, статус и даты, изменённые с указанного момента
get/stocktakes
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})$
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/stocktakes" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"location_id": 0,
"status": "draft",
"blind": true,
"coverage": {
"type": "full",
"category_ids": [
0
]
},
"note": "string",
"submitted_at": "2026-01-15T12:00:00Z",
"committed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"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"
}Ревизия остатков
get/stocktakes/{stocktake}
Scope: inventory:read
Параметры
Путь
stocktakeintegerобязательноID ревизии.
Ответы
200Успешно
application/json
Возвращает Stocktake
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
404Объекта нет или он недоступен приложению
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/stocktakes/{stocktake}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"location_id": 0,
"status": "draft",
"blind": true,
"coverage": {
"type": "full",
"category_ids": [
0
]
},
"note": "string",
"submitted_at": "2026-01-15T12:00:00Z",
"committed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}