Saltar al contenido principal
GET
/
inventory
/
summary
Resumen de inventario
curl --request GET \
  --url https://tu-dominio.com/api/external/v1/inventory/summary \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "meta": {
    "empresa": "Mi Empresa S.A.",
    "timestamp": "2023-11-07T05:31:56Z",
    "filters_applied": {}
  },
  "data": {
    "productos": {
      "total": 500,
      "activos": 480,
      "inactivos": 20
    },
    "inventario": {
      "stock_total": 15750.5,
      "valor_total": 125000.75,
      "productos_con_stock": 450,
      "productos_sin_stock": 30,
      "productos_stock_bajo": 15
    },
    "productos_por_categoria": [
      {
        "categoria": "Electrónicos",
        "cantidad": 150
      }
    ]
  }
}

Autorizaciones

Authorization
string
header
requerido

API Key de la empresa en formato Bearer token.

Ejemplo: Authorization: Bearer G8RCjH11DabBNjnX7wO5

Parámetros de consulta

categoria
string

Filtrar resumen por categoría

tipo
enum<string>

Filtrar por tipo de producto

Opciones disponibles:
Producto,
Servicio
enable
enum<string>

Filtrar por estado del producto

Opciones disponibles:
0,
1

Respuesta

200 - application/json

Resumen de inventario obtenido exitosamente

success
boolean
requerido

Indica si la operación fue exitosa

meta
object
data
object