Histórico da Página

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:

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

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=-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/retailSalesOrders?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/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

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

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>