Skip to main content

​
Visão Geral

A API de Consulta de Estoque do WMS foi desenvolvida para permitir que sistemas externos consultem a **posição atual de estoque **de forma padronizada, segura e performática. Seu objetivo é disponibilizar uma visão consolidada ou detalhada do estoque da empresa autenticada, respeitando o contexto multi-tenant do WMS e aplicando os filtros informados na requisição. A consulta pode ser realizada com base em diferentes critérios, como:
  • código do produto
  • lote
  • endereço
  • etiqueta
Dessa forma, a API de Consulta de Estoque permite integrar o WMS com ERPs, portais, sistemas legados ou outras aplicações externas, oferecendo uma visão confiável e atualizada do estoque armazenado. Método HTTP: POST /v1/estoque-geral

​
Headers

NomeValor
Content-Typeapplication/json
AuthorizationBearer <token>

​
Campos

​
Produto

NomeTipoDescrição
produto_codigostringCódigo do produto
lotestringLote do produto
endereco_codigostringExemplo: A-01-B-001
etiqueta_codigostringCódigo da etiqueta
agrupar_porstringAceita: produto produto_lote endereco etiqueta

​
Exemplo

{
  "produto_codigo": "AGUA001",
  "lote": "AGA0919",
  "agrupar_por": "produto_lote"
}

{
	"ok": true,
	"status": 200,
	"filtros": {
		"lote": "AGA0919",
		"agrupar_por": "produto_lote",
		"produto_codigo": "AGUA001",
		"endereco_codigo": null,
		"etiqueta_codigo": null
	},
	"message": "Consulta de estoque realizada com sucesso",
	"resultado": [
		{
			"lote": "AGA0919",
			"produto_id": "c65d04f2-3d05-4175-868b-1a7c4c1b9096",
			"total_linhas": 4,
			"data_validade": "2039-01-01",
			"produto_codigo": "AGUA001",
			"unidade_medida": "UN",
			"total_enderecos": 3,
			"total_etiquetas": 4,
			"peso_bruto_total": 0,
			"quantidade_total": 1000,
			"produto_descricao": "Água Mineral sem Gás 1,5L",
			"peso_liquido_total": 0,
			"quantidade_bloqueada": 0,
			"quantidade_reservada": 0,
			"quantidade_disponivel": 1000
		}
	]
}

​
Erros comuns

CódigoMensagemCausa Provável
400Parâmetro agrupar_por inválidoValor diferente dos aceitos pela API. Valores permitidos:
produto, produto_lote, endereco, etiqueta
401Sessão inválidaToken Bearer ausente, inválido, expirado ou não reconhecido.
400Parâmetros enviados em formato inválidoAlgum campo de filtro foi enviado em formato incompatível com o esperado
400Filtro de consulta inválidoUm ou mais filtros informados não puderam ser processados corretamente
500Erro interno ao processar entradaFalha inesperada no processamento da RPC, normalmente causada por inconsistência de dados,
relacionamento inválido ou estrutura incompleta no banco
  • Se nenhum parâmetro for enviado na requisição, o sistema aplicará automaticamente o filtro "agrupar_por": "produto_lote".
  • A função respeita as RLS policies para garantir que o usuário só altere dados da empresa à qual está vinculado.