Webhook para Atualização de Tracking na Plataforma Boxlink

Caso sua transportadora ou ERP possua a função de emitir atualizações de status e ocorrências de tracking, você pode cadastrar uma URL padrão da boxlink para enviar estes dados.

As chamadas devem ser enviadas pelo método POST e a URL padrão é:

https://webhook.boxlink.com.br/tracking/default

:::caution
Caso sua transportadora não consiga se adpatar ao formato padão do nosso sistema basta enviar email para suporte@boxlink.com.br que a Boxlink pode personalizar uma URL que atenda o padrão da sua trasnportadora ou ERP.
:::

:::note

Clique aqui para acessar o layout detalhado
:::

O body do payload padrão a ser enviado:

{
    "origin": "tms_{identificador do cliente na Boxlink}",
    "boxlinkId": "{identificador do envio na Boxlink}",
    "freightCost": 18.75,
    "weight": 3.17,
    "estimatedDelivery": "06/12/2023",
    "invoiceList": [
        {
            "key": "12345678901234567890123456789012345678901234",
            "serie": "11",
            "number": "4381"
        }
    ],
"timeline": [
                {
                    "occurrenceId": "1",
                    "occurrence": "Encomenda na Origem",
                    "dateTime": "14/04/2023 19:29:12"
                },
                {
                    "occurrenceId": "2",
                    "occurrence": "Em viagem para Destino",
                    "dateTime": "15/04/2023 03:15:33"
                },
                {
                    "occurrenceId": "2",
                    "occurrence": "Chegada no Destino",
                    "dateTime": "16/04/2023 22:33:44"
                },
                {
                    "occurrenceId": "3",
                    "occurrence": "Em rota de Entrega",
                    "dateTime": "17/04/2023 10:00:00"
                },
                {
                    "occurrenceId": "4",
                    "occurrence": "Entrega Realizada",
                    "dateTime": "17/04/2023 15:22:01",
                    "receipt": "https://transportadora.cdn.com/file.jpg",
                    "recipient": "João da Silva"
                }
            ]

}

Tabela de Ocorrências de Tracking Padrão Boxlink

Glossário:

origin: string (dado fornecido pela boxlink - usado para identificar o cliente);
freighCost: decimal (valor de custo total do frete);
weight: decimal (peso);
estimatedDelivery: date (data prevista para entrega);
invoiceList: object (lista com os dados das Notas Fiscais do envio);
timeline: object (lista com as ocorrências de rastreamento.