VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Monitoramento de entregas

Acompanhe entregas em risco, remessas com problema e os relatórios de prazo, margem e cobertura de contingência de frete.

Depois que o pedido sai, a pergunta muda de "quanto cobro?" para "vai chegar no prazo?". Esta seção reúne as ferramentas de acompanhamento: o radar de entregas, que avisa os pedidos que provavelmente vão atrasar e permite compensar o cliente; a fila de exceções, com as remessas que a transportadora parou de movimentar ou reportou com problema; e três relatórios que comparam o prometido com o realizado.

São rotas de leitura e de ação da equipe de operação: ninguém aqui altera o preço do frete (isso fica em Métodos de envio).

Pontos-chave
  • Ler exige view_shipping ou manage_shipping; as ações (avisar, dispensar, resolver) exigem manage_shipping.
  • O radar é alimentado sozinho: uma varredura a cada hora compara a data prometida de cada pedido em andamento com o que aconteceu. Você não cria alertas.
  • Um alerta tem risk_state at_risk (em risco) ou late (atrasado).
  • Avisar o cliente pode gerar um voucher de compensação único; reenviar o aviso nunca gera um segundo voucher.
  • Os relatórios de SLA e de margem usam dados de pedidos e remessas reais da loja; sem pedidos, voltam vazios.
  • Os valores em dinheiro dos relatórios são inteiros em centavos.

Como funciona

Pedido prometido→Radar detecta risco→Alerta aberto→Cliente avisado ou alerta dispensado
status do alertaSignificado
openDetectado, ninguém agiu. Aparece no radar.
notifiedO cliente foi avisado (com ou sem voucher). Continua no radar.
dismissedDispensado pela equipe. Sai do radar.

Conceitos-chave

Em risco e atrasado

at_risk quer dizer que o pedido ainda pode chegar no prazo mas há sinal contrário (por exemplo, cause: "sem movimentação"). late quer dizer que a data prometida já passou. O texto de cause explica o motivo, em português.

Exceção de remessa

Uma remessa entra na fila de exceções quando o rastreamento a marca como exception (a transportadora reportou um problema) ou stale (nenhum movimento há muito tempo). Resolver uma exceção só arquiva o item da fila; não mexe no pedido nem na transportadora.

Prometido e realizado

Cada pedido grava a data de entrega prometida no momento da compra. Os relatórios medem a entrega real contra ela.

Endpoints

Método e caminhoPara quêPágina
GET /api/v1/admin/shipping/delivery-radarLista alertasRadar de entregas
GET /api/v1/admin/shipping/delivery-radar/slaPontualidade por transportadoraRadar de entregas
POST /api/v1/admin/shipping/delivery-radar/{alertId}/notifyAvisa o clienteRadar de entregas
POST /api/v1/admin/shipping/delivery-radar/{alertId}/dismissDispensa o alertaRadar de entregas
GET /api/v1/admin/shipping/exceptionsFila de exceçõesExceções de remessa
POST /api/v1/admin/shipping/exceptions/{shipmentId}/resolveResolve uma exceçãoExceções de remessa
GET /api/v1/admin/shipping/sla-reportPrazo prometido x realizadoRelatórios
GET /api/v1/admin/shipping/margin-reportFrete cobrado x pagoRelatórios
GET /api/v1/admin/shipping/fallback-coverageCobertura da tabela de contingênciaRelatórios

Erros comuns

  1. Esperar alertas em tempo real. A varredura roda a cada hora (e uma vez ao iniciar).
  2. Tratar carriers: null como erro. O SLA do radar devolve null quando não há entregas no período.
  3. Achar que resolver uma exceção entrega o pedido. Só arquiva o item na fila.
  4. Interpretar paid_cents do relatório de margem como o custo real da etiqueta. Hoje é uma estimativa.
  5. Usar id inexistente em dispensar ou resolver e esperar erro. Respondem 200 mesmo assim.
  6. Avisar de novo esperando outro voucher. O voucher é emitido uma única vez por alerta.

Próximos passos

Radar de entregas
Veja os pedidos em risco e compense o cliente.
Exceções de remessa
Trate remessas paradas ou com problema.
Relatórios
Compare prazo, margem e contingência.
Anterior
Enviar e entregar
Próxima
Radar de entregas
Nesta página
  • Como funciona
  • Conceitos-chave
  • Em risco e atrasado
  • Exceção de remessa
  • Prometido e realizado
  • Endpoints
  • Erros comuns
  • Próximos passos