Enviar evento de rastreio

Como atualizar a Clique Retire a respeito de algum evento ocorrido no processo.

post
Adicionar Evento de Rastreamento
https://services.cliqueretire.com.br/webhook/api/v1/volume-tracking
Descrição de como enviar a notificação do tracking de um volume para a Clique Retire.
Request
Response
Request
Headers
Content-Type
required
string
application/json
api-id
required
string
​
api-key
required
string
​
Body Parameters
expressNumber
required
string
Código da etiqueta do pacote
statusTimestamp
required
integer
Data de ocorrência do evento no formato timestamp
event
required
string
Evento relacionado a ocorrência do tipo ENUM conforme tabela Eventos Disponíveis.
Response
200: OK
Resposta do embarcador
{
    "status": "success",
    "message": "Envio recebido com sucesso",
    "hash": "09ef7f90-2e55-11ea-8baf-0d73fdad3a02"
}
401: Unauthorized
{
    "statusCode": 401,
    "error": "Unauthorized",
    "message": "Unauthorized"
}
404: Not Found
{
    "status": "error",
    "message": "Volume not found",
    "hash": "09ef7f90-2e55-11ea-8baf-0d73fdad3a02"
}
Eventos Disponíveis
Eventos relacionados a apenas 1 (um) volume.
Events
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
​

E-BOX - Previous

Informações E-BOX

Next - Transportadoras

Receber Solicitação de Coleta

Last updated 9 months ago

Events	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

Enviar evento de rastreio

postAdicionar Evento de Rastreamento

Eventos Disponíveis

post
Adicionar Evento de Rastreamento