Enviar evento de rastreio

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

Adicionar Evento de Rastreamento

POST 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.

Headers

Name	Type	Description
Content-Type	string	application/json
api-id	string
api-key	string

Request Body

Name	Type	Description
expressNumber	string	Código da etiqueta do pacote
statusTimestamp	integer	Data de ocorrência do evento no formato timestamp
event	string	Evento relacionado a ocorrência do tipo ENUM conforme tabela Eventos Disponíveis.

200 Resposta do embarcador

{
    "status": "success",
    "message": "Envio recebido com sucesso",
    "hash": "09ef7f90-2e55-11ea-8baf-0d73fdad3a02"
}

401

{
    "statusCode": 401,
    "error": "Unauthorized",
    "message": "Unauthorized"
}

404

{
    "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