1. Em Vendas Agregadas, retorna um relatório consolidado das vendas, incluindo movimentos, produtos e pagamentos.

 

2. Clique no bloco Data Type para copiar os parâmetros do Example Value para o campo request. Despois, modifique os parâmetros conforme necessário e clique em Try it out!:

• Parâmetros:
  • DataInicial: Data inicial do filtro (date: yyyy-mm-dd).
  • DataFinal: Data final do filtro (date: yyyy-mm-dd).
  • ListaDeLojas: Lista com as lojas que irão retornar juntas na consulta. Utilizar o ID das lojas SW separados por vírgula (string: 1, 2, 3).
  • UsarLojaIdExterno: Opcional. Utilize true apenas se os IDs informados em ListaDeLojas forem os IDs externos da loja, e não os IDs SW (boolean: true ou false).

É importante manter o formato dos campos e não utilizar acentos ou caracteres especiais.

 

3. A Api devolve um objeto massivo com diversos dados. Com as informações abaixo você pode utilizar os dados coletados no software ou banco desejado:

• • Curl: Informações de comando utilizadas como parâmetros para enviar solicitações a uma API.
  • Request URL: Endereço completo da API que está sendo acessada. Inclui o protocolo (http/https), domínio, caminho do recurso e parâmetros de consulta.
  • Response Body: Corpo da resposta que a API retorna. Contém os dados ou informações solicitadas em formato JSON.
  • Response Code: Código de status retornado pela API, que mostra se a requisição foi bem-sucedida ou não. Retornos:
    • 200: Consulta realizada com sucesso.
    • 400: Erro na requisição, os detalhes estarão no campo Response Body.
    • 401: Api_key não encontrada.
  • Response Headers: Cabeçalhos adicionais na resposta da API. Fornecem informações extras como tipo de conteúdo, tamanho dos dados e etc.

Dica: Para mais detalhes do modelo de dados consulte a documentação do Swagger.

 

4. Abaixo estão os detalhes, destacados em tom cereja, sobre os dados retornados no campo Response Body:

{
"totalCupons": 677, Total de cupons
"totalItens": 1539, Total de itens
"vendas": [ Lista de vendas
{
"cnpj": "14732712000100", CNPJ da loja
"codLoja": 7674, ID SW da loja
"codLojaExterno": "7674", ID Externo da loja
"dataVenda": "2025-03-28T00:00:00", Data da venda
"controle": 2503219791405255, Numero de controle (Único) da venda
"cupomVenda": 1, Numero do cupom (Reseta diariamente)
"valTroco": 0.00, Valor do Troco
"valDesconto": 0.00, Valor do Desconto
"valAcrescimo": 0.00, Valo de Acréscimos (Taxas de entrega, serviços...)
"valProduto": 88.00, Valor total de produtos
"valorTotal": 88.00, Valor total do cupom
"valorPago": 88.00, Valor pago
"valorGorjeta": 0.00, Valor de Gorjeta (Serviços, Repique...)
"valLiquido": 88.00, Valor líquido do cupom
"cancelada": true, Situação da venda
"..."
"delivery": { Dados relacionados a entrega
"numPedido": "1", Número do pedido na entrega
"valTaxaEntrega": 13.99, Valor da taxa de entrega
"..."
},
"documento": { Dados relacionados ao documento fiscal
"modelo": "65", Modelo da nota (65-NFCe, 59-CFeSAT)]
"numero": 307602, Número da NF
        "serie": "1", Série da NF
        "chave": "35250309011996000105650010003076021013076029", Chave da NF
        "..."
},
      "itens": [
        {
          "controle": 25032197914051088, Número de controle (Único) do item
          "numLancto": 1, Ordem de lançamento do item
          "codProduto": 3692, Código do Produto
          "descricaoProduto": "AC ARROZ BRANCO", Nome do produto
          "descricaoSubgrupo": "DELIVERY ADICIONAIS", Nome do subgrupo
          "unidadeProduto": "UN", Unidade de Venda
          "quantidade": 1.000, Quantidade vendida
          "valUnitario": 0.00, Valor unitário do item
          "valTotal": 0.00, Valor total do item (Qtd x Val)
          "datHoraLancamento": "2025-03-21T13:51:29", Data/Hora Lançamento
          "situacaoTributaria": "T", Tributo do ICMS
          "aliquota": "4.00", Alíquota de ICMS
          "descricaoCombo": "FILE DE FRANGO E LINGUICA TOSCANA" Nome do combo relacionado ao item vendido, etapa ou adicional.
"..."
        }
      ],
      "formaPagamento": [ Lista de pagamentos
        {
          "controle": 2503219791405370, Número de controle (Único) do pagamento
          "codFormaPagamento": "10", Código da forma de pagamento
          "valor": 52.89, Valor do pagamento
          "bandeira": "Visa", Bandeira do cartão
          "formaPgto": "VISA DEBITO", Descrição da forma de pagamento
          "tef": true, Define se o pagamento foi realizado por TEF
          "nsu": "3555862233654" Número NSU da transação
        }
      ],
      "cancelamento": { Dados relacionados ao cancelamento da venda
        "justificativa": "TESTE ABERTURA", Motivo de cancelamento
        "nomUsuario": "JOAO" Operador que realizou o cancelamento
"..."
      }}]}

 

1. Em Conciliações Agregadas exibe dados sobre fechamento de caixa, incluindo pagamentos, trocos e cancelamentos.

 

2. Clique no bloco Data Type para copiar os parâmetros do Example Value para o campo request!. Despois, modifique os parâmetros conforme necessário e clique em Try it out!:

 

1. Em Vendas, há tabelas sobre movimentações, pagamentos, produtos vendidos e descontos aplicados no PDV.

 

2. Selecione a tabela correspondente:

 

3. Em seguida, informe os parâmetros abaixo para a consulta e clique em Try it out!:

• • Sync: Informe o código Sincronizador de maior valor das consultas anteriores. Caso seja a primeira consulta, preencha com 0. Isso garante que o sistema retorne apenas os dados modificados após a última sincronização, reduzindo a quantidade de dados transferidos a cada consulta. Saiba mais no passo 3.1.
    Cada movimento, itens ou pagamento tem seu próprio número de sincronizador específico. 
  • Limite: Informe a quantidade limite de linhas que serão retornadas. O limite máximo é de 999 registros por vez. 

 

3.1. Para saber o código Sync desta consulta, no campo Response Body, localize o maior valor do parâmetro Sincronizador. Geralmente, esse valor corresponde ao código do último registro retornado:

Neste exemplo, o parâmetro Sincronizador de valor mais alto foi 10067603. Dessa forma, na próxima consulta, o valor utilizado como parâmetro Sync será 10067603.

 

4. Com as informações abaixo você pode utilizar os dados coletados no software ou banco desejado:

• • Curl: Informações de comando utilizadas como parâmetros para enviar solicitações a uma API.
  • Request URL: Endereço completo da API que está sendo acessada. Inclui o protocolo (http/https), domínio, caminho do recurso e parâmetros de consulta.
  • Response Body: Corpo da resposta que a API retorna. Contém os dados ou informações solicitadas em formato JSON.
  • Response Code: Código de status retornado pela API, que mostra se a requisição foi bem-sucedida ou não. Retornos:
    • 200: Consulta realizada com sucesso.
    • 400: Erro na requisição, os detalhes estarão no campo Response Body.
    • 401: Api_key não encontrada.
  • Response Headers: Cabeçalhos adicionais na resposta da API. Fornecem informações extras como tipo de conteúdo, tamanho dos dados e etc.

Dica: Para mais detalhes do modelo de dados consulte a documentação do Swagger.