Histórico da Página
API para consulta de Pedidos de Venda do Varejo
01. DADOS GERAIS
Linha de Produto: | Protheus |
---|---|
Segmento: | Varejo |
Módulo: | SIGALOJA |
Função: | RetailSalesOrdersObj - Classe para tratamento da API de Pedidos de Venda do Varejo RetailSalesOrdesApi - API para consulta de Pedidos de Venda do Varejo |
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:
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:
Origem | TAG | Descrição |
cEmpAnt | companyId | Código do grupo de empresas |
cEmpAnt '|' cFilAnt | companyInternalId | Chave única da Empresa |
C5_FILIAL | branchId | Filial do Pedido de Venda |
C5_NUM | order | Número do Pedido de Venda |
C5_FILIAL '|' C5_NUM | internalId | Chave única do Pedido de Venda |
C5_EMISSAO | registerDate | Emissão |
C5_CLIENTE | customerCode | Código do Cliente |
C5_LOJA | customerStore | Loja do Cliente |
C5_NOTA | invoiceNumber | Número da Nota Fiscal |
C5_SERIE | invoiceSeries | Série da Nota Fiscal |
C5_ORCRES | budgetNumber | Número do Orçamento |
C5_PEDECOM | ecommerceOrder | Número do Pedido e-Commerce |
C5_STATUS | ecommerceStatus | Status do Pedido no e-Commerce |
C5_RASTR | ecommerceTrackingCode | Código do Rastreio do Pedido e-Commerce |
C5_MOEDA | Currency | Moeda do Pedido de Venda |
C5_CONDPAG | PaymentTerm | Condição de Pagamento |
C5_VEND1 | sellerCode1 | Código do Vendedor 1 |
C5_COMIS1 | CommissionSeller1 | Comissão do Vendedor 1 |
C5_TRANSP | CarrierCode | Código da Transportadora |
C5_TPFRETE | TypeFreight | Tipo do Frete Utilizado |
C5_FRETE | FreightValue | Valor do Frete |
C5_SEGURO | InsuranceValue | Valor do Seguro |
C5_DESPESA | ExpenseValue | Valor Despesa Acessória |
C5_DESC1 | DiscountValue1 | Desconto 1 |
C5_ESPECI1 | ClassVolume1 | Espécie do Volume tipo 1 |
C5_VOLUME1 | VolumeAmount | Quantidade de Volumes tipo 1 |
C5_PESOL | NetWeight | Peso liquido |
C5_PBRUTO | GrossWght | Peso Bruto |
C5_MENNOTA | InvoiceMessage | Mensagem para Nota Fiscal |
C5_ORIGEM | Origin | Origem do Pedido |
C5_TIPLIB | ReleaseType | Tipo de Liberação |
C5_TPCARGA | Load | Carga |
C5_GERAWMS | generateWms | Gera O.S./WMS |
- 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:
Origem | TAG | Descrição | |||
cEmpAnt | companyId | Código do Grupo de Empresa | |||
cEmpAnt '|' cFilAnt | companyInternalId | Chave única da Empresa | |||
C6_FILIAL | branchId | Filial do Item do Pedido de Venda | |||
C6_NUM | order | Numero do Pedido | |||
C6_FILIAL '|' C6_NUM | internalId | Chave única do Pedido de Venda | |||
C6_ITEM | Item | Numero do Item no Pedido | |||
C6_PRODUTO | productCode | Codigo do Produto | |||
C6_DESCRI | description | Descricao Auxiliar | |||
C6_UM | measureUnit | Unidade de Medida Primaria | |||
C6_QTDVEN | quantity | Quantidade Vendida | |||
C6_PRCVEN | unitaryPrice | Preco Unitario Liquido | |||
C6_VALOR | TotalValue | Valor Total do Item | |||
C6_TES | OutflowType | Tipo de Saida do Item | |||
C6_CF | FiscalCode | Codigo Fiscal da Operacao | |||
C6_LOCAL | WarehouseInternalId | InternalID do local/armazém de estoque | |||
C6_CLI | customerCode | Codigo do Cliente | |||
C6_LOJA | customerStore | Loja do Cliente | |||
C6_PRUNIT | PriceList | Preco Unitario de Tabela | |||
C6_TPOP | TypeProductionOrder | Tipo da Ordem de Produção | |||
C6_LOTECTL | Lot | Lote | |||
C6_ENTREG | DeliveryDate | Data da Entrega | |||
C6_CLASFIS | TaxationStatus | Situacao Tributaria | |||
C6_VDMOST | PartType | Tipo Peça | C6_VDOBS | PartRemark | Observação da Peça |
C6_TURNO | Shift | Turno (Manhã,Tarde e Noite) | |||
C6_ITEMGAR | ExtendedWarranty | Item Garantia Estendida | |||
C6_ORCGAR | ExtendedWarrantyQuot | Orcamento Garantia Estendida | |||
C6_FCICOD | FCICode | Código FCI | |||
C6_VLIMPOR | ImportValue | Valor da Importação | |||
C9_QTDLIB | ApprovedAmount | Quantidade Liberada | |||
C9_BLEST | StockBlock | Bloqueio por estoque | |||
C9_BLCRED | CreditBlock | Bloqueio por credito | |||
C9_BLOQUEI | Block | Bloqueio | |||
C9_BLWMS | WMSBlock | Bloqueio WMS | |||
C9_BLTMS | TMSBlock | Bloqueio TMS | |||
C9_BLINF | BlockInformation | Informações sobre o bloqueio |
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 ?
Templatedocumentos |
---|
HTML |
---|
<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> |