Callback de Atualização de Status do Envio
Você pode cadastrar uma URL em nosso sistema para receber as alterações de status do envio via webhook.
Para configurar o webhook em nosso sistema, basta enviar email para suporte@boxlink.com.br informando a URL para a qual deverão ser enviados as chamadas.
As chamadas serão enviadas pelo método POST
Caso a chamada necessite de autenticação, serão necessários informar os seguintes dados:
• Tipo de Autenticação (Basic, OAuth, etc...)
• Usuário
• Senha
• Se existir algum tipo de token (access_token, token, secret_key, etc...)
O body do payload padrão da chamada é:
{
"rastreadorTms": "BLK00000000001",
"lifecycleStage": "ENTREGUE",
"lifecycleDateTime": "2023-02-03T06:51:00"
}
:::note
URL cadastrada deve estar preparada para receber o body detalhado acima via POST.
Os atributos podem ser renomeados de acordo com a necessidade da sua aplicação, basta informar as nomenclaturas desejadas no email de solicitação.
:::
Atributos Disponíveis:
| ATRIBUTO | DESCRIÇÃO |
|---|---|
| rastreadorTms | Código único de identificação do envio na Boxlink |
| lifecycleStage | Etapa do ciclo de vida do envio |
| lifecycleDateTime | Data e Hora em que a etapa do ciclo de vida do envio foi atualizado |
| invoiceNumber | Número da nota fiscal |
| invoiceSerie | Série da nota fiscal |
| ecommerceId | Identificador do pedido na plataforma de e-commerce |
| erpId | Identificador do pedido no ERP |
| sellerKey | Identificador do pedido no Seller |
| addresseeEmail | Email do destinatário |
| constant1 | Campo livre para atribuir valores fixos |
| constant2 | Campo livre para atribuir valores fixos |
| constant3 | Campo livre para atribuir valores fixos |
Etapas Disponíveis para Notificação:
| ETAPA | TEXTO PADRÃO |
|---|---|
| EXPEDIDO | EXPEDIDO |
| AGUARDANDO_RETIRADA_TRANSPORTADORA | AGUARDANDO_RETIRADA_TRANSPORTADORA |
| DISPONIVEL_PARA_RETIRADA | DISPONIVEL_PARA_RETIRADA |
| SAIU_PARA_ENTREGA | SAIU_PARA_ENTREGA |
| ENTREGUE | ENTREGUE |
| PROBLEMA_ENTREGA | ENTREGA_NAO_REALIZADA ou PROBLEMA_ENTREGA |
:::note
O texto de cada etapa enviada no payload do webhook pode ser alterado de acordo com a necessidade da sua aplicação, basta informar como gostaria de receber a informação de cada etapa no email de solicitação.
:::
:::highlight red 📌
Cada etapa pode ser ativada ou não para disparos do webhoook.
ex.: Se quiser receber somente as alteração de status de envios que estiverem na etapa AGUARDANDO_RETIRADA, pode-se deixar ativo somente esta etapa
Informe o suporte@boxlink.com.br sobre quais etapas você desejar deixar ativa.
:::
:::info
Atualmente a forma de cadastro é interna, realizada diretamente pelo nosso time de CS. Desta forma, os dados devem ser enviados através do nosso canal de suporte - suporte@boxlink.com.br.
:::