Documentação da API

API de estoque WMS

Última atualização 2026-10-13

Consultar saldos, ajustar estoque e mover entre localizações.

Consultar estoque#

GET /api/wms/inventory
GET /api/wms/inventory?warehouse_id=<uuid>&item_id=<uuid>&status=available&page=1&page_size=20
// filters: warehouse_id | location_id | location (code) | item_id | sku | merchant_id | status
// status: available | allocated | hold | damaged | in_transit
  • Lê a projeção wms_inventory_balance (item × localização × status × lote).
  • Permissão: qualquer ponto de visualização operacional.

Ajustar estoque#

POST /api/wms/inventory/adjust
POST /api/wms/inventory/adjust
{
  "warehouse_id": "<uuid>",   // required
  "location_id": "<uuid>",    // required
  "item_id": "<uuid>",        // required
  "qty_delta": -5,            // or qty_after — exactly one is required
  "reason_code": "damage",    // required, e.g. damage | lost | found
  "lot_no": "LOT-001",
  "merchant_id": "<uuid>",    // required in 3PL edition
  "status": "available"       // default available
}
  • qty_after ou qty_delta — passe exatamente um.
  • O ponto wms.inventory_adjust é especial: deve ser concedido explicitamente.

Mover estoque#

POST /api/wms/inventory/move
POST /api/wms/inventory/move
{
  "warehouse_id": "<uuid>",     // required
  "to_location_id": "<uuid>",   // required
  "pallet_lpn": "LPN-20261013-ABC123",   // pallet move…
  // …or loose stock move:
  // "from_location_id": "<uuid>", "item_id": "<uuid>", "qty": 10, "lot_no": "LOT-001",
  "notes": "补货上架"
}
O ajuste escreve apenas no ledger (transaction_type=adjust), nunca no saldo diretamente. Mover de uma localização bloqueada por contagem falha com LOCATION_LOCKED.