CONTEÚDO


01. OBJETIVO

Obter informações de saldo de estoque agrupadas por estabelecimento de um item específico, como quantidade atual disponível e quantidade alocada.

02. API

Informações da API utilizada para busca dos dados e nome do cadastro de menu relacionado à API, caso o usuário queira restringir o acesso. Mais informações: Manutenção de Programa (MEN012AA)

MÉTODOGET
APIapi/cpp/v2/stockProduction
ROTA/stockSite/
MENU

stockProduction_cpp_v1

03. PERGUNTAS EXEMPLO (FEW-SHOTS)

Exemplos de perguntas que deverão ser respondidas por esse assunto.


Pergunta
1Qual a quantidade alocada do item <código>?
2Qual a quantidade disponível do item <código>?
3Qual o saldo estoque do item <código>?

04. PARÂMETROS

São os possíveis campos utilizados na busca dos dados pela API.

ParâmetroTipoDescriçãoObrigatório
itemCodestring

Item

sim
referenceCodestringReferência do Itemnão
showZeroBalancebooleanIndica se os saldos com quantidade zero devem ser considerados na consulta. Enviar o valor 'false' a não ser que o usuário solicite ver os saldos zerados.não

05. GLOSSÁRIO

O glossário é um conjunto de termos utilizados para definir a tradução das propriedades retornadas no JSON da API. Além disso, os campos apresentados são incluídos na cláusula FIELDS da query, ou seja, somente esses campos são retornados na resposta da API.

PropriedadeDescriçãoTipoFormato
allocatedQuantityQtde. Alocadadecimal->>>>,>>>,>>9.9999
availableQuantityQtde. Disponíveldecimal->>>>,>>>,>>9.9999
currentQuantityQtde. Atualdecimal->>>>,>>>,>>9.9999
itemCodeItemcharacter
orderAllocatedQuantityQtde. Alocada Pedidosdecimal->>>>,>>>,>>9.9999
productionAllocatedQuantityQtde. Alocada Produçãodecimal->>>>,>>>,>>9.9999
referenceCodeReferênciacharacter
siteCodeEstab.character

06. AÇÕES RELACIONADAS

São sugestões de novas perguntas ou ações que serão sugeridas ao usuário após a execução desse assunto.