Consultar a posição de estoque

Um item por produto do estabelecimento, com saldo, nível de reposição, custos, valor em estoque, última
compra e datas da última entrada e saída, em ordem crescente de produtoId. Só leitura: a consulta roda na
réplica e pode ter alguns segundos de atraso.

Paginação por cursor: a resposta não traz total de registros. Para ler todos os produtos, repita a
chamada com aposId igual ao proximoId da resposta anterior, enquanto temMais for true. pageSize
padrão e máximo é 50.

Quantidades: quantidadeAtual, quantidadeMinima, estoqueEmPedidos e estoqueFuturo estão na
unidadeDeMedida do produto, como em GET /v1/produtos (um shampoo de 500 ml com 3 frascos vem com 1500 e
"ml"). estoqueFuturo = quantidadeAtual + estoqueEmPedidos.

Nível de estoque: mínimo 0 ou não informado = 4 (Mínimo não informado); atual maior ou igual ao dobro do
mínimo = 1 (Adequado); atual maior ou igual ao mínimo = 2 (Perto do mínimo); abaixo do mínimo = 3 (Abaixo do
mínimo). No filtro nivelDeEstoqueId, 5 traz os níveis 2 e 3.

Custo médio: com o custo médio ponderado desligado (custoMedioPonderadoHabilitado false), é o valor
digitado ou importado no produto, e as compras não o alteram. Ligado, cada compra de fornecedor o recalcula:
(saldo anterior × custo + quantidade × preço) ÷ (saldo anterior + quantidade); com saldo anterior menor ou
igual a 0, vale o preço da compra.

Valor em estoque: quantidadeAtual × custo ÷ medidasPorUnidade. O custo é o custoMedio quando maior
que 0; senão, o precoUnitarioFinal da ultimaCompra. Estoque negativo vale 0. Sem custo e sem compra, null.

Última compra: a compra de fornecedor ativa mais recente; no empate de data, a de maior id. O preço vem
sempre por unidade do produto: a compra por fração é convertida. fornecedorNome é o nome fantasia, ou a
razão social quando ele está vazio.

Fornecedor: o filtro fornecedorId traz os produtos com pelo menos uma compra de fornecedor ativa desse
fornecedor. A ultimaCompra continua sendo a mais recente de qualquer fornecedor, então o
ultimaCompra.fornecedorId pode ser de outro fornecedor.

Datas: dataUltimaEntrada e dataUltimaSaida consideram só movimentações ativas.

Campos sem valor vêm como null quando o dado não existe (produto sem fabricante, categoria, custo, compra ou
movimentação).

Concorrência: divide com GET /v1/estoque/movimentacoes o limite de 2 chamadas simultâneas por conta. A
partir da terceira, a resposta é 429 com o cabeçalho Retry-After.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

(Opcional) Id do produto, de GET /v1/produtos

string

(Opcional) Trecho do nome do produto

int32

(Opcional) Id do fabricante

int32

(Opcional) Id da categoria

int32

(Opcional) 1 Adequado, 2 Perto do mínimo, 3 Abaixo do mínimo, 4 Mínimo não informado, 5 Perto ou abaixo do mínimo

boolean

(Opcional) true: só produtos com estoque atual maior que 0; false: só com estoque menor ou igual a 0

boolean

(Opcional) Inclui os produtos inativos (padrão false)

int32

(Opcional) Cursor: proximoId da resposta anterior

int32

(Opcional) Quantidade de registros por página (padrão e máximo 50)

int32

(Opcional) Fornecedor de alguma compra ativa do produto, o mesmo fornecedorId de GET /v1/estoque/movimentacoes

Headers
string
required
Responses

Errors

Retry-After

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json