DVARLOJ1-3845 DT - API RetailStockLevel - Consulta de Saldo em Estoque

Tempo aproximado para leitura: 00 min

API para consulta de Saldo em Estoque de Produto

01. DADOS GERAIS

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:

{
   "hasNext": true,
   "items": [
   {
      "warehouseinternalid": "01",
      "futurestockamount": 0,
      "valueofcurrentstockamount": 10,
      "companyId": "T3",
      "iteminternalId": "000000123456789",
      "branchId": "D MG 01 ",
      "bookedstockamount": 0,
      "currentstockamount": 10
     }
   ]
}

Origem da informação:

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=-iteminternalId

Neste exemplo ira ordenar pela TAG "iteminternalId" de forma decrescente.

• Fields = Parâmetro de define as TAGs que serão retornadas.

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStock?FIELDS=iteminternalId,warehouseinternalid,valueofcurrentstockamount

Neste exemplo serão retornadas apenas as TAGS: iteminternalId, warehouseinternalid, valueofcurrentstockamount.

• 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

Caso queira realizar filtros o mesmo deve ser informado na URL

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailStockLevel?{Campo}=XXXXX

05. ASSUNTOS RELACIONADOS

        Para maiores informações consulte https://api.totvs.com.br, pesquise por RetailStockLevel.

Duvidas em APIs ?