Pular para o conteúdo principal

Webhooks Tracking

Os webhooks permitem que você obtenha notificações programáticas em tempo real sobre alterações no rastreamento de remessas à medida que elas acontecem. Em vez de extrair informações por meio de nossa API, os webhooks enviarão informações diretamente ao seu endpoint configurado.

Para registrar um webhook é necessário seguir os passos existentes na documentação de webhooks.

🔔 Tópicos de Inscrição e Exemplos de Notificações​

Ao se inscrever para receber notificações do nosso webhook, sua URL receberá mensagens referentes a diferentes tópicos, cada um relacionado a um recurso específico.

Tópico Descrição Possíveis Status Exemplo de Mensagem
logistic_seller_shippings_updated Eventos gerados durante o ciclo de vida da remessa. Notifica sobre atualizações de rastreamento e mudanças de status. Escopo: open:shipping-order-shipping-tracking-seller:read SHIPPING_CREATED, IN_PREPARATION, WAITING_PICKUP, WAITING_POST, PICKED_UP, POSTED, PICKED_FAILURE, POSTED_FAILURE, IN_TRANSIT, TRANSPORT_PROBLEM, IN_ROUTE_PICKUP, IN_ROUTE_DELIVERY, DELIVERY_FAILURE, WAITING_WITHDRAW, DELIVERED, DIRECTED_TO_REFUND, CANCELED, REFATURATED, DIRECTED_TO_RETURN, WITHDRAWN, AUTHORIZATION_CODE_EXPIRED, AUTHORIZATION_CODE_CANCELLED, REVERSE_MANUALLY_COMPLETED, WAITING_INVOICE, READY_TO_SHIP 
{
    "data": {
        "status": "DELIVERED",
        "params": {
            "id": "c90229d9-7ed4-4ff4-b7c5-283d05e40094"
        },
        "resource": "/logistics/v1/shippings/c90229d9-7ed4-4ff4-b7c5-283d05e40094/tracking"
    },
    "tenant_id": "1ca52337-7e79-4952-a0c0-80b65f630c5e",
    "topic": "logistic_seller_shippings_updated"
}

Receba Atualizações por Webhook​

Para configurar um webhook, siga a documentação do portal de desenvolvedores.

ℹ️ Observação

Este tópico é específico para vendedores e contém eventos de rastreamento detalhados da jornada da remessa.