Relatórios — Como Usar
Como usar os Relatórios
Seção intitulada “Como usar os Relatórios”Guia prático de todas as ações disponíveis na página de Relatórios.
Fluxo típico
Seção intitulada “Fluxo típico”- Acessar Relatórios pelo menu lateral (
/reports). - (Opcional) Consultar o Dicionário para entender o significado das colunas.
- Clicar em Novo relatório → preencher tipo, formato, período, filiais e filtros → Gerar relatório.
- Aguardar (a lista atualiza sozinha enquanto o status for “Na fila” ou “Processando”).
- Quando o status mudar para Completo, abrir o menu ⋮ → Baixar relatório.
- Se precisar do mesmo relatório: ⋮ → Gerar relatório novamente (ajustar se necessário).
- Para remover: ⋮ → Excluir relatório → confirmar no modal.
Criar um novo relatório
Seção intitulada “Criar um novo relatório”Clique em Novo relatório no cabeçalho da página. O modal que abre tem os seguintes campos:
Campos do formulário
Seção intitulada “Campos do formulário”| Campo | Descrição |
|---|---|
| Tipo do relatório | Pedidos, Eventos, Envios, Integrações de Pedidos, Integrações de Transportadoras, Filiais ou CSAT |
| Formato | CSV ou JSON |
| Período | Data absoluta ou período dinâmico — máximo de 31 dias (disponível para Pedidos, Eventos, Envios e CSAT) |
| Filiais | Seletor de filiais — mínimo 1 obrigatória |
Após preencher, clique em Gerar relatório. Um toast confirma o envio e a lista é atualizada automaticamente.
Consultar o dicionário de colunas
Seção intitulada “Consultar o dicionário de colunas”No cabeçalho, clique no ícone de Dicionário (ℹ). Escolha o idioma (Português ou Inglês) e o modal exibirá a descrição de todas as colunas de cada tipo de relatório.
Isso é útil para entender exatamente o que cada campo significa no arquivo exportado.
Filtrar e buscar relatórios
Seção intitulada “Filtrar e buscar relatórios”Busca rápida
Seção intitulada “Busca rápida”Use o campo de busca (placeholder “Nome do relatório”) para filtrar a lista pelo nome.
Filtros avançados
Seção intitulada “Filtros avançados”Clique no botão de filtros para abrir o painel e selecione:
- Nome — texto livre
- Tipo do relatório — Pedidos, Eventos, Envios, etc.
- Formato — CSV, JSON
- Status — Na fila, Processando, Completo, Falha, Expirado
Controle de colunas
Seção intitulada “Controle de colunas”Ao lado dos filtros, há o botão de visibilidade de colunas: permite mostrar ou ocultar colunas da tabela conforme sua necessidade.
Ações na linha do relatório (menu ⋮)
Seção intitulada “Ações na linha do relatório (menu ⋮)”Cada relatório na tabela possui um menu de ações à direita:
Baixar relatório
Seção intitulada “Baixar relatório”| Situação | Comportamento |
|---|---|
| Status Na fila ou Processando | Ícone de loading — aguarde a conclusão |
| Status Completo | Solicita a URL de download e abre o arquivo em nova aba |
| Status Falha ou Expirado | O download não estará disponível — gere novamente |
Um toast de carregamento/sucesso/erro aparece durante o processo.
Gerar relatório novamente
Seção intitulada “Gerar relatório novamente”Abre o mesmo modal de criação, já preenchido com o tipo, formato, filiais e período daquele relatório. Você pode ajustar os campos e clicar em Gerar relatório para criar um novo.
Excluir relatório
Seção intitulada “Excluir relatório”Abre o modal de confirmação:
“Tem certeza que deseja excluir o relatório “Nome do relatório”?”
- Excluir: remove o relatório da lista (soft delete) e atualiza a tabela.
- Cancelar: fecha o modal sem ação.