# Lista de produtos relacionados ao periférico

Retorna lista de produtos relacionados a um periférico.

Endpoint: GET /api/v3/peripherals/{peripheralId}/products
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

## Path parameters:

  - `peripheralId` (integer, required)
    ID do periférico.
    Example: 123

## Query parameters:

  - `search` (string)
    Filtra pelas principais propriedades do produto, incluindo name, sku, e description.
    Example: "Celular"

  - `is_associated` (boolean)
    Filtra se o produto está associado ou não ao periférico.
    Example: true

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

  - `unit_ids` (array)
    Lista de IDs das unidades de medida para filtrar produtos.
    Example: [1,2,3]

  - `attribute_id` (number)
    Filtra produtos contendo uma variação com esse ID.
    Example: 123

  - `with_attributes` (boolean)
    Filtro que seleciona produtos que contenham atributos.

## Response 200 fields (application/json):

  - `data` (object)

  - `data.products` (array)
    Representa a lista de produtos.

  - `data.products.id` (integer)
    Código do produto
    Example: 123

  - `data.products.name` (string)
    Nome do produto.
    Example: "Produto Teste"

  - `data.products.sku` (string)
    Código do produto.
    Example: "COD001"

  - `data.products.category` (object)
    Categoria do produto.

  - `data.products.category.id` (integer)
    Identificador único da categoria.
    Example: 1

  - `data.products.category.name` (string)
    Nome da categoria.
    Example: "Nome da categoria"

  - `data.products.option_type` (object)
    Informações sobre as opções do produto.

  - `data.products.option_type.type` (string)
    Tipo de opção do produto.

- simple: Produto sem variações ou grades.
- composition: Produto com variações.
- grid: Produto com grades.
    Enum: "simple", "composition", "grid"

  - `data.products.option_type.count` (integer)
    Quantidade de opções disponíveis para este produto.

Para cada type temos:

- simple: Sempre será 0
- composition: Será a quantidade de variações disponíveis para este produto.
- grid: Será a quantidade de grades disponíveis para este produto.

  - `data.products.image_url` (null,string)
    URL da imagem principal do produto.
    Example: "https://images.connectplug.com.br/4f01c1252eea.jpg"

  - `data.products.unitary_value` (object)
    Preço do produto.

Esse campo pode ser opcional quando o produto for do tipo "Combo".

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

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

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