> For the complete documentation index, see [llms.txt](https://clique-retire.gitbook.io/ebox/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clique-retire.gitbook.io/ebox/e-commerce/webhook/embarcadores.md).

# Receber atualização de rastreio

## Receber Evento de Rastreamento

<mark style="color:green;">`POST`</mark> `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.<br>

#### 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                                                 |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

### 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   |
