Возвращает материалы, которые числятся на складе (в том числе с нулевым остатком), отсортированные по названию. Архивные материалы тоже входят в список.
v1/materials/get_list.php
Параметры
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| storage_id | int | Да | ID склада |
| limit | int | Нет | Размер страницы, от 1 до 1000 |
| offset | int | Нет | Сколько записей пропустить |
Без limit возвращается весь список. Подробнее о постраничной выдаче в статье Общие правила.
Ответ
Массив materials с полями материала и его остатком на складе storage_id:
| Поле | Тип | Описание |
|---|---|---|
| id | int | ID материала |
| name | string | Название |
| sku | string | Артикул |
| unit | string | Единица измерения, код из статьи Единицы измерения |
| price | float | Цена за единицу |
| notes | string | Заметки |
| 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": 3998,
"limit": 100,
"offset": 0
}
Пример ответа
{
"success": true,
"materials": [
{
"id": 2051,
"name": "Доска дубовая",
"sku": "M010",
"price": 135000,
"notes": "",
"archived": 0,
"stock": 4.2,
"minimum": 1,
"planned": null,
"unit": "куб. м",
"categories": [
{
"id": 12,
"name": "Древесина"
}
],
"suppliers": [
{
"id": 45,
"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 |