A API de Dados da SW permite consultar informações das lojas para uso em ferramentas como Excel, Power BI e bancos de dados. Isso possibilita a criação de relatórios e dashboards personalizados para análises avançadas.
Neste artigo, explicaremos como acessar e utilizar os relatórios em Vendas, que permitem visualizar detalhes das vendas realizadas e canceladas no PDV, incluindo os respectivos produtos.
Esses relatórios são destinados a estabelecimentos que utilizam um Token individual por loja, sem acesso à visão de Loja Central utilizada em redes de franquias.
Como acessar e utilizar a API de Dados?
1. Acesse este link em seu navegador.
2. Para autenticação, no campo api_key, insira o Token da API Reporting Data da loja desejada e clique em Explore:
Caso não tenha o Token, solicite ao atendimento responsável pela loja na SW.
3. Em seguida, em Vendas, selecione a tabela desejada:
- vendas: Retorna as vendas realizadas no PDV, com produtos, pagamentos, descontos, acréscimos e dados fiscais.
- vendas/cancelamentos: Retorna as vendas canceladas no PDV, com os produtos cancelados.
4. Informe os parâmetros para a consulta e clique em Try it out!:
- dataInicio: Data inicial do filtro (date: yyyy-mm-dd).
- dataFim: Data final do filtro (date: yyyy-mm-dd).
O período não pode exceder 7 dias.
5. Após executar a consulta, a API retorna os dados solicitados. Abaixo, estão as informações exibidas e o que cada uma representa:
Curl: Comando utilizado para enviar requisições para a API.
Request URL: Endereço completo da requisição enviada, incluindo protocolo (http/https), domínio, caminho do recurso e parâmetros de consulta.
Response Body: Retorno da API com os dados solicitados no formato JSON.
-
Response Code: Status da requisição, que indica o resultado da execução:
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 da resposta da API. Fornecem informações extras, como tipo de conteúdo, tamanho dos dados e etc.
Dica: Para mais detalhes sobre o modelo de dados, consulte a documentação do Swagger.
O que significa cada campo em Response Body?
Após a requisição, a resposta é retornada no campo Response Body, em formato JSON, organizada em blocos de dados conforme a tabela consultada.
A seguir, confira a descrição dos campos retornados para cada tabela:
Retorna as informações das vendas realizadas no PDV, incluindo produtos, pagamentos, descontos, acréscimos e dados fiscais.
📌 Estrutura dos dados (Response Body)
1. Dados principais
Informações gerais da venda, incluindo loja, cliente, operação e valores consolidados.
| Campo | Observações | Descrição |
|---|---|---|
| redeLoja |
|
Nome da rede/franquia da loja. |
| loja |
|
Nome da loja cadastrado no sistema SW. |
| cidade |
|
Cidade onde está localizada a loja. |
| uf |
|
Sigla do estado da loja. |
| royaltyImpostoEstimado |
|
Percentual médio estimado do imposto a ser abatido dos royalties pagos à franquia. |
| crt | Regime Normal |
Código do Regime Tributário da loja. |
| codigoLoja_Rede |
|
Código de identificação da loja na rede/franquia. |
| codigoLoja |
|
Código de identificação da loja no sistema SW. |
| venda |
|
Identificador único da venda na loja. |
| id |
|
Código de identificação do registro da venda. |
| nrAbertura |
|
Número da abertura de caixa. |
| pdv |
|
Código do ponto de venda (PDV) utilizado. |
| pdvNome |
|
Nome do ponto de venda (PDV). |
| emissor | NFC-e |
Tipo de documento fiscal emitido. |
| emissor_Serie |
|
Código da série utilizada na emissão da nota fiscal. |
| emissor_Numero |
|
Número sequencial da nota fiscal emitida. |
| emissor_Chave |
|
Código único de identificação da nota fiscal. |
| emissor_Status | Autorizada |
Status atual da nota fiscal. |
| setor | Balcão |
Modo de operação em que ocorreu a venda. |
| aplicativo | Swfast |
Nome do sistema ou aplicativo em que a venda foi registrada. |
| tipoEntrega | Despachar |
Modo de entrega selecionado na venda. |
| tipoConsumo | Comer aqui |
Forma de consumo no local ou para viagem. |
| operador |
|
Nome do operador de caixa. |
| nrCupom |
|
Número de identificação do cupom fiscal. |
| nrMesa |
|
Número da mesa, se houver. |
| idPedidoExterno |
|
Código de identificação do pedido em aplicativos. |
qtdPessoas |
|
Quantidade de pessoas atendidas na venda. |
data |
|
Dia da venda. |
dataHoraTransacao |
|
Data e hora da venda. |
entregador |
|
Nome do entregador, se houver. |
idiomaAplicativo |
|
Idioma utilizado no aplicativo. |
cliente |
|
Nome do cliente. |
clienteFone |
|
Telefone do cliente. |
clienteDocumento |
|
Documento do cliente. |
qtdProdutos |
|
Quantidade de produtos. |
qtdPagamentos |
|
Quantidade de formas de pagamento utilizadas. |
qtdCombos |
|
Quantidade de combos aplicados na venda. |
valorProdutos |
|
Valor bruto total dos produtos na venda. |
valorRepiques |
|
Valor de repique aplicado, se houver. |
valorTaxaServicos |
|
Valor de taxa de serviço aplicada, se houver |
valorTaxaEntregas |
|
Valor da taxa de entrega aplicada, se houver. |
valorCreditos |
|
Valor de crédito (Assinadas) adicionado ao cliente. |
valorDescontos |
|
Valor de desconto do tipo Convênio aplicado. |
valorCombos |
|
Valor de desconto do tipo Combo aplicado. |
valorEspeciais |
|
Valor descontado da venda por itens especiais removidos. |
valorAssinadas |
|
Valor debitado (Assinadas) do cliente. |
valorCortesias |
|
Valor de produtos oferecidos como cortesia. |
valorFaturamento |
|
Soma dos produtos, repiques, taxas de serviço/entrega e créditos (assinadas). Desconsidera descontos, combos, especiais e cortesias. |
2. Produtos
Itens que compõem a venda.
| Campo | Observações | Descrição |
|---|---|---|
id |
|
Código de identificação do item vendido. |
nrItem |
|
Ordem do item no cupom. |
atendente |
|
Funcionário responsável pelo atendimento, se houver. |
codigoProduto |
|
Código do produto no sistema SW. |
codigoProduto_OrigemEtapa |
|
Código do produto original se estiver dentro de uma etapa. |
promocao |
|
Nome da promoção do produto, se houver. |
regraPreco |
|
Nome da regra de preço aplicada ao produto, se houver. |
produto |
|
Nome do produto no sistema SW. |
produto_OrigemEtapa |
|
Nome do produto original ou promoção, caso o item esteja vinculado a uma etapa, promoção ou seja um adicional de outro produto. |
grupo |
|
Grupo em que o produto faz parte. |
subGrupo |
|
Subgrupo em que o produto faz parte. |
unidadeMedida |
|
Unidade de medida do produto. |
fatorCompra |
|
Fator de compra do produto. |
unidadeMedidaCompra |
|
Unidade de medida de compra do produto. |
classificacaoRoyalty |
|
Classificação do produto usada no cálculo de royalty para a franquia. |
codigoClassificacaoRoyalty |
|
Código da classificação usada no cálculo de royalty para a franquia. |
qtdProdutos |
|
Quantidade de produtos. |
valorProduto |
|
Valor bruto total do produto na venda. |
3. Pagamentos
Formas de pagamento utilizadas na venda.
| Campo | Observações | Descrição |
|---|---|---|
id |
|
Código de identificação do pagamento. |
codigoFormaPagamento |
|
Código da forma de pagamento. |
formaPagamento |
|
Nome da forma de pagamento. |
valorPagamento |
|
Valor pago com a forma de pagamento. |
nsu |
|
Número Sequencial Único da transação (usado para conciliação de cartões). |
codigoAutorizacao |
|
Código de autorização da transação fornecido pela operadora. |
bandeira |
|
Bandeira utilizada no pagamento. |
modalidade |
DebitoAVista |
Modalidade do pagamento eletrônico. |
tef |
SIM |
Indica se a transação utilizou TEF. |
4. Descontos
Descontos aplicados na venda, como combos e convênios.
| Campo | Observações | Descrição |
|---|---|---|
id |
|
Código de identificação do desconto. |
operadorDesconto |
|
Operador responsável pelo desconto. |
tipoDesconto |
Combos |
Tipo de desconto aplicado na venda. |
desconto |
|
Nome do desconto aplicado. |
motivo |
|
Motivo do desconto quando o tipo for Convênio. |
codigoConvenio |
|
Código do convênio aplicado. |
codigoCombo |
|
Código do combo aplicado. |
valorDesconto |
|
Valor total dos descontos aplicados. |
qtdDescontos |
|
Número de descontos aplicados. |
5. Acréscimos
Taxas aplicadas à venda, como entrega, serviço ou repique.
| Campo | Observações | Descrição |
|---|---|---|
id |
|
Código de identificação do acréscimo. |
operadorTaxa |
|
Operador responsável pela taxa. |
tipoTaxa |
Entrega |
Tipo da taxa aplicada. |
valorTaxa |
|
Valor da taxa aplicada. |
6. Fiscais
Informações fiscais dos itens da venda.
| Campo | Observações | Descrição |
|---|---|---|
emissorNumero_Item |
|
Número do item na nota fiscal. |
produto |
|
Nome do produto no sistema SW. |
codigoProduto |
|
Código do produto no sistema SW. |
cest |
Código Especificador da Substituição Tributária. | |
ncm |
Código NCM do produto. | |
gtim |
Código GTN do produto, se houver. | |
cfop |
|
Código Fiscal de Operações e Prestações. |
valorVendaItem |
|
Valor total do item vendido. |
imposto |
COFINS |
Tipo de imposto aplicado. |
cst |
|
Código da Situação Tributária. |
csosn |
|
Código de Situação da Operação no Simples Nacional. |
baseCalculo |
|
Base de cálculo do imposto. |
aliquota |
|
Percentual da alíquota aplicada. |
valorImposto |
|
Valor do imposto calculado. |
📦 JSON retornado pela API
{
"RedeLoja": "string",
"Loja": "string",
"Cidade": "string",
"UF": "string",
"RoyaltyImpostoEstimado": 0,
"CRT": "string",
"CodigoLoja_Rede": "string",
"CodigoLoja": 0,
"Venda": "string",
"ID": "string",
"NrAbertura": 0,
"PDV": 0,
"PDVNome": "string",
"Emissor": "string",
"Emissor_Serie": "string",
"Emissor_Numero": 0,
"Emissor_Chave": "string",
"Emissor_Status": "string",
"Setor": "string",
"Aplicativo": "string",
"TipoEntrega": "string",
"TipoConsumo": "string",
"Operador": "string",
"NrCupom": 0,
"NrMesa": 0,
"IdPedidoExterno": "string",
"QtdPessoas": 0,
"Data": "2026-05-27T20:20:11.668Z",
"DataHoraTransacao": "2026-05-27T20:20:11.668Z",
"Entregador": "string",
"IdiomaAplicativo": "string",
"Cliente": "string",
"ClienteFone": "string",
"ClienteDocumento": "string",
"QtdProdutos": 0,
"QtdPagamentos": 0,
"QtdCombos": 0,
"ValorProdutos": 0,
"ValorRepiques": 0,
"ValorTaxaServicos": 0,
"ValorTaxaEntregas": 0,
"ValorCreditos": 0,
"ValorDescontos": 0,
"ValorCombos": 0,
"ValorEspeciais": 0,
"ValorAssinadas": 0,
"ValorCortesias": 0,
"ValorFaturamento": 0,
"Produtos": [
{
"ID": "string",
"NrItem": 0,
"Atendente": "string",
"CodigoProduto": 0,
"CodigoProduto_OrigemEtapa": 0,
"Promocao": "string",
"RegraPreco": "string",
"Produto": "string",
"Produto_OrigemEtapa": "string",
"Grupo": "string",
"SubGrupo": "string",
"UnidadeMedida": "string",
"FatorCompra": 0,
"UnidadeMedidaCompra": "string",
"ClassificacaoRoyalty": "string",
"CodigoClassificacaoRoyalty": "string",
"QtdProdutos": 0,
"ValorProduto": 0
}
],
"Pagamentos": [
{
"ID": "string",
"CodigoFormaPagamento": 0,
"FormaPagamento": "string",
"ValorPagamento": 0,
"NSU": "string",
"CodigoAutorizacao": "string",
"Bandeira": "string",
"Modalidade": "string",
"TEF": "string"
}
],
"Descontos": [
{
"ID": "string",
"OperadorDesconto": "string",
"TipoDesconto": "string",
"Desconto": "string",
"Motivo": "string",
"CodigoConvenio": 0,
"CodigoCombo": 0,
"ValorDesconto": 0,
"QtdDescontos": 0
}
],
"Acrescimos": [
{
"ID": "string",
"OperadorTaxa": "string",
"TipoTaxa": "string",
"ValorTaxa": 0
}
],
"Fiscais": [
{
"EmissorNumero_Item": 0,
"Produto": "string",
"CodigoProduto": "string",
"CEST": "string",
"NCM": "string",
"GTIM": "string",
"CFOP": "string",
"ValorVendaItem": 0,
"Imposto": "string",
"CST": "string",
"CSOSN": "string",
"BaseCalculo": 0,
"Aliquota": 0,
"ValorImposto": 0
}
]
}
Retorna as vendas canceladas no PDV, com informações da venda e dos itens cancelados.
📌 Estrutura dos dados (Response Body)
1. Dados principais
Informações da venda com dados do cancelamento.
| Campo | Observações |
Descrição |
|---|---|---|
| redeLoja |
|
Nome da rede/franquia da loja. |
| loja |
|
Nome da loja cadastrado no sistema SW. |
| cidade |
|
Cidade onde está localizada a loja. |
| uf |
|
Sigla do estado da loja. |
| royaltyImpostoEstimado |
|
Percentual médio estimado do imposto a ser abatido dos royalties pagos à franquia. |
| crt | Regime Normal |
Código do Regime Tributário da loja. |
| codigoLoja_Rede |
|
Código de identificação da loja na rede/franquia. |
| codigoLoja |
|
Código de identificação da loja no sistema SW. |
| venda |
|
Identificador único da venda na loja. |
| id |
|
Código de identificação do registro da venda. |
| nrAbertura |
|
Número da abertura de caixa. |
| pdv |
|
Código do ponto de venda (PDV) utilizado. |
| pdvNome |
|
Nome do ponto de venda (PDV). |
| emissor | NFC-e |
Tipo de documento fiscal emitido. |
| emissor_Serie |
|
Código da série utilizada na emissão da nota fiscal. |
| emissor_Numero |
|
Número sequencial da nota fiscal emitida. |
| emissor_Chave |
|
Código único de identificação da nota fiscal. |
| emissor_Status | Autorizada |
Status atual da nota fiscal. |
| setor | Balcão |
Modo de operação em que ocorreu a venda. |
| aplicativo | Swfast |
Nome do sistema ou aplicativo em que a venda foi registrada. |
| tipoEntrega | Despachar |
Modo de entrega selecionado na venda. |
| tipoConsumo | Comer aqui |
Forma de consumo no local ou para viagem. |
| operador |
|
Nome do operador de caixa. |
| nrCupom |
|
Número de identificação do cupom fiscal. |
| nrMesa |
|
Número da mesa, se houver. |
| idPedidoExterno |
|
Código de identificação do pedido em aplicativos. |
qtdPessoas |
|
Quantidade de pessoas atendidas na venda. |
data |
|
Dia da venda. |
dataHoraTransacao |
|
Data e hora da venda. |
entregador |
|
Nome do entregador, se houver. |
idiomaAplicativo |
|
Idioma utilizado no aplicativo. |
cliente |
|
Nome do cliente. |
clienteFone |
|
Telefone do cliente. |
clienteDocumento |
|
Documento do cliente. |
tipoCancelamento |
Total |
Tipo do cancelamento realizado. |
operadorCancelamento |
|
Operador responsável pelo cancelamento. |
dataHoraCancelamento |
|
Data e hora do cancelamento. |
motivoCancelamento |
|
Motivo informado no cancelamento. |
2. Produtos
Itens cancelados na venda.
| Campo | Observações |
Descrição |
|---|---|---|
id |
|
Código de identificação do registro na entidade. |
nrItem |
|
Ordem do item no cupom. |
atendente |
|
Funcionário responsável pelo atendimento, se houver. |
codigoProduto |
|
Código do produto no sistema SW. |
codigoProduto_OrigemEtapa |
|
Código do produto original se estiver dentro de uma etapa. |
promocao |
|
Nome da promoção do produto, se houver. |
regraPreco |
|
Nome da regra de preço aplicada ao produto, se houver. |
produto |
|
Nome do produto no sistema SW. |
produto_OrigemEtapa |
|
Nome do produto original ou promoção, caso o item esteja vinculado a uma etapa, promoção ou seja um adicional de outro produto. |
grupo |
|
Grupo em que o produto faz parte. |
subGrupo |
|
Subgrupo em que o produto faz parte. |
unidadeMedida |
|
Unidade de medida do produto. |
fatorCompra |
|
Fator de compra do produto. |
unidadeMedidaCompra |
|
Unidade de medida de compra do produto. |
classificacaoRoyalty |
|
Classificação do produto usada no cálculo de royalty para a franquia. |
codigoClassificacaoRoyalty |
|
Código da classificação usada no cálculo de royalty para a franquia. |
tipoCancelamento |
Total |
Tipo do cancelamento realizado. |
operadorCancelamento |
|
Operador responsável pelo cancelamento. |
dataHoraCancelamento |
|
Data e hora do cancelamento. |
motivoCancelamento |
|
Motivo informado no cancelamento. |
qtdProdutos |
|
Quantidade de produtos. |
valorProduto |
|
Valor bruto total do produto na venda. |
📦 JSON retornado pela API
{
"RedeLoja": "string",
"Loja": "string",
"Cidade": "string",
"UF": "string",
"RoyaltyImpostoEstimado": 0,
"CRT": "string",
"CodigoLoja_Rede": "string",
"CodigoLoja": 0,
"Venda": "string",
"ID": "string",
"NrAbertura": 0,
"PDV": 0,
"PDVNome": "string",
"Emissor": "string",
"Emissor_Serie": "string",
"Emissor_Numero": 0,
"Emissor_Chave": "string",
"Emissor_Status": "string",
"Setor": "string",
"Aplicativo": "string",
"TipoEntrega": "string",
"TipoConsumo": "string",
"Operador": "string",
"NrCupom": 0,
"NrMesa": 0,
"IdPedidoExterno": "string",
"QtdPessoas": 0,
"Data": "2026-05-28T14:56:02.574Z",
"DataHoraTransacao": "2026-05-28T14:56:02.574Z",
"Entregador": "string",
"IdiomaAplicativo": "string",
"Cliente": "string",
"ClienteFone": "string",
"ClienteDocumento": "string",
"TipoCancelamento": "string",
"OperadorCancelamento": "string",
"DataHoraCancelamento": "2026-05-28T14:56:02.575Z",
"MotivoCancelamento": "string",
"Produtos": [
{
"ID": "string",
"NrItem": 0,
"Atendente": "string",
"CodigoProduto": 0,
"CodigoProduto_OrigemEtapa": 0,
"Promocao": "string",
"RegraPreco": "string",
"Produto": "string",
"Produto_OrigemEtapa": "string",
"Grupo": "string",
"SubGrupo": "string",
"UnidadeMedida": "string",
"FatorCompra": 0,
"UnidadeMedidaCompra": "string",
"ClassificacaoRoyalty": "string",
"CodigoClassificacaoRoyalty": "string",
"TipoCancelamento": "string",
"OperadorCancelamento": "string",
"DataHoraCancelamento": "2026-05-28T14:56:02.575Z",
"MotivoCancelamento": "string",
"QtdProdutos": 0,
"ValorProduto": 0
}
]
}
Saiba mais sobre a descrição dos campos da API de Dados através deste artigo.
Ajude-nos a evoluir deixando seu feedback nos comentários e compartilhando sugestões para novos artigos!
Comentários
0 comentário
Por favor, entre para comentar.