> 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/logistica/coleta.md).

# Solicitação de coleta

Como solicitar que a transportadora Clique Retire faça a coleta de remessas.

## Solicitar coleta

<mark style="color:green;">`POST`</mark> `https://services.cliqueretire.com.br/ebox/api/v1/`

#### Headers

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

#### Request Body

| Name                          | Type   | Description          |
| ----------------------------- | ------ | -------------------- |
|                               | string |                      |
| origin\_city                  | string | Cidade de Origem     |
| origin\_name                  | string | Razão social empresa |
| origin\_state\_code           | string | UF                   |
| origin\_state\_tax\_payer\_id | string | Inscrição estadual   |
| origin\_street                | string | Endereço e número    |
| origin\_zip\_code             | string | CEP                  |
| shipment\_date                | string | Data de coleta       |
| shipment\_order\_array        | array  | Array de pedidos     |

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

```
{
    "id": "string"
}
```

{% endtab %}
{% endtabs %}

### shipment\_order\_array

| Fields                         | Description                           |
| ------------------------------ | ------------------------------------- |
| externalId                     | Identificador do pedido do embarcador |
| boxCode                        | Código único do E-BOX                 |
| customer                       | Objeto com informações do usuário     |
| shipment\_order\_volume\_array | Array com volumes                     |

### customer

| Fields    | Descripton             |
| --------- | ---------------------- |
| cellphone | 5521999999999          |
| email     | <barackobama@gmal.com> |

### shipment\_order\_volume

| Field                                   | Description                |
| --------------------------------------- | -------------------------- |
| height                                  | Altura                     |
| length                                  | Comprimento                |
| weight                                  | Peso                       |
| width                                   | Largura                    |
| shipment\_order\_volume\_number         | Código de barras do pacote |
| shipment\_order\_volume\_invoice\_array | Array nota fiscal          |

### shipment\_order\_volume\_invoice\_array

| Field                    | Description                        |
| ------------------------ | ---------------------------------- |
| already\_insured         | Carga assegurado (bool)            |
| cubage                   | Cubagem                            |
| icms\_aliquot            | Alíquota icms                      |
| icms\_calculation\_basis | Base de cálculo icms               |
| invoice\_cfop            | CFOP Nota fiscal                   |
| invoice\_date\_iso       | Data emissão nota fiscal(DDMMYYYY) |
| invoice\_key             | Chave nota fiscal                  |
| invoice\_nature          | Natureza nota fiscal               |
| invoice\_number          | Número nota fiscal                 |
| invoice\_products\_value | Valor dos produtos na nota fiscal  |
| invoice\_series          | Série da nota fiscal               |