Linha Microsiga Protheus

Árvore de páginas

Tempo aproximado para leitura: 00 min

API para consulta de Produtos do Varejo


01. DADOS GERAIS

Linha de Produto:Protheus
Segmento:Varejo
Módulo:SIGALOJA
Função:

RetailItemObj - Classe para tratamento da API de Produtos do Varejo

RetailItemApi - API para consulta de Produtos do Varejo

02. SITUAÇÃO/REQUISITO

Necessidade de efetuar a consulta de Cadastro de Produtos sem acessar o Protheus  gerando o retorno das informações do produtos.

03. SOLUÇÃO

Foi disponibilizado o serviço em Rest para possibilitar as consultas aos Produtos.

Neste serviço serão disponibilizados os verbos:

  • GET - /retailItem
    Retorna uma lista com todos os Produtos;

Exemplo:

{
    "hasNext": true,
    "items": [
        {
            "ManufacturerCode": " ",
            "Active": "S",
            "GroupCode": "0007",
            "AddressingControl": "N",
            "Code": "LJTESTE00000001",
            "BranchId": "D ",
            "MercosulNomenclature": "33030010 ",
            "IcmsTaxRate": 7,
            "AccountItem": " ",
            "MinimumLot": 0,
            "SecondUnitOfMeasureCode": " ",
            "NetWeight": 0,
            "StandardCost": 0,
            "EconomicLot": 0,
            "CompanyId": "T1",
            "FamilyCode": " ",
            "IpiTaxRate": 0,
            "ProductType": "PA",
            "Trail": "N",
            "StandardWarehouseCode": "01",
            "MultiplicationFactorValue": 0,
            "InternalId": "D |LJTESTE00000001",
            "IssTaxRate": 0,
            "Description": "BASE NOVA - PRODUTO 7% . ",
            "UnitOfMeasureCode": "UN",
            "CostCenterCode": " ",
            "Origin": "0",
            "SalesPrice": 20,
            "GrossWeight": 0,
            "LastPurchasePrice": 0
        }
    ]
}


URL - http://{serverUrl}:{serverRestPort}/api/retail/v1/retailItem?{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/retailItem?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/retailItem?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/retailItem?PAGE=2

Neste exemplo será retornada a pagina 2.

  • PageSize - Quantidade de registros retornados pela pagina.

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailItem?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 retailItem.

05. ASSUNTOS RELACIONADOS

Duvidas em APIs ? 

http://tdn.totvs.com/x/gcoEGw