# Lista de categorias

Retorna lista de categorias de produtos disponíveis.

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

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

  - `name` (string)
    Filtra pelo nome da categoria.
    Example: "pizzas"

  - `code` (string)
    Filtra pelo código da categoria.
    Example: "PZ"

  - `status` (string)
    Filtra por status.
    Enum: "available", "unavailable"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `with_parents` (boolean)
    Ao informar true e combinado com as buscas por name ou code retorna a hierarquia das categorias pai caso a busca encontre categorias de níveis inferiores (filhas, netas...).

  - `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.categories` (array)
    Representa a lista de Categorias

  - `data.categories.id` (integer, required)
    Identificador único da categoria.
    Example: 123

  - `data.categories.name` (string, required)
    Nome da categoria.
    Example: "Categoria"

  - `data.categories.code` (string)
    Código (SKU) da categoria.
    Example: "ABC-123"

  - `data.categories.status` (string)
    Status da categoria.
    Enum: "available", "unavailable"

  - `data.categories.product_count` (integer)
    Total de produtos que pertencem a esta categoria
    Example: 10

  - `data.categories.icon` (string)
    Link para a imagem do ícone da categoria
    Example: "929091.png"

  - `data.categories.order` (integer)
    Posição em que a categoria ocupa na lista
    Example: 1

  - `data.categories.subcategories` (array)
    Lista de subcategorias da categoria pai

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

  - `data.categories.subcategories.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

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

  - `data.categories.subcategories.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `data.categories.subcategories.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

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