# Lista os produtos de um estoque

Lista os produtos de um estoque.

Endpoint: GET /api/v3/stocks/{stockId}/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:

  - `stockId` (integer, required)
    ID do estoque.

## Query parameters:

  - `term` (string)
    Busca pelo termo. Nome, código, ou código de barras do produto e etc.
    Example: "Produto simples"

  - `order_by_field` (string)
    Orderna pelo campo.
Exemplo:
  - code Código do produto.
  - name Nome do produto.
    Enum: "code", "name"

  - `order_by_type` (string)
    Tipo de ordenação.
Exemplo:
  - asc Ascendente
  - desc Descendente
    Enum: "asc", "desc"

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

  - `amount_in_stock` (string)
    Filtra pela quantidade em estoque.

- all Todas as quantidades.
- positive Quantidades positivas.
- negative Quantidades negativas.
- zero Quantidades zero, sem movimentações.
    Enum: "all", "positive", "negative", "zero"

  - `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.stock_products` (array)
    Representa a lista de produtos no estoque

  - `data.stock_products.product` (object)
    Informações de produto que está no estoque.

  - `data.stock_products.product.id` (integer)
    Identificador único do produto na CPlug.
    Example: 1

  - `data.stock_products.product.sku` (string)
    Código do produto.
    Example: "A747"

  - `data.stock_products.product.name` (string)
    Nome do produto.
    Example: "Produto simples"

  - `data.stock_products.product.unit_of_measure` (object)
    Unidade de medida do produto.

  - `data.stock_products.product.unit_of_measure.abbreviation` (string)
    Símbolo da unidade de medida.
    Example: "Un"

  - `data.stock_products.product.unit_of_measure.precision` (integer)
    Precisão da unidade de medida.
    Example: 2

  - `data.stock_products.product.created_at` (string)
    Data da criação do produto.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.stock_products.product.updated_at` (string)
    Data da atualização do produto.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.stock_products.amount_in_stock` (number)
    Indica a quantidade do produto no estoque.
    Example: 10

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

  - `data.stock_products.updated_at` (string)
    Data da atualização do estoque.
    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