> 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-box/informacoes-e-box.md).

# Informações E-BOX

Recursos relacionados aos E-BOX

## Compatibilidade entre volume e E-BOX

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

Essa consulta pode ser utilizada pelo embarcador no momento em que os produtos estão no carrinho de compras para verificação da compatibilidade entre o tamanho dos pacotes e o tamanho suportado pelos compartimentos do Locker para receber o produto.

#### Headers

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

#### Request Body

| Name    | Type   | Description                                               |
| ------- | ------ | --------------------------------------------------------- |
| boxCode | string | Código do E-BOX                                           |
| volumes | array  | Volumes que deseja consultar compatibilidade com o locker |

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

```
{
  "volumes": [
    {
      "ref_id": "box1",
      "compatible": true,
      "lockers": [
        {
          "type": "M",
          "width": 34.2,
          "heigth": 18.8,
          "depth": 47.2,
          "price": 5,
          "used": 2,
          "enable": 8
        },
        {
          "type": "L",
          "width": 34.2,
          "heigth": 39.1,
          "depth": 47.2,
          "price": 6,
          "used": 2,
          "enable": 1
        }
      ]
    },
    {
      "ref_id": "box2",
      "compatible": true,
      "lockers": [
        {
          "type": "S",
          "width": 34.2,
          "heigth": 7.8,
          "depth": 47.2,
          "price": 4,
          "used": 1,
          "enable": 27
        },
        {
          "type": "M",
          "width": 34.2,
          "heigth": 18.8,
          "depth": 47.2,
          "price": 5,
          "used": 2,
          "enable": 8
        },
        {
          "type": "L",
          "width": 34.2,
          "heigth": 39.1,
          "depth": 47.2,
          "price": 6,
          "used": 2,
          "enable": 1
        }
      ]
    },
    {
      "ref_id": "box3",
      "compatible": true,
      "lockers": [
        {
          "type": "S",
          "width": 34.2,
          "heigth": 7.8,
          "depth": 47.2,
          "price": 4,
          "used": 1,
          "enable": 27
        },
        {
          "type": "M",
          "width": 34.2,
          "heigth": 18.8,
          "depth": 47.2,
          "price": 5,
          "used": 2,
          "enable": 8
        },
        {
          "type": "L",
          "width": 34.2,
          "heigth": 39.1,
          "depth": 47.2,
          "price": 6,
          "used": 2,
          "enable": 1
        }
      ]
    }
  ]
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message": "Unauthorized"
}
```

{% endtab %}
{% endtabs %}

### Volumes

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

| Field      | Description                                           |
| ---------- | ----------------------------------------------------- |
| externalId | Id para Referência do volume no sistema do embarcador |
| width\*    | Largura do volume em cm                               |
| heigth\*   | Altura do volume em cm                                |
| depth\*    | Profundidade do volume em cm                          |

## Listar E-BOX

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

Recursos público para consulta de listagem de E-BOX disponíveis na rede Clique Retire

#### Headers

| Name         | Type   | Description      |
| ------------ | ------ | ---------------- |
| Content-Type | string | application/json |

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

```
{
  "maxCount": 100,
  "page": 0,
  "resultList": [
    {
      "instructions": {
        "pickup": "Insira o código ou aproxime o QR code do leitor",
        "receipt": "Insira o código ou aproxime o QR code do leitor"
      },
      "boxCode": "CR0071",
      "working_hours": {
        "sunday": {
          "start": "05:00",
          "end": "23:59"
        },
        "saturday": {
          "start": "05:00",
          "end": "23:59"
        },
        "tuesday": {
          "start": "05:00",
          "end": "23:59"
        },
        "friday": {
          "start": "05:00",
          "end": "23:59"
        },
        "thursday": {
          "start": "05:00",
          "end": "23:59"
        },
        "wednesday": {
          "start": "05:00",
          "end": "23:59"
        },
        "holiday": {
          "start": "05:00",
          "end": "23:59"
        },
        "monday": {
          "start": "05:00",
          "end": "23:59"
        }
      },
      "name": "Estação República L4 - Disponível a partir de 20/3/2020",
      "warehouse_location": {
        "reference": "N/C",
        "additional_information": "Ao chegar procurar um funcionário da Clique Retire.",
        "number": "470",
        "city": "São Paulo",
        "street": "Rua Charles Darwin",
        "latitude": "-23.655119",
        "neighborhood": "Vila Santa Catarina",
        "state": "SP",
        "zip_code": "04379-074",
        "longitude": "-46.6598096"
      },
      "location": {
        "reference": "Estação República L4",
        "additional_information": "Metrô CCR",
        "number": "24",
        "street": "Rua do Arouche,",
        "latitude": -23.5431042,
        "zip_code": "22070011",
        "longitude": -46.6440237
      },
      "facilities": {
        "parking": "false",
        "close_to_subway": "true",
        "free_parking": "false",
        "accessibility": "true",
        "air_conditioned": "true"
      },
      "operator": "WFRETES",
      "group": "MetroSaoPaulo"
    },
    {
      "instructions": {
        "pickup": "Utilize o QR Code recebido para retirar sua encomenda.",
        "receipt": "Utilize o QR Code recebido para retirar sua encomenda."
      },
      "boxCode": "CR0001",
      "working_hours": {
        "sunday": {
          "start": "07:00",
          "end": "23:00"
        },
        "saturday": {
          "start": "05:00",
          "end": "23:00"
        },
        "tuesday": {
          "start": "05:00",
          "end": "23:00"
        },
        "friday": {
          "start": "05:00",
          "end": "23:00"
        },
        "thursday": {
          "start": "05:00",
          "end": "23:00"
        },
        "wednesday": {
          "start": "05:00",
          "end": "23:00"
        },
        "holiday": {
          "start": "07:00",
          "end": "23:00"
        },
        "monday": {
          "start": "05:00",
          "end": "23:00"
        }
      },
      "name": "Estação Jardim Oceânico",
      "warehouse_location": {
        "reference": "Estação de metrô estácio",
        "additional_information": "Ao chegar na estação procurar um funcionário da Clique Retire.",
        "number": "15",
        "city": "Rio de Janeiro",
        "street": "R. Ulysses Guimarães",
        "latitude": "-22.9134908",
        "neighborhood": "Cidade Nova",
        "state": "RJ",
        "zip_code": "20211-225",
        "longitude": "-43.206488"
      },
      "location": {
        "reference": "Estação Jardim Oceânico",
        "additional_information": "Plataforma: 1 (Desembarque), abaixo da última escada",
        "number": "S/N",
        "street": "N/D",
        "latitude": -23.0068073,
        "zip_code": "22640-100",
        "longitude": -43.3109288
      },
      "facilities": {
        "parking": false,
        "close_to_subway": true,
        "free_parking": false,
        "accessibility": false,
        "air_conditioned": true
      },
      "operator": "WFRETES",
      "group": "MetroRio"
    }
  ]
}
```

{% endtab %}
{% endtabs %}

## Listar E-BOX CSV

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

Recurso público para consulta de listagem de E-BOX disponíveis na rede Clique Retire no formato CSV.

#### Path Parameters

| Name         | Type   | Description      |
| ------------ | ------ | ---------------- |
| Content-Type | string | application/json |

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

```
```

{% endtab %}
{% endtabs %}

## Detalhes E-BOX

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

Informações do E-BOX e de seus compartimentos

#### Path Parameters

| Name    | Type   | Description           |
| ------- | ------ | --------------------- |
| boxCode | string | Código único do E-BOX |

#### Headers

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

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

```
{
  "id": "0bf28187-a11e-4ef2-8a56-30a6b87d3a03",
  "name": "BLE Test Rio",
  "boxCode": "BLE001",
  "compartmentList": [
    {
      "compartmentId": "61d73888-7284-464a-b5e4-c16882dd5820",
      "compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
      "name": "A1",
      "compartmentStatus": "OCCUPIED",
      "shipment": {
        "ordersId": "ce9b30ff-760a-48f6-8b93-f8dbbc074d2d",
        "trackingNumber": "BLETEST13",
        "serviceType": "Delivery",
        "companyName": "WFRETES",
        "storeTime": "2020-03-11T16:21:29-03:00"
      }
    },
    {
      "compartmentId": "feb7fa35-4d3f-4ec5-a89e-89495061167b",
      "compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
      "name": "A2",
      "compartmentStatus": "AVAILABLE",
      "shipment": null
    },
    {
      "compartmentId": "44da6d96-b40a-4ac2-a143-0b7ccaf65882",
      "compartmentTypeId": "d092725609ab11e58bdb0242ac110001",
      "name": "A3",
      "compartmentStatus": "AVAILABLE",
      "shipment": null
    }
  ],
  "status": {
    "S": {
      "LOCKED": 1,
      "ENABLE": 2
    }
  }
}
```

{% endtab %}

{% tab title="401 " %}

```
{
    "message": "Unauthorized"
}
```

{% endtab %}
{% endtabs %}