# Obtém a lista de produtos

Resgata uma lista produtos de uma lista de preço.

Endpoint: GET /api/v3/price-lists/{priceListId}/items
Version: 3.0.0
Security: OAuth2

## Path parameters:

  - `priceListId` (integer, required)
    ID da lista de preço.

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

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

  - `search_term` (string)
    Filtra pelos nome ou código do produto.
    Example: "Banana"

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

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

## Response 200 fields (application/json):

  - `data` (object)

  - `data.items` (array)
    Representa a lista de produto de uma lista de preço.

  - `data.items.product` (object)
    Informações sobre o produto.

  - `data.items.product.id` (integer, required)
    Identificador único do produto.

Você pode localizar os IDs dos produtos no _endpoint_ de [lista de produtos](#tag/Products/operation/get-products).
    Example: 123

  - `data.items.product.name` (string, required)
    Nome do produto.
    Example: "Banana"

  - `data.items.product.sku` (string, required)
    Código do produto.
    Example: "COD001"

  - `data.items.product.category` (object)
    Categoria do produto.

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

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

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

  - `data.items.product.stock_settings` (object)
    Configurações de estoque do produto.

  - `data.items.product.stock_settings.is_stock_control` (boolean)
    Se este produto possui um controle de estoque.
    Example: true

  - `data.items.product.unitary_value` (object, required)
    Preço do produto.

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

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

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

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

  - `data.items.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.items.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.items.unitary_value` (object)
    Preço do produto nesta lista.

  - `data.items.created_at` (string)
    Data da adição do produto na lista.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.items.updated_at` (string)
    Data da última atualização da lista.
    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