# Lista de unidades de medidas

Retorna lista das unidades de medidas disponíveis.

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

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

  - `name` (string)
    Filtra pelo nome da unidade de medida.
    Example: "kilos"

  - `abbreviation` (string)
    Filtra pela sigla da unidade de medida. Veja a tabela com todas as referências em Tabela de Unidades de medida.
    Example: "kg"

  - `search` (string)
    Filtra pelo nome ou pela sigla da unidade de medida. Veja a tabela com todas as referências em Tabela de Unidades de medida.
    Example: "metro"

  - `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.units` (array)
    Representa a lista das unidades de medidas.

  - `data.units.id` (integer, required)
    Identificador único da unidade de medida.
    Example: 123

  - `data.units.name` (string, required)
    Nome da unidade de medida, exemplo "quilos".
    Example: "Quilos"

  - `data.units.abbreviation` (string, required)
    A abreviatura da unidade, veja a tabela com todas as referências em [Tabela de Unidades de medida](#section/Conhecimento-Geral/Tabelas)
    Example: "kg"

  - `data.units.precision` (integer, required)
    Um número inteiro entre 0 e 6 que representa o número máximo de posições permitidas após o decimal em quantidades medidas com esta unidade.
Por exemplo:
  - se a precisão for 0, a quantidade pode ser 1, 2, 3, etc.
  - se a precisão for 1, a quantidade pode ser 0.1, 0.2, 0.3, etc.
  - se a precisão for 2, a quantidade pode ser 0.01, 0.02, 0.03, etc.
    Example: 2

  - `data.units.product_count` (integer)
    Número de produtos que utilizam esta unidade de medida
    Example: 4

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

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