API de Estoque

Monitore niveis de estoque em seus armazens em tempo real.

Endpoints

GET

/inventory

inventory:read

Obtenha niveis de estoque de todos os produtos. Suporta filtragem por armazem e status de baixo estoque.

GET

/inventory/:productId

inventory:read

Obtenha informacoes de estoque de um produto especifico em todos os armazens.

Referencia de Campos

Campo	Tipo	Obrigatorio	Descricao
id	string	Nao	ID único do registro de estoque (somente leitura)
productId	string	Nao	Identificador do produto
productSku	string	Nao	SKU do produto
productName	string	Nao	Nome do produto (somente leitura)
warehouseId	string	Nao	Identificador do armazem
warehouseName	string	Nao	Nome do armazem (somente leitura)
quantity	integer	Nao	Quantidade de estoque atual
reservedQuantity	integer	Nao	Quantidade reservada para pedidos pendentes
availableQuantity	integer	Nao	Quantidade disponível (quantidade menos reservada)
minThreshold	integer	Nao	Limiar de alerta de baixo estoque
updatedAt	datetime	Nao	Timestamp da ultima atualizacao de estoque

Parametros de Consulta (Lista)

Campo	Tipo	Obrigatorio	Descricao
page	integer	Nao	Numero da pagina (padrao: 1)
limit	integer	Nao	Itens por pagina (padrao: 20, max: 100)
warehouseId	string	Nao	Filtrar por ID de armazem
lowStock	boolean	Nao	Mostrar apenas produtos abaixo do limiar de baixo estoque

Exemplo

Listar niveis de estoque

bash

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

Obter estoque de um produto especifico

bash

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

Exemplo de Resposta

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"
  }
}