DVARLOJ1-3856 DT - API RetailSalesOrders - Consulta Pedidos de Venda

Tempo aproximado para leitura: 00 min

API para consulta de Pedidos de Venda do Varejo

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Existia a necessidade de efetuar consultas de Pedidos de Venda sem acessar o Protheus.

Onde fosse retornadas informações do cabeçalho do Pedido de Venda e seus Itens.

03. SOLUÇÃO

Foi disponibilizado o serviço em Rest para possibilitar as consultas aos Pedidos de Vendas.

Onde serão disponibilizados dados das tabelas SC5, SC6 e SC9.

Neste serviço serão disponibilizados os verbos:

• GET - /retailSalesOrders?{Order, Fields, Page, PageSize}
  Retorna uma lista com o cabeçalho de todos os Pedidos de Venda

Exemplo:

{

    "hasNext": false,

    "items": [

        {

            "ecommerceOrder": "16477",

            "freightValue": 0,

            "commissionSeller1": 0,

            "classVolume1": " ",

            "customerStore": "01",

            "volumeAmount": 0,

            "insuranceValue": 0,

            "invoiceNumber": "000038",

            "currency": 1,

            "typeFreight": "S",

            "order": "000888",

            "registerDate": "20190619",

            "customerCode": "875957",

            "discountValue1": 0,

            "invoiceMessage": "   ",

            "budgetNumber": "001766",

            "ecommerceTrackingCode": "  ",

            "generateWms": "1",

            "netWeight": 0,

            "internalId": "D MG 01 |000888",

            "paymentTerm": "001",

            "carrierCode": "01",

            "branchId": "D MG 01 ",

            "companyInternalId": "T3|D MG 001",

            "load": "2",

            "companyId": "T3",

            "invoiceSeries": "767",

            "origin": " ",

            "sellerCode1": "000001",

            "grossWeight": 0,

            "expenseValue": 0,

            "releaseType": "1",

            "ecommerceStatus": "91"

        }

    ]

}

Origem da informação:

• GET - /retailSalesOrders/{internalId}/items?{Order, Fields, Page, PageSize}
  Retorna todos os itens de um único Pedido de Venda a partir do internalId (identificador único do Pedido de Venda)
  

Exemplo:

{

    "hasNext": false,

    "items": [

        {

            "taxationStatus": "090",

            "quantity": 1,

            "productCode": "PRD-IPI1",

            "extendedWarranty": "  ",

            "fiscalCode": "5102 ",

            "warehouseInternalId": "01",

            "customerStore": "01",

            "partType": " ",

            "item": "01",

            "lot": " ",

            "measureUnit": "UN",

            "block": "  ",

            "stockBlock": "10",

            "wmsBlock": "  ",

            "order": "000888",

            "customerCode": "875957",

            "tmsBlock": "  ",

            "unitaryPrice": 52.381,

            "approvedAmount": 1,

            "internalId": "D MG 01 |000888",

            "priceList": 52.381,

            "shift": "\"",

            "typeProductionOrder": "F",

            "branchId": "D MG 01 ",

            "deliveryDate": "   ",

            "companyInternalId": "T3|D MG 001",

            "totalValue": 52.38,

            "fciCode": "   ",

            "companyId": "T3",

            "importValue": 0,

            "outflowType": "506",

            "description": "PRODUTO IPI 1",

            "creditBlock": "10",

            "blockInformation": "  ",

            "extendedWarrantyQuot": "  "

        }

    ]

}

Origem da informação:

URL - http://{serverUrl}:{serverRestPort}/api/retail/v1/retailSalesOrders?{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/retailSalesOrders?ORDER=-InternalId

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

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

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailSalesOrders?FIELDS=InternalId,order,customerCode

Neste exemplo serão retornadas apenas as TAGS: InternalId, order, customerCode

• Page - Define qual pagina será retornada

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailSalesOrders?PAGE=2

Neste exemplo será retornada a pagina 2.

• PageSize - Quantidade de registros retornados pela pagina.

Exemplo:

http://{serverUrl}:{serverRestPort}/api/retail/v1/retailSalesOrders?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/retailSalesOrders?{Campo}=XXXXX

05. ASSUNTOS RELACIONADOS

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

Duvidas em APIs ?