📋 Consulta Inventario de Guías Anticipadas
Retorna los paquetes en inventario del cliente para el NIT (y división si aplica).
GET
/inventario
v1.0.0
Descripción
📝 Descripción:
- Retorna los paquetes en inventario del cliente para el NIT (y división si aplica).
- Solo incluye registros con
cantidad_guias_disponible > 0(paquetes agotados no se listan). - Los nombres de los campos en la respuesta coinciden con las columnas de BD / contrato del microservicio.
📦 Campos de cada ítem (data[]):
| Campo | Origen |
|---|---|
id_inventario | guias_anticipadas.inventarios.id_inventario |
peso_paquete | guias_anticipadas.paquetes.peso_paquete |
id_zona | guias_anticipadas.paquetes.id_zona |
nombre_zona | guias_anticipadas.zonas.nombre_zona |
fecha_hora_expiracion | guias_anticipadas.inventarios.fecha_hora_expiracion (formato YYYY-MM-DD) |
cantidad_guias | guias_anticipadas.paquetes.cantidad_guias |
cantidad_guias_disponible | guias_anticipadas.inventarios.cantidad_guias_disponible |
guias_usadas | Calculado: cantidad_guias - cantidad_guias_disponible |
esta_expirado | Calculado en backend según fecha_hora_expiracion |
🔒 Autenticación:
- 🔑 Se requiere un token de autenticación válido como Bearer Token en el header
Authorization.
Authorization: Bearer <token>Quick Start
- Obtén tus credenciales de acceso (Bearer Token).
- Selecciona el ambiente y completa los parámetros requeridos.
- Envía la solicitud y procesa la respuesta.
Ejemplo rápido
Generando ejemplo…
Generando ejemplo…
Generando ejemplo…
Endpoint
GET
/inventario
Base URL
https://guias-anticipadas-services-test.coordinadora.com
Parámetros
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
nit query |
string | Sí | 🏢 NIT del cliente (obligatorio) |
division query |
string | No | 🏷️ División del cliente (opcional; requerida si el cliente tiene acuerdo) |
Respuesta
200
✅ Respuesta exitosa con el listado de paquetes en inventario
{
"success": true,
"data": [
{
"id_inventario": 1,
"peso_paquete": "0-5 kg",
"id_zona": null,
"nombre_zona": null,
"fecha_hora_expiracion": "2026-12-31",
"cantidad_guias": 20,
"guias_usadas": 1,
"cantidad_guias_disponible": 19,
"esta_expirado": false
}
]
}
Ejemplo de respuesta
200 ✅ Respuesta exitosa con el listado de paquetes en inventario{
"success": true,
"data": [
{
"id_inventario": 1,
"peso_paquete": "0-5 kg",
"id_zona": null,
"nombre_zona": null,
"fecha_hora_expiracion": "2026-12-31",
"cantidad_guias": 20,
"guias_usadas": 1,
"cantidad_guias_disponible": 19,
"esta_expirado": false
}
]
}
Errores
400
❌ Error de validación de parámetros
{
"isError": true,
"message": "Los valores de entrada no son correctos.",
"code": "BAD_REQUEST",
"statusCode": 400,
"cause": "El campo nit es obligatorio"
}
500
💥 Error interno del servidor
{
"isError": true,
"message": "Error al consultar inventario",
"code": "CONFUSED",
"statusCode": 500,
"cause": "Default translator error"
}