Detalhes do webhook de rastreio

Após a inscrição ser criada, o webhook é associado ao tenant_id do cliente. Quando uma remessa vinculada a esse tenant é criada ou tem o rastreio atualizado, a Magalog envia uma notificação para a URL cadastrada.

Cada mensagem informa o status, os parâmetros que identificam o recurso e a rota associada ao rastreio.

Tópico de inscrição

Tópico	Descrição	Escopo necessário
logistic_order_tracking_updated	Eventos gerados na criação da remessa e nas atualizações de rastreio durante o ciclo de vida dela.	open:tracking:read

Possíveis status de retorno

O campo data.status identifica o status da remessa. O webhook pode enviar os seguintes valores:

Código	Significado
SHIPPING_CREATED	Remessa criada no sistema.
IN_PREPARATION	Remessa em preparação, aguardando informações ou processos internos, como Nota Fiscal ou volumes.
WAITING_INVOICE	Aguardando emissão ou associação da Nota Fiscal à remessa.
WAITING_STOCK_OPERATION	Aguardando uma operação de estoque, como separação, conferência ou movimentação do pedido.
WAITING_POST	Aguardando a postagem da remessa.
POSTED	Remessa postada.
READY_TO_SHIP	Remessa pronta para envio.
ACCEPTED	Transportadora confirmou que assumirá a operação ou coleta da remessa.
REJECTED	Remessa rejeitada pela transportadora ou pelo fluxo operacional.
WAITING_PICKUP	Aguardando a chegada do transportador para coleta.
PICKED_UP	Coleta realizada com sucesso.
PICKED_FAILURE	Falha na tentativa de coleta da remessa.
IN_TRANSIT	Remessa em trânsito entre unidades ou localidades.
IN_ROUTE_PICKUP	Transportador em rota para realizar a coleta ou retirada da remessa.
IN_ROUTE_DELIVERY	Remessa em rota de entrega para o destinatário.
WAITING_WITHDRAW	Aguardando a retirada da remessa pelo destinatário ou responsável.
WITHDRAWN	Remessa retirada com sucesso.
DELIVERED	Entrega realizada com sucesso.
DELIVERY_FAILURE	Falha na tentativa de entrega.
TRANSPORT_PROBLEM	Problema identificado durante o transporte da remessa.
DIRECTED_TO_RETURN	Remessa encaminhada para devolução.
DIRECTED_TO_REFUND	Remessa encaminhada para reembolso ou estorno.
IN_CANCELLATION	Cancelamento da remessa em andamento.
CANCELED	Remessa cancelada.
REFATURATED	Remessa refaturada ou com a documentação fiscal atualizada.
REVERSE_MANUALLY_COMPLETED	Processo de logística reversa concluído manualmente.
AUTHORIZATION_CODE_EXPIRED	Código de autorização expirado.
AUTHORIZATION_CODE_CANCELLED	Código de autorização cancelado.

Exemplo de notificação

{
  "data": {
    "params": {
      "code_id": "MLG261001Y8PQSYWIGL",
      "id": "1e23acf7-30b1-462e-b56d-e27266c323fc",
      "reference": "11222333-TESTE-EXEMPLO"
    },
    "resource": "/logistic/tracking/v1/shipment?code_id=MLG261001Y8PQSYWIGL",
    "status": "SHIPPING_CREATED",
    "type": "logistic_order_tracking_updated"
  },
  "tenant_id": "2df7eacd-1014-4c8d-9859-9ff9526ee5fd",
  "topic": "logistic_order_tracking_updated"
}

Campo	Descrição
data.status	Novo status da remessa.
data.params	Identificadores da remessa: code_id, id e reference.
data.resource	Rota associada ao recurso de rastreio atualizado.
data.type	Tipo do evento enviado.
tenant_id	Identificador do tenant associado à inscrição e ao evento.
topic	Nome do tópico que originou a notificação.

Configurar o recebimento

Para configurar o endpoint e se inscrever no tópico, siga a documentação geral de Webhooks.

Observação

O webhook notifica apenas eventos de remessas associadas ao tenant_id da inscrição.