# Lista de estoques

Retorna lista de estoques.

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

  - `name` (string)
    Filtra pelo nome do estoque.
    Example: "estoque padão"

  - `stock_location` (string)
    Filtra pelo tipo de propriedade dos produtos.
Exemplo:
  - own_local O estoque está localizado na empresa.
  - third_party_from_customer Estoque está localizado na empresa do Cliente. Exemplo: Cliente utiliza equipamentos da empresa por possuir um contrato de aluguel.
  - third_party_from_supplier Estoque está localizado na empresa do fornecedor. Exemplo: Fornecedor fica em seu estoque com equipamentos da empresa enquanto presta manutenção.
    Enum: "own_local", "third_party_from_customer", "third_party_from_supplier"

  - `stock_property_type` (string)
    Filtra pelo tipo de propriedade dos produtos.
Exemplo:
  - own_products Estoque armazena produtos da própria empresa
  - third_party_from_customer Estoque armazena produto de Clientes. Exemplo: Empresa realiza manutenção em equipamentos de clientes.
  - third_party_from_supplier Estoque armazena produtos de fornecedores. Exemplo: Empresa aluga de um fornecedor equipamentos, como impressoras.
    Enum: "own_products", "third_party_from_customer", "third_party_from_supplier"

  - `stocks_id` (string)
    Filtra pelos IDs dos estoques. 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).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.stocks` (array)
    Representa a lista de estoques

  - `data.stocks.id` (integer)
    Identificador único do estoque na CPlug.
    Example: 1

  - `data.stocks.name` (string)
    Nome do estoque.
    Example: "Estoque Padrão"

  - `data.stocks.stock_location` (any)
    Tipo do local de armazenamento:

- own_local O estoque está localizado na empresa.
- third_party_from_customer Estoque está localizado na empresa do Cliente. Exemplo: Cliente utiliza equipamentos da empresa por possuir um contrato de aluguel.
- third_party_from_supplier Estoque está localizado na empresa do fornecedor. Exemplo: Fornecedor fica em seu estoque com equipamentos da empresa enquanto presta manutenção.
    Enum: "own_local", "third_party_from_customer", "third_party_from_supplier"

  - `data.stocks.stock_property_type` (any)
    Tipo de propriedade do produto:

- own_products Estoque armazena produtos da própria empresa
- third_party_from_customer Estoque armazena produto de Clientes. Exemplo: Empresa realiza manutenção em equipamentos de clientes.
- third_party_from_supplier Estoque armazena produtos de fornecedores. Exemplo: Empresa aluga de um fornecedor equipamentos, como impressoras.
    Enum: "own_products", "third_party_from_customer", "third_party_from_supplier"

  - `data.stocks.is_default_company_sale` (boolean)
    Indica se este estoque é o estoque padrão de vendas para alguma empresa.

  - `data.stocks.is_default_company_purchase` (boolean)
    Indica se este estoque é o estoque padrão de compras para alguma empresa.

  - `data.stocks.companies` (array)
    Lista de empresas que permite visualizar.

  - `data.stocks.companies.id` (integer)
    Id único da empresa
    Example: 123

  - `data.stocks.companies.name` (string)
    Nome fantasia da empresa
    Example: "CPlug"

  - `data.stocks.companies.company_name` (string)
    Razão social da empresa
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `data.stocks.deleted` (boolean)
    Indica se o estoque foi apagado ou não.

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

  - `data.stocks.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