Obtener depósito por su ID
Obtiene información detallada de un depósito específico usando su ID único. Incluye datos del almacén, establecimiento y stock de mercaderías.
Entorno
Sección titulada «Entorno»URL Base: https://api.guarani.app
Endpoint
Sección titulada «Endpoint»GET /depositos/{id}Ejemplo de solicitud
Sección titulada «Ejemplo de solicitud»curl -X GET "https://api.guarani.app/depositos/{id}" \ -H "x-api-key: Bearer <access_token>" \ -H "Accept: application/json" | jqNota: Asegúrate de reemplazar
{id}con el identificador del deposito y<access_token>con un token JWT válido proporcionado por el equipo Guarani.
Importante:
Es imprescindible incluir un token de acceso válido en el encabezadox-api-keypara autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.
Parámetros de ruta
Sección titulada «Parámetros de ruta»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
id | uuid | Sí | ID único del deposito a consultar. (ver depositos) |
Encabezados de la Solicitud
Sección titulada «Encabezados de la Solicitud»| Encabezado | Valor | Descripción |
|---|---|---|
x-api-key | Bearer <access_token> | Token JWT de autenticación. |
Accept | application/json | Solicita que la respuesta sea en JSON. |
Ejemplo de respuesta
Sección titulada «Ejemplo de respuesta»{ "success": true, "codigo": "200", "message": "Operación realizada correctamente.", "data": { "id": "33ccbca5-4fe6-457d-aaca-891b297c301b", "nombre": "Depósito Central", "observacion": "Almacén principal de productos textiles", "stock_maximo": 100, "stock_actual": 70, "stock_minimo": 15, "mercaderia": { "id": "ejemplo-uuid-mercaderia-123", "descripcion": "Zapatillas urbanas unisex" }, "establecimiento": { "id": "ejemplo-uuid-establecimiento-123", "nombre": "MATRIZ" } }}Descripción de Campos de Respuesta
Sección titulada «Descripción de Campos de Respuesta»Campos principales
Sección titulada «Campos principales»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único del depósito. |
nombre | string | Nombre del depósito o almacén. |
observacion | string | Observación o descripción adicional del depósito. |
stock_maximo | number | Stock máximo permitido en el depósito para esta mercadería. |
stock_actual | number | Cantidad actual disponible del producto en el depósito. |
stock_minimo | number | Stock mínimo permitido antes de emitir alerta. |
mercaderia | objeto | Información básica de la mercadería asociada. |
establecimiento | objeto | Información del establecimiento al que pertenece el depósito. |
Campos de mercaderia
Sección titulada «Campos de mercaderia»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la mercadería. |
descripcion | string | Descripción de la mercadería. |
Campos de establecimiento
Sección titulada «Campos de establecimiento»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único del establecimiento. |
nombre | string | Nombre del establecimiento. |
Recursos adicionales
Sección titulada «Recursos adicionales»Para más información sobre posibles errores relacionados, consulta la sección errores.