# Lista de atributos

Retorna a lista dos atributos de produto cadastrados. 

Os dados de atributos são compartilhados com todas as lojas da rede.

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

  - `attributes_id` (string)
    Filtra pelos IDs dos atributos de produto. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `search` (string)
    Filtra pelas principais propriedades do atributo, incluindo name, e code.
    Example: "Cor"

  - `name` (string)
    Filtra pelo nome do atributo.
    Example: "Cor"

  - `code` (string)
    Filtra pelo código do atributo.
    Example: "ABC123"

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

  - `orderByField` (string)
    Define qual o campo que fará a ordenação na listagem de dados.
    Enum: "id", "name", "position"

  - `orderByType` (string)
    Define em qual ordem os campos serão listados.
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.attributes` (array)
    Representa a lista de atributos.

  - `data.attributes.id` (integer, required)
    Identificador único do atributo.
    Example: 123

  - `data.attributes.name` (string, required)
    Nome do atributo.
    Example: "Nome do atributo"

  - `data.attributes.code` (string)
    Código do atributo. Esse código deve ser único. Exemplo: COD-CP-01
    Example: "COD-CP-01"

  - `data.attributes.price_calculation_type` (string)
    Tipo de calculo de preço a ser aplicado nas opções do atributo.

- highest: calcula pelo maior valor.
- average: calcula pela média dos valores.
- proportional: calcula proporcionalmente os valores.
- cumulative: calcula a soma dos valores.
    Enum: "highest", "average", "proportional", "cumulative"

  - `data.attributes.min_choices` (integer)
    Número mínimo de opções que devem ser seleciona no atributo.

Se o número mínimo for 0 torna a seleção de atributos opcional, se o número for maior que 0 torna a seleção de atributos obrigatória até o número mínimo de opções selecionadas.

  - `data.attributes.max_choices` (integer)
    Número máximo de opções que devem ser seleciona no atributo.

O número máximo deve ser igual ou maior que o número mínimo.
    Example: 1

  - `data.attributes.charge_from_quantity` (integer)
    Indica a partir de qual quantidade de atributos deve iniciar o calculo de cobrança pelo atributo selecionado.

Se charge_from_quantity for 2, e o forem seleciona 3 opções para o atributo no valor de 10 BRL com o tipo de calculo cumulative, o valor do atributo será equivalente à 10 BRL, e não 30 BRL, pois ele só começa a ser calculado a partir da opção número 3.

  - `data.attributes.position` (integer)
    Indica a posição de ordenação do atributo em listagens
    Example: 1

  - `data.attributes.product_count` (integer)
    Indica a quantidade de produtos que possuem esse atributo
    Example: 4

  - `data.attributes.options` (array)
    Lista de opções do atributo.

  - `data.attributes.options.id` (integer, required)
    Identificador único da opção.
    Example: 123

  - `data.attributes.options.name` (string, required)
    Nome da opção.
    Example: "Nome da opção"

  - `data.attributes.options.code` (string)
    Código da opção. Esse código deve ser único. Exemplo: COD-CP-01
    Example: "COD-CP-01"

  - `data.attributes.options.description` (string)
    Descrição da opção.
    Example: "Descrição da opção"

  - `data.attributes.options.unitary_value` (object)
    Valor unitário da opção.

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

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

  - `data.attributes.options.image_url` (null,string)
    URL da imagem da opção (mande este parâmetro vazio para excluir a imagem).
    Example: "https://images.connectplug.com.br/4f01c1252eea.jpg"

  - `data.attributes.options.position` (integer)
    Indica a posição de ordenação da opção em listagens.
    Example: 1

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

  - `data.attributes.options.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