Relatórios de Remessas
Acompanhe, em um só lugar, o que a sua operação embarcou na Magalog: a lista de remessas de um período e o resumo de quantas estão em cada etapa da entrega.
Para que serve
Os relatórios de remessas reúnem, em rotas de consulta, as informações que a sua operação precisa para acompanhar o que foi embarcado:
- quem recebeu o quê, em qual período;
- em qual etapa cada remessa está;
- como a operação está distribuída entre os status, de forma agregada.
Consulta de remessas
GET /logistic/shipments-reports/v1/shipments
Retorna as remessas do embarcador de forma paginada, filtrando por intervalo de
created_at.
| Parâmetro | O que é | Exemplo |
|---|---|---|
created_at_gte | Data inicial inclusiva do período (ISO-8601), obrigatória | 2026-03-01 |
created_at_lte | Data final inclusiva do período (ISO-8601), obrigatória | 2026-03-30 |
_limit | Quantidade máxima de registros por página (1 a 200) | 10 |
_offset | Offset para paginação | 0 |
Cada remessa da resposta traz os identificadores, o cliente destinatário, o serviço utilizado, os eventos registrados e a janela de entrega esperada e, se houver, a replanejada.
Referência completa — Listar remessas
Resumo de status das remessas
GET /logistic/shipments-reports/v1/shipments/status-summaries
Retorna contagens agregadas por status das remessas na janela móvel configurada, juntamente com o total geral do período. Com ele, é possível responder, por exemplo, quantas remessas estão em trânsito ou aguardando coleta, sem precisar percorrer a lista completa.
Referência completa — Consultar resumo de status
Escopos necessários
Para a utilização das APIs, os seguintes escopos poderão ser necessários:
| Valor | Descrição |
|---|---|
open:logistic-shipment-report-shipper:read | Permite a leitura das remessas e do resumo de status. |