Receber atualização de rastreio

Como receber atualizações do tracking de volumes através do webhook Clique Retire

Receber Evento de Rastreamento

POST https://sua-url.com/

Esse recurso trata-se de um Webhook que oferece o envio de informações relacionadas aos eventos de rastreamento para sistemas terceiros integrados. A URL para o recebimento do evento precisa ser informada no momento da criação do pedido ou através do nosso canal de suporte. Todos os eventos enviados são sempre relacionados a 1 (um) volume.

Request Body

Name	Type	Description
expressNumber	string	Código de barras do volume
eventTimeStamp	integer	Data de ocorrência do evento
accessCode	string	Código para retirar o volume do E-BOX
shortLink	string	Link contendo o QR Code para retirar o volume do E-BOX
overdueTimeStamp	integer	Data de expiração do volume no E-BOX
customer	string	Usuário final
boxCode	string	Código único do E-BOX
event	string	Evento

200

Eventos enviados

Fields	Description
ORIGIN_COLLECTED	Coletado no centro de distribuição do embarcador
CARRIER_DISTRIBUTION_CENTER	No centro de distruibuição da transportadora
FOR_MERCHANT_STORE_IN_BOUND	No centro de distribuição Clique Retire
FOR_MERCHANT_STORE_IN_TRANSIT_TO_STORE	A caminho do E-BOX
FOR_MERCHANT_STORE_IN_STORE	Inserido no E-BOX
FOR_MERCHANT_STORE_COURIER_TAKEN	Volume expirado, coletado pela transportadora
FOR_MERCHANT_STORE_COURIER_TAKEN_IN_BOUND	Volume expirado, coletado pela transportadora, retornado para o centro de distribuição Clique Retire
FOR_MERCHANT_STORE_CUSTOMER_TAKEN	Volume coletado pelo usuário
FOR_MERCHANT_STORE_IN_STORE_EXPIRED	Tempo do volume no E-BOX expirado
FOR_MERCHANT_STORE_IN_STORE_UPCOMING_EXPIRED	Tempo do volume no E-BOX prestes a expirar
FOR_CUSTOMER_STORE_IN_STORE	Inserido no E-BOX pelo usuário. (Logística Reversa)
FOR_CUSTOMER_STORE_COURIER_TAKEN	Coletado no E-BOX pela transportadora (Logística Reversa)
FOR_CUSTOMER_STORE_IN_BOUND	No centro de distribuição Clique Retire

endCustomer

Fields	Description
cellPhone	Celular do usuário
email	Email do usuário