Histórico da Página

Tempo aproximado para leitura: 00 min

API para consulta de Produtos do Varejo

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Existia a necessidade de efetuar consultas nas Tabelas de Preços nos Produtos sem acessar o Protheus.

Onde fosse retornados os cabeçalhos em uma consulta e os itens em outraretornadas informações do produtos.

03. SOLUÇÃO

Foi disponibilizado o serviço em Rest para possibilitar as consultas as Tabelas de Preçosaos Produtos.

Neste serviço serão disponibilizados os verbos:

• GET - /retailPriceListretailItem
  Retorna uma lista com o cabeçalho de todas as Tabelas de Preçotodos 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",
       

• GET- /retailPriceList/{internalId}/itensTablePrice
  Retorna todos os itens de uma única Tabela de Preço a partir do internalId (identificador único da Tabela de Preço);
  Exemplo:

{
    "hasNextIssTaxRate": false,
    "items": [
        {
0,
            "companyIdDescription": "stringBASE NOVA - PRODUTO 7% . ",
        "branchId": "string",
        "companyInternalIdUnitOfMeasureCode": "stringUN",
        "code": "string",
        "internalIdCostCenterCode": " string ",
        "itemList": "string",
        "itemCodeOrigin": "string0",
        "itemInternalId": "string",
        "minimumSalesPriceSalesPrice": 020,
        "discountValue": 0,
        "discountFactorGrossWeight": 0,
        "itemValidity": "20180719",
        "typePriceLastPurchasePrice": "1",
        "activeItemPrice": "1"
  0
        }
    ]
}

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

Neste exemplo será retornada a pagina 2.

• PageSize - Quantidade de registros retornados pela pagina.

Exemplo:

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

05. ASSUNTOS RELACIONADOS

Duvidas em APIs ? 

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