# Cria uma nova lista de preço

Cria uma nova lista de preço.

Endpoint: POST /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

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

## Request fields (application/json):

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

  - `position` (integer)
    Posição desta lista que irá aparecer.

Se não enviar este campo, o sistema irá auto gerar ou vai manter a mesma posição.
    Example: 1

  - `company_ids` (array)
    Id da Empresa (Company). 

Por padrão é considerado a empresa informado no header em CPlug-Company-Id.

Você pode localizar os IDs das empresas no _endpoint_ de [listagem de empresas](#tag/Companies/operation/get-companies).
    Example: [1]

  - `customer_category_ids` (array)
    Id da categoria de cliente.

Você pode localizar os IDs das categorias de cliente no _endpoint_ de [listagem de categorias de clientes](#tag/CustomerCategory/operation/get-customer-categories).
    Example: [1,2,3]

  - `modules` (array)
    Código do módulo.

- delivery_withdrawal: Delivery - Retirada;
- delivery: Delivery - Entrega;
- attendance: Atendimento de Mesas;
- point_of_sale: Balcão;
- totem: Autoatendimento;
- integrations: Integrações;
    Example: ["delivery","point_of_sale"]

  - `expiration` (any, required)

  - `app_ids` (array)
    Id do aplicativo.

Você pode localizar os IDs dos aplicativos no _endpoint_ de [listagem de aplicativos](#tag/Applications).
    Example: [1,2,3]

## Response 201 fields (application/json):

  - `data` (object)
    Representa uma lista de preços.

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

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

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

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

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

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

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

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

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

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

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

  - `data.expiration` (any)

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

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

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

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

  - `data.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.deleted` (boolean)
    Indica se está apagado ou não.

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

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

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