# Lista de Listas de preços

Retorna uma lista de Listas de Preços.

Endpoint: GET /api/v3/price-lists
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:

  - `name` (string)
    Filtra pelo nome da lista de preço.
    Example: "Lista Padrão"

  - `modules` (string)
    Filtra pelo módulo da lista de preço separado por vírgula.
    Enum: "delivery_withdrawal", "delivery", "attendance", "point_of_sale", "totem", "integrations"

  - `sources` (string)
    Filtra pela fonte do aplicativo vinculado a lista de preço.
    Enum: "totem", "pdv", "erp", "store"

  - `validity_types` (string)
    Filtra pelo tipo de validade da lista de preço separado por vírgula.

Tipos disponíveis:
- no_expiration_date: Sem validade - Lista de preços que não possui data de expiração
- interval: Intervalo - Lista de preços com data inicial e final definidas  
- hours: Por horário - Lista de preços com um único horário de funcionamento
- days: Por dias da semana - Lista de preços com horários específicos para dias da semana
- specific: Horários específicos - Lista de preços com múltiplos horários/períodos configurados
    Example: "no_expiration_date,interval"

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

## Response 200 fields (application/json):

  - `data` (object)

  - `data.price_lists` (array)
    Representa a lista de preços

  - `data.price_lists.id` (integer)
    Identificador único da lista de preço.
    Example: 123

  - `data.price_lists.name` (string)
    Nome da lista de preço.
    Example: "Minha lista"

  - `data.price_lists.position` (integer)
    Posição desta lista que irá aparecer.
    Example: 1

  - `data.price_lists.companies` (array)
    Lista de empresas que esta lista está associado.

  - `data.price_lists.companies.id` (integer)
    Id único da empresa
    Example: 123

  - `data.price_lists.companies.name` (string)
    Nome fantasia da empresa
    Example: "CPlug"

  - `data.price_lists.companies.company_name` (string)
    Razão social da empresa
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `data.price_lists.customer_categories` (array)
    Lista de categorias de cliente que esta lista está associada.

  - `data.price_lists.customer_categories.id` (integer)
    Id único da categoria de cliente
    Example: 123

  - `data.price_lists.customer_categories.name` (string)
    Nome da categoria de cliente
    Example: "Ouro"

  - `data.price_lists.modules` (array)
    Lista de módulos.
    Enum: "delivery_withdrawal", "delivery", "attendance", "point_of_sale", "totem", "integrations"

  - `data.price_lists.expiration` (any)

  - `data.price_lists.apps` (array)
    Lista de aplicativos.

  - `data.price_lists.apps.id` (integer)
    Identificador único do aplicativo
    Example: 123

  - `data.price_lists.apps.name` (string)
    Nome do aplicativo.
    Example: "Totem entrada"

  - `data.price_lists.apps.type` (string)
    Tipo do aplicativo.
    Enum: "totem", "terminal", "server", "store"

  - `data.price_lists.is_duplicating` (boolean)
    Indica se a lista de preços está sendo duplicada. 

Isso significa que há produtos sendo processados em uma fila de processamento.

  - `data.price_lists.deleted` (boolean)
    Indica se está apagado ou não.

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

  - `data.price_lists.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