# Lista os lotes da empresa

Retorna uma lista de todos os lotes da empresa.

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

  - `kind` (string)
    Filtra pelo tipo de lote.
    Example: "product"

  - `status` (string)
    Filtra pelo status do lote. Se não informado, serão retornados todos os lotes.
    Enum: "pending", "processing", "finished", "failed"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.bulks` (array)
    Representa a lista de lotes.

  - `data.bulks.id` (integer)
    O ID do lote
    Example: 16

  - `data.bulks.company` (object)
    Dados da empresa.

  - `data.bulks.company.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.bulks.company.name` (string)
    Nome fantasia da empresa.
    Example: "ConnectPlug"

  - `data.bulks.company.company_name` (string,null)
    Razão social da empresa.
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `data.bulks.user` (object)
    Dados do usuário.

  - `data.bulks.user.id` (integer)
    Identificador único do usuário
    Example: 1234

  - `data.bulks.user.name` (string)
    Nome do usuário.
    Example: "John Doe"

  - `data.bulks.user.email` (string)
    E-mail do usuário.
    Example: "john.doe@example.com"

  - `data.bulks.kind` (string)
    O tipo de lote
    Enum: "product", "price-list", "product-app", "product-taxes", "product-scales", "transaction"

  - `data.bulks.status` (string)
    O status do lote
    Enum: "pending", "processing", "completed", "failed"

  - `data.bulks.total_items` (integer)
    O total de itens do lote
    Example: 1

  - `data.bulks.processed_items` (integer)
    O total de itens processados do lote

  - `data.bulks.failed_items` (integer)
    O total de itens falhos do lote

  - `data.bulks.data` (any)
    Os dados do lote que variam conforme o tipo (kind) do lote.

  - `data.bulks.items` (array)
    Os itens do lote

  - `data.bulks.items.id` (integer)
    O ID do item. Este pode ser o ID do produto, do cliente, do fornecedor a depender do tipo de lote.
    Example: 93

  - `data.bulks.items.status` (string)
    O status do item
    Enum: "pending", "processing", "finished", "failed"

  - `data.bulks.items.error` (string,null)
    Caso falhe o processamento, será retornado o erro.

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