Histórico da Página
API para consulta de Saldo em Estoque de Produto
01. DADOS GERAIS
Linha de Produto: | Protheus |
---|---|
Segmento: | Varejo |
Módulo: | SIGALOJA |
Função: | RetailIStockObj - Classe para tratamento da API de Saldo em Estoque de Produtos RetailStockApi - API para consulta de Saldo em Estoque de Produtos |
02. SITUAÇÃO/REQUISITO
Existia a necessidade de efetuar consultas de Saldo em Estoque de Produtos sem acessar o Protheus.
Onde fosse retornadas informações do produtos e estoque.
03. SOLUÇÃO
Foi disponibilizado o serviço em Rest para possibilitar as consultas de Saldo em Estoque aos Produtos.
Neste serviço serão disponibilizados os verbos:
- GET - /retailStock
Retorna uma lista com todos os Produtos e seus saldos de estoque;
Exemplo:
URL - http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?{Order, Fields, Page, PageSize}
- serverUrl = Endereço para acesso ao servidor Rest;
- serverRestPort = Porta para acesso ao servidor Rest;
- Order= Parâmetro para definir a ordenação do retorno.
Exemplo:
http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?ORDER=-code
Neste exemplo ira ordenar pela TAG "code" de forma decrescente.
- Fields = Parâmetro de define as TAGs que serão retornadas.
Exemplo:
http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?FIELDS=code,name,initialDate
Neste exemplo serão retornadas apenas as TAGS: code, name, initialDate.
- Page - Define qual pagina será retornada
Exemplo:
http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?PAGE=2
Neste exemplo será retornada a pagina 2.
- PageSize - Quantidade de registros retornados pela pagina.
Exemplo:
http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?PAGESIZE=3
Neste exemplo serão retornados 3 registros.
Observação
- Caso não seja passado o parâmetro Page, seu valor será 1.
- Caso não seja passado o parâmetro PageSize, seu valor será 10.
04. DEMAIS INFORMAÇÕES
Para maiores informações consulte https://api.totvs.com.br, pesquise por retailStockpor RetailStockLevel.
05. ASSUNTOS RELACIONADOS
Duvidas em APIs ?
Templatedocumentos |
---|
HTML |
---|
<style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style> |