---
description: Recursos relacionados a pedidos, entidade que agrupa volumes.
---

# Pedidos

## Listar Pedidos

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

Lista pedidos

#### Headers

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

{% tabs %}
{% tab title="200 Pedido criado" %}
```
[
    {
        "created_at": "2019-12-26T12:12:56.281Z",
        "company": "CLIQUERETIRE",
        "customer": {
            "cellphone"5521966940535",
            "sprm.saulo@gmail.com",
        },
        "orderId": "DRZIMY",
        "status": "IMPORTED",
        "volumes": [
            {
                "expressNumber": "JN424467840BR",
                "id": "8a7ee4856f09ccfe016f421fc63d3742",
                "external_id": "8a7ee4856f09ccfe016f421fc63d3742"
            }
        ],
        "id": "0cb53490-27d9-11ea-8dc5-09031cbbcbea",
        "boxCode": "CR0040"
    }
]
```
{% endtab %}

{% tab title="401 " %}
```
{
    "message": "Unauthorized"
}
```
{% endtab %}
{% endtabs %}

## Obter Informações de um Pedido

<mark style="color:blue;">`GET`</mark> `https://services.cliqueretire.com.br/ebox/api/v1/orders/:id`

Busca informações de um pedido, utilizando o id do pedido.

#### Path Parameters

| Name | Type   | Description  |
| ---- | ------ | ------------ |
| id   | string | Id do pedido |

#### Headers

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

{% tabs %}
{% tab title="200 " %}
```
{
    "created_at": "2019-12-26T12:12:56.281Z",
    "company": "CLIQUERETIRE",
    "takeUserPhoneNumber": "5521966940535",
    "orderId": "DRZIMY",
    "status": "IMPORTED",
    "takeUserMail": "sprm.saulo@gmail.com",
    "volumes": [
        {
            "expressNumber": "JN424467840BR",
            "id": "8a7ee4856f09ccfe016f421fc63d3742"
        }
    ],
    "id": "0cb53490-27d9-11ea-8dc5-09031cbbcbea",
    "boxCode": "CR0040"
}
```
{% endtab %}

{% tab title="401 " %}
```
{
    "message": "Unauthorized"
}
```
{% endtab %}
{% endtabs %}

## Criar Pedido

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

Cria um pedido com seus pacotes

#### Headers

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

#### Request Body

| Name        | Type   | Description                                                            |
| ----------- | ------ | ---------------------------------------------------------------------- |
| invoice     | object | Objeto com dados da nota fiscal                                        |
| externalId  | string | Identificador do pedido do embarcador                                  |
| customer    | object | Informações do destinatário                                            |
| boxCode     | string | Código do E-BOX                                                        |
| volumes     | array  | Volumes associados a esse pedido                                       |
| urlCallback | string | URL para qual o webHook irá disparar os eventos relacionados ao pedido |

{% tabs %}
{% tab title="200 " %}
```
{
    "id": "string"
}
```
{% endtab %}

{% tab title="401 " %}
```
{
    "message": "Unauthorized"
}
```
{% endtab %}
{% endtabs %}

### customer

Informações do destinatário.\
(\*) Required

| Field          |  **Description**                         |
| -------------- | ---------------------------------------- |
| cellphone\*    | Telefone do destinatário (5521999999999) |
| email\*        | string                                   |
| fullName       | string                                   |
| documentNumber | string                                   |

### volumes

Informações do volume\
(\*)Required

| Field           |  **Description**           |
| --------------- | -------------------------- |
| expressNumber\* | Código de barras do pacote |
| designationSize | ENUM \["S", "M", "L"]      |
| externalId      | string                     |

### invoice

Informações da nota fiscal\
(\*)Required

| Field         |  **Description**                           |
| ------------- | ------------------------------------------ |
| series        | Número de série da nota fiscal             |
| number        | Número da nota fiscal                      |
| key           | Chave da nota fiscal                       |
| date          | Data de emissão da nota fiscal             |
| dateIso       | Data de emissão da nota fiscal formato ISO |
| totalValue    | Valor total da nota fiscal                 |
| productsValue | Valor total dos produtos                   |
| insured       | Produto assegurado                         |

## Criar Pedido Reversa

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

Criação de pedidos com volumes para logística reversa.

#### Headers

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

#### Request Body

| Name        | Type   | Description                                                            |
| ----------- | ------ | ---------------------------------------------------------------------- |
| invoice     | string | Objeto com dados da nota fiscal                                        |
| externalId  | string | Identificador do pedido do embarcador                                  |
| customer    | string | Informações do destinatário                                            |
| boxCode     | string | Código do E-BOX                                                        |
| volumes     | string | Volumes associados a esse pedido                                       |
| urlCallback | string | URL para qual  o webhook irá disparar eventos relacionados aos pedidos |

{% tabs %}
{% tab title="200 " %}
```
{
    "id": "string"
}
```
{% endtab %}

{% tab title="401 " %}
```
{
    "message": "Unauthorized"
}
```
{% endtab %}
{% endtabs %}

### customer

Informações do destinatário.\
(\*) Required

| Field          | Description                              |
| -------------- | ---------------------------------------- |
| cellphone\*    | Telefone do destinatário (5521999999999) |
| email\*        | string                                   |
| fullName       | string                                   |
| documentNumber | string                                   |

### volumes

Informações do volume\
(\*)Required

| Field           | Description                |
| --------------- | -------------------------- |
| expressNumber\* | Código de barras do pacote |
| designationSize | ENUM \["S", "M", "L"]      |
| externalId      | string                     |

### invoice

Informações da nota fiscal

| Field         | Description                                |
| ------------- | ------------------------------------------ |
| series        | Número de série da nota fiscal             |
| number        | Número da nota fiscal                      |
| key           | Chave da nota fiscal                       |
| date          | Data de emissão da nota fiscal             |
| dateIso       | Data de emissão da nota fiscal formato ISO |
| totalValue    | Valor total da nota fiscal                 |
| productsValue | Valor total dos produtos                   |
| insured       | Produto assegurado                         |

## Cancelar Pedido

<mark style="color:red;">`DELETE`</mark> `https://services.cliqueretire.com.br/ebox/api/v1/orders/:id`

Deleta um pedido

#### Path Parameters

| Name | Type   | Description  |
| ---- | ------ | ------------ |
| id   | string | Id do pedido |

#### Headers

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

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

{% tab title="401 " %}
```
{
    "message": "Unauthorized"
}
```
{% endtab %}
{% endtabs %}
