Devuelve los productos que figuran en un almacén (incluidos los que tienen existencias cero), ordenados por nombre. Los productos archivados también se incluyen.
v1/products/get_list.php
Parámetros
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| storage_id | int | Sí | ID del almacén |
| limit | int | No | Tamaño de página, de 1 a 1000 |
| offset | int | No | Cuántos registros omitir |
Sin limit se devuelve toda la lista. Consulta la paginación en Reglas generales.
Respuesta
Un array products con los campos del producto y sus existencias en el almacén storage_id, sin los SKU alternativos ni los componentes:
| Campo | Tipo | Descripción |
|---|---|---|
| id | int | ID del producto |
| name | string | Nombre |
| sku | string | SKU |
| unit | string | Unidad de medida, un código de Unidades de medida |
| price | float | Precio de venta por unidad |
| cost | float | Coste por unidad |
| batch_size | float | Tamaño del lote: la cantidad de producto para la que se indican los componentes |
| notes | string | Notas |
| status | int | Siempre 1: los productos eliminados no se devuelven |
| archived | int | 1 si el producto está archivado |
| stock | float | Existencias en el almacén storage_id |
| minimum | float | Existencias mínimas en el almacén storage_id |
| planned | float | Cambio de existencias por operaciones en estado Planificado. null si no hay ninguna |
| categories | array | Categorías del producto: objetos con id y name |
| suppliers | array | Proveedores del producto: objetos con id y name |
El campo total contiene el número total de productos del almacén.
Ejemplo de solicitud
{
"storage_id": 3999,
"limit": 100,
"offset": 0
}
Ejemplo de respuesta
{
"success": true,
"products": [
{
"id": 3120,
"name": "Mesa de comedor",
"sku": "P100",
"price": 45000,
"cost": 13604.25,
"batch_size": 10,
"notes": "",
"status": 1,
"archived": 0,
"stock": 12,
"minimum": 3,
"planned": null,
"unit": "ud",
"categories": [
{
"id": 21,
"name": "Muebles"
}
],
"suppliers": [
{
"id": 52,
"name": "Fábrica de muebles"
}
]
}
],
"total": 1
}
Errores
| Error | Motivo |
|---|---|
| No storage_id in input | Falta storage_id |
| Storage ID not found | Almacén no encontrado o eliminado |
| Invalid limit value. Must be between 1 and 1000 | limit no válido |
| Offset requires limit | se envió offset sin limit |