# Cria nova categoria

Cria nova categoria de produtos.

Endpoint: POST /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

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

## Request fields (application/json):

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

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

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

  - `icon_id` (integer)
    Código do ícone retornado pelo endpoint [listagem de ícones](#tag/Icons/operation/get-icons)
    Example: 1

  - `parent_id` (integer)
    Código da categoria pai a qual esta categoria irá fazer parte

OBS: É possível criar no máximo 3 subcategorias para uma categoria raiz
    Example: 1

  - `companies` (array)
    Id da Empresa (Company). 

Por padrão é considerado a empresa informado no header em CPlug-Company-Id.

Você pode localizar os IDs das empresas no _endpoint_ de [listagem de empresas](#tag/Companies/operation/get-companies).
    Example: [1]

## Response 201 fields (application/json):

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `subcategories.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

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