Stock por almacén
GET /api/inventory/stock
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista el stock de los productos por almacén: una fila por producto y almacén, con los datos del producto. Es el mismo stock que descuentan las ventas y que suma el kardex.
Quién puede usarlo: cualquier usuario autenticado. Un administrador consulta todos los almacenes (o el que indique en warehouse_id); un vendedor solo el almacén de su establecimiento: si pide otro almacén responde 403.
Formato de respuesta: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}.
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
warehouse_id |
integer | No | Almacén. Un vendedor solo puede indicar el suyo (por defecto, el suyo). |
item_id |
integer | No | Un producto. |
search |
string | No | Coincidencia parcial en descripción, código interno o código de barras. |
category_id |
integer | No | Categoría. |
brand_id |
integer | No | Marca. |
stock |
string | No | positive (> 0), zero (= 0), negative (< 0) o below_min (por debajo del stock mínimo del producto). |
limit / cursor |
integer / string | No | Paginación por cursor (limit de 1 a 100, por defecto 15). |
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
Errores:
403si un vendedor pide un almacén que no es el de su establecimiento.422sistocktiene un valor no permitido o el almacén no existe.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
warehouse_id |
query | sí | 1 |
Almacén. |
search |
query | no | gaseosa |
Texto a buscar. |
stock |
query | no | below_min |
positive, zero, negative o below_min. |
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Stock
{
"success": true,
"data": [
{
"id": 640,
"item": {
"id": 15,
"internal_id": "P0015",
"description": "GASEOSA 500 ML",
"unit_type_id": "NIU",
"barcode": "7751234567890",
"category": {
"id": 2,
"name": "BEBIDAS"
},
"brand": {
"id": 4,
"name": "COCA COLA"
},
"stock_min": 5.0,
"sale_unit_price": 3.5,
"currency_type_id": "PEN",
"lots_enabled": false,
"series_enabled": false,
"active": true
},
"warehouse": {
"id": 3,
"description": "Almacén - Tienda Centro"
},
"stock": 27.0
}
],
"pagination": {
"next_cursor": "eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
"has_more": true
}
}
403 — Otro almacén
{
"success": false,
"message": "Solo puedes consultar el almacén de tu establecimiento."
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.