Возвращает продукты, которые числятся на складе (в том числе с нулевым остатком), отсортированные по названию. Архивные продукты тоже входят в список.
v1/products/get_list.php
Параметры
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| storage_id | int | Да | ID склада |
| limit | int | Нет | Размер страницы, от 1 до 1000 |
| offset | int | Нет | Сколько записей пропустить |
Без limit возвращается весь список. Подробнее о постраничной выдаче в статье Общие правила.
Ответ
Массив products с полями продукта и его остатком на складе storage_id, без альтернативных SKU и состава:
| Поле | Тип | Описание |
|---|---|---|
| id | int | ID продукта |
| name | string | Название |
| sku | string | Артикул |
| unit | string | Единица измерения, код из статьи Единицы измерения |
| price | float | Цена продажи за единицу |
| cost | float | Себестоимость единицы |
| batch_size | float | Размер партии: на какое количество продукта указан состав |
| notes | string | Заметки |
| status | int | Всегда 1: удаленные продукты не возвращаются |
| archived | int | 1, если продукт в архиве |
| stock | float | Остаток на складе storage_id |
| minimum | float | Минимальный остаток на складе storage_id |
| planned | float | Изменение остатка по операциям в статусе План. null, если таких операций нет |
| categories | array | Категории продукта: объекты с id и name |
| suppliers | array | Поставщики продукта: объекты с id и name |
Поле total содержит общее число продуктов на складе.
Пример запроса
{
"storage_id": 3999,
"limit": 100,
"offset": 0
}
Пример ответа
{
"success": true,
"products": [
{
"id": 3120,
"name": "Стол обеденный",
"sku": "P100",
"price": 45000,
"cost": 13604.25,
"batch_size": 10,
"notes": "",
"status": 1,
"archived": 0,
"stock": 12,
"minimum": 3,
"planned": null,
"unit": "шт",
"categories": [
{
"id": 21,
"name": "Мебель"
}
],
"suppliers": [
{
"id": 52,
"name": "Мебельная фабрика"
}
]
}
],
"total": 1
}
Ошибки
| Ошибка | Причина |
|---|---|
| No storage_id in input | Не передан storage_id |
| Storage ID not found | Склад не найден или удален |
| Invalid limit value. Must be between 1 and 1000 | Неверный limit |
| Offset requires limit | Передан offset без limit |