# Lista os inventários

Lista os inventários de um estoque.

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

## Query parameters:

  - `name` (string)
    Filtra pelo nome do inventário.
    Example: "Inventário 1"

  - `is_finalized` (boolean)
    Filtra pelo status do inventário.
    Example: true

  - `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.inventories` (array)
    Representa a lista dos inventários do estoque.

  - `data.inventories.id` (integer)
    Identificador único do inventário de estoque na CPlug.
    Example: 1

  - `data.inventories.name` (string)
    Nome do inventário de estoque.
    Example: "Inventário 1"

  - `data.inventories.is_finalized` (boolean)
    Indica se o inventário foi finalizado.

  - `data.inventories.start_date` (string)
    Data de início do inventário.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.inventories.end_date` (string)
    Data de fim do inventário.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.inventories.created_at` (string)
    Data da criação do inventário.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.inventories.updated_at` (string)
    Data da atualização do inventário.
    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