Возвращает данные продукта, его остаток на складе и состав.
v2/products/get_entry.php
Параметры
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| product_id | int | Да | ID продукта |
| storage_id | int | Да | ID склада |
Продукт возвращается, только если он числится на складе storage_id. Остатки на всех складах сразу возвращает v1/products/get_stocks.
Ответ
Объект product с полями продукта, остатком на складе storage_id, категориями, поставщиками, альтернативными SKU и составом.
| Поле | Тип | Описание |
|---|---|---|
| id | int | ID продукта |
| name | string | Название |
| sku | string | Артикул |
| unit | string | Единица измерения, код из статьи Единицы измерения |
| price | float | Цена продажи за единицу |
| cost | float | Себестоимость единицы |
| batch_size | 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 |
| alternative_sku | array | Альтернативные SKU: объекты с label и sku |
Кроме перечисленных полей в объекте есть состав:
| Поле | Тип | Описание |
|---|---|---|
| materials | array | Материалы в составе |
| products | array | Заготовки в составе |
| resources | array | Ресурсы в составе |
Поля строк materials, products и resources:
| Поле | Описание |
|---|---|
| id | ID материала, продукта или ресурса |
| name | Название |
| sku | Артикул. Только у материалов и заготовок |
| type | Тип расчета ресурса. Только у ресурсов (см. Создание ресурса) |
| dynamic | 1, если цена или процент указывается в составе продукта. Только у ресурсов |
| base | База расчета процентного ресурса: cost или price. Только у ресурсов |
| amount_per_batch | Количество на партию |
| amount_per_unit | Количество на единицу продукта: amount_per_batch / batch_size |
| loss_percent | Потери в процентах. Только у материалов и заготовок |
| unit | Единица измерения. У процентного ресурса «%» |
| cost_per_unit | Стоимость строки на единицу продукта |
| cost_per_batch | Стоимость строки на партию |
| position | Порядковый номер строки: общий для materials и products, отдельный для resources |
У ресурса с типом фиксированная ставка и ценой в составе продукта amount_per_batch содержит сумму в рублях, а не количество.
cost_per_unit и cost_per_batch учитывают потери при loss_percent > 0.
Строки состава, категории и поставщиков из ответа можно передать в v1/products/edit без изменений.
Пример запроса
{
"product_id": 3120,
"storage_id": 3999
}
Пример ответа
{
"success": true,
"product": {
"id": 3120,
"name": "Стол обеденный",
"sku": "P100",
"price": 45000,
"cost": 13604.25,
"batch_size": 10,
"notes": "",
"archived": 0,
"stock": 12,
"minimum": 3,
"planned": null,
"unit": "шт",
"categories": [
{
"id": 21,
"name": "Мебель"
}
],
"alternative_sku": [
{
"label": "Ozon",
"sku": "OZ-P100"
}
],
"suppliers": [
{
"id": 46,
"name": "ООО Мебельторг"
}
],
"materials": [
{
"id": 2051,
"name": "Доска дубовая",
"sku": "M010",
"amount_per_unit": 0.05,
"amount_per_batch": 0.5,
"loss_percent": 5,
"unit": "куб. м",
"cost_per_unit": 7087.5,
"cost_per_batch": 70875,
"position": 0
},
{
"id": 2060,
"name": "Саморез 4x40",
"sku": "M024",
"amount_per_unit": 40,
"amount_per_batch": 400,
"loss_percent": 0,
"unit": "шт",
"cost_per_unit": 80,
"cost_per_batch": 800,
"position": 1
}
],
"products": [
{
"id": 312,
"name": "Ножка стола",
"sku": "P012",
"amount_per_unit": 4,
"amount_per_batch": 40,
"loss_percent": 0,
"unit": "шт",
"cost_per_unit": 3400,
"cost_per_batch": 34000,
"position": 2
}
],
"resources": [
{
"id": 57,
"name": "Работа столяра",
"type": "rate",
"dynamic": 0,
"base": null,
"amount_per_unit": 3,
"amount_per_batch": 30,
"unit": "ч",
"cost_per_unit": 1800,
"cost_per_batch": 18000,
"position": 0
},
{
"id": 58,
"name": "Накладные расходы",
"type": "percent",
"dynamic": 0,
"base": "cost",
"amount_per_unit": 10,
"amount_per_batch": 10,
"unit": "%",
"cost_per_unit": 1236.75,
"cost_per_batch": 12367.5,
"position": 1
}
]
}
}
Ошибки
| Ошибка | Причина |
|---|---|
| No product_id in input | Не передано обязательное поле (вместо product_id будет имя поля) |
| Storage ID not found | Склад не найден или удален |
| Product not found or access denied | Продукт не найден, удален или не числится на складе |
Версия v1
Метод v1/products/get_entry принимает те же параметры и возвращает те же поля продукта. Отличается только представление состава, поэтому в новых интеграциях используйте v2.
| Что | v1 | v2 |
|---|---|---|
| Состав | Один массив components: материалы и заготовки вместе | Раздельные массивы materials, products и resources |
| id в строках состава | Префиксные: «m-123» для материала, «p-45» для заготовки | Числовой id позиции |
| Отправка строк обратно в add и edit | Нельзя без изменений, мешают префиксные id | Можно как есть |
Кроме того, v1 возвращает служебные поля, которые v2 опускает: product.status и status строк состава (всегда 1) и product.percent (вычисляется из cost и price).