# Lista os endereços do cliente

Lista os endereços do cliente.

Endpoint: GET /api/v3/customers/{customerId}/addresses
Version: 3.0.0
Security: OAuth2

## Path parameters:

  - `customerId` (integer, required)
    ID do cliente.

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `ibge_code` (string)
    Filtro pelo Código da cidade segundo o IBGE.
    Example: "3550308"

  - `city_id` (number)
    Filtro pelo Código da cidade na CPlug.
    Example: 3898

  - `state` (string)
    Filtro pela Sigla do estado.
    Example: "SP"

  - `city` (string)
    Filtro pelo Nome da cidade.
    Example: "São Paulo"

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

## Response 200 fields (application/json):

  - `data` (object)

  - `data.addresses` (array)
    Representa a lista de endereços

  - `data.addresses.id` (number)
    id do endereço.
    Example: 220

  - `data.addresses.nickname` (string)
    Apelido do endereço.
    Example: "Casa"

  - `data.addresses.type` (string, required)
    Tipo do endereço.

- default endereço principal.
- shipping endereço de entrega.
- charge endereço de cobrança.
- other outro tipo de endereço.
    Enum: "default", "shipping", "charge", "other"

  - `data.addresses.street` (string, required)
    Nome do logradouro (Rua, Avenida, praça, etc).
    Example: "Avenida Paulista"

  - `data.addresses.number` (string)
    Número do logradouro.
    Example: "42 A"

  - `data.addresses.city_id` (number)
    ID da cidade.

Obrigatório quando o campo ibge_code não for passado.
    Example: 1234

  - `data.addresses.ibge_code` (string)
    Código do município segundo IBGE.

Exemplo: O código do município segundo IBGE é 3550308

Obrigatório quando o campo city_id não for passado.
    Example: "3550308"

  - `data.addresses.state` (string)
    Sigla do estado do endereço.
    Example: "SP"

  - `data.addresses.city` (string)
    Nome da cidade.
    Example: "São Paulo"

  - `data.addresses.neighborhood` (string)
    Nome do Bairro.
    Example: "Bela Vista"

  - `data.addresses.complement` (string)
    Complemento do endereço.
    Example: "Apto 2550"

  - `data.addresses.zip_code` (string)
    CEP do endereço.
    Example: "01311000"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields