Pular para o conteúdo principal

Contexto dos relatórios de remessas

Os relatórios de remessas da Magalog permitem aos clientes e aos seus integradores consultar, a partir dos seus próprios sistemas, o que foi embarcado em um período e como essas remessas estão evoluindo.

Quem consulta os relatórios​

  • Cliente embarcador: acompanha o volume de remessas e a distribuição por status da sua operação.
  • ERP ou Hub: centraliza as informações de logística e pode alimentar painéis, relatórios e atendimento.
  • Magalog: disponibiliza a lista de remessas e os totais agregados por status.

Por que integrar os relatórios de remessas​

Sem uma integração, o cliente precisa baixar planilhas ou consultar sistemas separados para saber quantas remessas foram embarcadas e em qual etapa estão. Com os relatórios, o ERP ou Hub pode incorporar essa visão ao fluxo operacional já utilizado.

No momento, a consulta permite:

  • listar as remessas do embarcador em um intervalo de datas;
  • consultar a contagem de remessas por status em um período;
Autenticação

Para chamar os endpoints, é necessário gerar um token OAuth seguindo os primeiros passos na Plataforma Magalu.

Esta página apresenta o contexto de negócio. Os detalhes de escopos, filtros, erros e contrato ficam na página técnica de relatórios de remessas.

Quando usar cada rota​

A capacidade é composta por duas rotas complementares:

  • Listar remessas (GET /logistic/shipments-reports/v1/shipments): quando você precisa ver o detalhe de cada remessa — identificadores, cliente destinatário, serviço, eventos e janelas de entrega — dentro de um período.
  • Consultar resumo de status (GET /logistic/shipments-reports/v1/shipments/status-summaries): quando você precisa de uma visão agregada, com as contagens por status na janela móvel configurada e o total do período.

A escolha depende da pergunta: "quais remessas?" pede a lista; "quantas em cada etapa?" pede o resumo.

Tópicos relacionados​