Este serviço exibe informações sobre estoque.
Parâmetros
product | Busca por parte da descrição do produto. |
stock | Estoque mínimo que deve ser exibido na consulta |
minimal | Estoque mínimo ou ponto de pedido que deve ser exibido na consulta. |
fullinfo | Determina se todos os dados são retornados. Se for falso, retorna apenas productid e stock (padrão true) |
page | Determina a página que deve ser retornada. Pode ser utilizada com o parâmetro max. |
max | Número de registros máximos a ser apresentados. |
order | Campo para ordenação dos registros. Aceita campos e ordem decrescente (DESC) |
Campos do retorno
total | Quantidade de registros do retorno |
hasNext | Indica se há mais registros na próxima página |
syncing | Indica se no momento da requisição o sistema estava recebendo alguma nova informação |
lines | Contém as informações dos registros |
productId | ID do produto |
product | Descrição do produto. |
stock | Quantidade em estoque disponível |
storage | Armazém |
status | Determina se a situação do produto em relação ao estoque mínimo (Em dia, abaixo do mínimo ou zerado) |
minimal | Estoque mínimo ou ponto de pedido |
Formato para obtenção de informações específicas de produtos
localhost/Stock/CodigoProduto/Armazém |
---|
Exemplos:
Caso seja necessário retornar apenas um produto específico em estoque
{ "total": 15, "hasNext": true, "lines": [ { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "10", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2222299" }, { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "24", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2222299" }, { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "01", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2222394" }, { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "01", "status": "Abaixo do mínimo", "stock": 2, "lot": "UF2241097" } ] } |
É possível realizar o filtro também pelo armazém, se o produto estiver em mais de um.
localhost/Stock/009500/24 |
---|
{ "total": 3, "hasNext": true, "lines": [ { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "24", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2222299" }, { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "24", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2241097" }, { "productid": "009500", "product": "BOBINA CREME", "minimal": 100, "storage": "24", "status": "Abaixo do mínimo", "stock": 1, "lot": "UF2241138" } ] } |
Exemplos de consultas e retornos com parâmetros
Exemplo 1: Retornando o estoque de cada produto
localhost/Stock?fullinfo=FALSE |
---|
{ "total": 174, "hasNext": true, "lines": [ { "productid": "00011", "stock": 750 }, { "productid": "00012", "stock": 8 }, { "productid": "00013", "stock": 6 } ] } |
Exemplo 2: Retornando o estoque em ordem decrescente
localhost/Stock?order=stock desc |
---|
{ "total": 174, "hasNext": true, "lines": [ { "productid": "04556", "product": "SC PL PP 15.5X23X05 QUIN GUARD C 500", "minimal": 0, "storage": "03", "status": "Em dia", "stock": 152531 }, { "productid": "04501", "product": "SC PL BD 24X33.5X05 PAP HIG VIP BCO 1X1", "minimal": 0, "storage": "03", "status": "Em dia", "stock": 108579 } ] } |
Exemplo 3: Retornando o estoque com produtos que contenham parte da descrição a palavra "ESP GUARD", tenha um estoque mínimo de 700 e seja ordenado por produto
localhost/Stock?product=ESP GUARD&order=product&stock=700 |
---|
{ "total": 2, "hasNext": true, "lines": [ { "productid": "00011", "product": "ESP GUARD PAPEL SEDA TV 14X14CM 1X3200", "minimal": 0, "storage": "01", "status": "Em dia", "stock": 750 }, { "productid": "04474", "product": "SC PL PP 13X20,5X05 ESP GUARD C 160 1X1", "minimal": 0, "storage": "03", "status": "Em dia", "stock": 90739 } ] } |
Exemplo 4: Retornando a página 20 com 3 registros por página
localhost/stock?max=3&page=20 |
---|
{ "total": 174, "hasNext": true, "lines": [ { "productid": "04555", "product": "PRI P TOALHA INTERFOLHA LUX VIR 20X21CM 1X1250", "minimal": 0, "storage": "01", "status": "Zerado", "stock": 0 }, { "productid": "00036", "product": "BOBINA JUMBO CREME 30/32 69 1X1", "minimal": 0, "storage": "02", "status": "Em dia", "stock": 6269.03908 }, { "productid": "00040", "product": "BOBINA JUMBO BCA 2 30/32 69 PLAT 1X1", "minimal": 0, "storage": "02", "status": "Em dia", "stock": 44.00181 } ] } |