Modelos

Lista os modelos de veículos

Recupera uma lista paginada de modelos de veículos com filtros e busca opcionais.

Filtros Disponíveis:

  • id: Filtro por UUID v7 com operadores =, !=, IN, NOT IN.
  • name: Filtro de texto com operadores =, !=, CONTAINS, NOT CONTAINS.

Ordenação:

  • name: Ordena pelo nome do modelo (padrão: ascendente).

Filtros adicionais por parâmetro plano: ref_id filtra modelos que possuem preços no período de referência indicado; year filtra modelos disponíveis naquele ano.

get/v1/models

Request

  • Base URL: https://api.fipex.com.br
  • URL: https://api.fipex.com.br/v1/models
  • Auth: none declared

Query parameters

pageinteger

Número da página (mínimo 1). Valores não inteiros ou fora do intervalo retornam 400 ValidationError.

limitinteger

Número de itens por página (1-50). Valores não inteiros ou fora do intervalo retornam 400 ValidationError.

string
OR
string[]
Example:name

Especificação de ordenação. Pode ser fornecida em múltiplos formatos:

Campo único: ?order_by=name (ascendente) ou ?order_by=-name (descendente)

Separado por vírgula: ?order_by=name,-price

Notação de array: ?order_by[]=name&order_by[]=-price

Use o prefixo - para ordem descendente.

qstring

Termo de busca (1-255 caracteres).

make_idstring uuid

Filtra pelo UUID v7 da marca.

fuel_idstring uuid

Filtra pelo UUID v7 do combustível.

type_idstring uuid

Filtra pelo UUID v7 do tipo de veículo.

ref_idstring uuid

UUID v7 do período de referência. Filtra modelos que possuem preços registrados no período indicado.

yearinteger

Ano do veículo (mínimo 1981). Filtra modelos disponíveis naquele ano. Apenas valores inteiros são aceitos neste endpoint.

fieldstring required

Nome do campo para filtrar.

op'=' | '!=' | '>' | '<' | '>=' | '<=' | 'CONTAINS' | 'NOT CONTAINS' | 'IN' | 'NOT IN' | 'TO' | 'IS NULL' required

Operador do filtro.

valuestring

Valor do filtro (o tipo depende do campo e do operador). Para IN/NOT IN/TO use vírgula como separador.

negateboolean

Se deve negar a condição do filtro.

condition'AND' | 'OR'

Condição lógica para combinar com outros filtros.

Filtragem avançada usando notação de array. Cada filtro requer:

  • field: O campo a ser filtrado.
  • op: O operador (veja a seção Operadores de Filtro).
  • value: O valor para filtrar.

Formato: filters[0].field=year&filters[0].op=%3E&filters[0].value=2010

Múltiplos filtros: filters[0].field=year&filters[0].op=%3E&filters[0].value=2010&filters[1].field=price&filters[1].op=TO&filters[1].value=20000,50000

Response

Lista de modelos obtida com sucesso.

Changes