# Lista de áreas de entrega

Retorna uma lista de áreas de entrega.

Endpoint: GET /api/v3/delivery-areas
Version: 3.0.0
Security: OAuth2

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

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

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

  - `term` (string)
    Filtro por um termo, busca pelo nome bairro ou cidade.
    Example: "Centro"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.delivery_areas` (array)
    Representa a lista de áreas de entrega.

  - `data.delivery_areas.id` (integer)
    Identificador único da área de entrega.
    Example: 1

  - `data.delivery_areas.district` (string)
    Nome do bairro.
    Example: "Centro"

  - `data.delivery_areas.city` (object)
    Representa uma cidade.

  - `data.delivery_areas.city.id` (integer)
    Identificador único da cidade na CPlug.
    Example: 3898

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

  - `data.delivery_areas.city.ibge_code` (string)
    Código da cidade no IBGE.
    Example: "3550308"

  - `data.delivery_areas.city.state` (string)
    Estado.
    Example: "SP"

  - `data.delivery_areas.price` (object)
    Valor da taxa de entrega.

  - `data.delivery_areas.price.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.delivery_areas.price.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.delivery_areas.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.delivery_areas.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

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