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 agregados, que disponibilizam:

• Dados consolidados das vendas, incluindo movimentações, produtos e formas de pagamento.

• Informações de fechamento de caixa, como pagamentos, trocos e cancelamentos.

Os relatórios Vendas Agregadas e Conciliações Agregadas são destinadas a operações com acesso à visão de Loja Central, utilizada em redes de franquias.

Como acessar e utilizar a 5ª versão da 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 central e clique em Explore:

Caso não tenha o Token, solicite ao atendimento responsável pela loja na SW.

3. Em seguida, defina os dados que serão consultados:

Vendas Agregadas

1. Em Vendas Agregadas, está disponível a tabela relatorio-vendas-periodo-sincronizado, que retorna um relatório consolidado das vendas, incluindo movimentações, produtos e pagamentos:

Exclusivo para lojas configuradas como central.

 

2. Clique no bloco Data Type para copiar os parâmetros de Example Value para o campo request:

 

3. Depois, ajuste os parâmetros para consulta e clique em Try it out!:

• 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).

Mantenha o formato original dos campos e não utilize acentos ou caracteres especiais.

 

Conciliações Agregadas

1. Em Conciliações Agregadas, está disponível a tabela relatorio-conciliacoes-periodo, que retorna dados de fechamento de caixa, incluindo pagamentos, trocos e cancelamentos:

Exclusivo para lojas configuradas como central.

 

2. Clique no bloco Data Type para copiar os parâmetros de Example Value para o campo request:

 

3. Despois, ajuste os parâmetros para consulta e clique em Try it out!:

• 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).
• TipoConciliado: Filtra os caixas por conciliação (string: S, N ou T).
  • S: Apenas caixas conciliados.
  • N: Apenas caixas não conciliados.
  • T: Todos os caixas (conciliados e não conciliados).
• 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).

Mantenha o formato original dos campos e não utilize acentos ou caracteres especiais.

 

4. 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.

Para melhor desempenho, consulte uma loja por vez e use períodos de um dia. Ao salvar os dados, use sempre a data do dia anterior (D-1) para evitar perdas.

Ajude-nos a evoluir deixando seu feedback nos comentários e compartilhando sugestões para novos artigos!