API de Auditorias com Dados Sumarizados por Período
- Data de publicação: 22 de Outubro de 2026
- Versão necessária: plugin de Auditorias 11.261.2171
Objetivo
Disponibilizar uma API para consultar os resultados de auditorias de presença e de etiqueta já consolidados por período. Assim, o integrador obtém os mesmos indicadores exibidos na tela de Auditorias, sem precisar somar item a item.
Endpoints
| Método | Caminho | Visão |
|---|---|---|
GET |
/{tenant}/api/rest/audit/v1/period/presence/products |
Situação produto a produto da auditoria de presença no período |
GET |
/{tenant}/api/rest/audit/v1/period/presence/summary |
Sumário por loja da auditoria de presença no período |
GET |
/{tenant}/api/rest/audit/v1/period/tag/products |
Situação produto a produto da auditoria de etiqueta no período |
GET |
/{tenant}/api/rest/audit/v1/period/tag/summary |
Sumário por loja da auditoria de etiqueta no período |
Parâmetros
begin(obrigatório): início do período, no formatoyyyy-MM-dd HH:mm:ssouyyyy-MM-dd.end(obrigatório): fim do período, no mesmo formato.storeFilter: filtra uma ou mais lojas.categoryFilter: filtra por classe de produto.Page/PageSize: paginação dos resultados.
O intervalo entre begin e end não pode exceder 1 mês calendário.
Exemplo de requisição:
CODE
GET /{tenant}/api/rest/audit/v1/period/presence/summary?begin=2026-09-01&end=2026-09-30Respostas:
200: sucesso, com a lista de resultados.400: parâmetros inválidos ou ausentes, ou período superior a 1 mês. Exemplo:"Período inválido".500: erro interno ao montar o retorno.
Benefícios
- Dados prontos para análise: indicadores consolidados por período, prontos para relatórios e BI;
- Consistência com a tela: os valores seguem os mesmos indicadores exibidos em Auditorias de Presença e de Etiqueta;
- Integração simplificada: a consulta por período e por loja reduz o volume de chamadas e o processamento no sistema integrado.
Para detalhes dos campos e exemplos de resposta, consulte a documentação das APIs.