API de Inventario

Monitorea niveles de stock en tiempo real en tus almacenes.

Endpoints

GET

/inventory

inventory:read

Obtén niveles de stock de todos los productos. Soporta filtrado por almacén y estado de bajo stock.

GET

/inventory/:productId

inventory:read

Obtén información de stock de un producto específico en todos los almacenes.

Referencia de Campos

Campo	Tipo	Obligatorio	Descripción
id	string	No	ID único de registro de inventario (solo lectura)
productId	string	No	Identificador del producto
productSku	string	No	SKU del producto
productName	string	No	Nombre del producto (solo lectura)
warehouseId	string	No	Identificador del almacén
warehouseName	string	No	Nombre del almacén (solo lectura)
quantity	integer	No	Cantidad de stock actual
reservedQuantity	integer	No	Cantidad reservada para pedidos pendientes
availableQuantity	integer	No	Cantidad disponible (cantidad menos reservada)
minThreshold	integer	No	Umbral de alerta de bajo stock
updatedAt	datetime	No	Marca de tiempo de última actualización

Parámetros de Consulta (Lista)

Campo	Tipo	Obligatorio	Descripción
page	integer	No	Número de página (predeterminado: 1)
limit	integer	No	Elementos por página (predeterminado: 20, máx: 100)
warehouseId	string	No	Filtrar por ID de almacén
lowStock	boolean	No	Solo mostrar productos bajo el umbral de bajo stock

Ejemplo

Listar niveles de inventario

bash

curl "https://api.mercozy.com/api/v1/external/inventory?lowStock=true" \
  -H "X-API-Key: mk_live_your_key_here"

Obtener stock de un producto específico

bash

curl "https://api.mercozy.com/api/v1/external/inventory/prod_abc123" \
  -H "X-API-Key: mk_live_your_key_here"

Ejemplo de Respuesta

json

{
  "data": {
    "productId": "prod_abc123",
    "productName": "Premium Widget",
    "sku": "WDG-001",
    "quantity": 42,
    "lowStockThreshold": 10,
    "warehouseId": "wh_main",
    "warehouseName": "Main Warehouse",
    "updatedAt": "2025-12-15T10:30:00Z"
  }
}