Sign in
Vehicles (Protected)

List Vehicles

List vehicles with pagination and comprehensive filters.

Returns:

  • Matricula (primary or secondary with | separator)
  • Marca, Modelo names
  • Formatted price with VAT indication
  • Calculated profit from movements
  • Days since entry
  • Status flags (consignado, emprestado, seguro, fechado)
  • Alert messages (inspection, ads, etc.)
get/api/vehicles/

Query parameters

pageinteger

Page number

Page number

limitinteger

Items per page

Items per page

idsinteger[]

Re-read exactly these vehicle IDs (bypasses paging, max 100). Used by the stock list to refresh rows edited in another tab.

Re-read exactly these vehicle IDs (bypasses paging, max 100). Used by the stock list to refresh rows edited in another tab.

pv_idsinteger[]

Filter by one or more point of sale IDs

Filter by one or more point of sale IDs

fechadoboolean nullable

Filter by closed status (true=closed, false=open)

Filter by closed status (true=closed, false=open)

estadointeger nullable

Filter by state ID — dbo.EstadoViatura (1=Por Anunciar, 2=Em Stock, 3=Reservado, 4=Vendido, 5=Suspenso)

Filter by state ID — dbo.EstadoViatura (1=Por Anunciar, 2=Em Stock, 3=Reservado, 4=Vendido, 5=Suspenso)

consignadoboolean nullable

Filter consigned vehicles

Filter consigned vehicles

emprestadoboolean nullable

Filter loaned vehicles

Filter loaned vehicles

seguroboolean nullable

Filter vehicles with active insurance

Filter vehicles with active insurance

importadoboolean nullable

Filter imported vehicles

Filter imported vehicles

section_idinteger nullable

Filter by Integrazu section ID

Filter by Integrazu section ID

marca_idinteger nullable

Filter by brand ID

Filter by brand ID

modelo_idinteger nullable

Filter by model ID

Filter by model ID

combustivel_idinteger nullable

Filter by fuel type ID

Filter by fuel type ID

caixa_idinteger nullable

Filter by transmission ID

Filter by transmission ID

second_key_statusstring nullable

Filter by second-key status: sim, não, requisitado

Filter by second-key status: sim, não, requisitado

fornecedor_idinteger nullable

Filter by supplier (Cliente ID referenced by Viatura.Fornece)

Filter by supplier (Cliente ID referenced by Viatura.Fornece)

preco_minnumber nullable

Minimum price

Minimum price

preco_maxnumber nullable

Maximum price

Maximum price

ano_mininteger nullable

Minimum year (DataMat)

Minimum year (DataMat)

ano_maxinteger nullable

Maximum year (DataMat)

Maximum year (DataMat)

km_mininteger nullable

Minimum kilometers

Minimum kilometers

km_maxinteger nullable

Maximum kilometers

Maximum kilometers

has_anuncioboolean nullable

Filter by ad status (true=has ad, false=no ad)

Filter by ad status (true=has ad, false=no ad)

renew_inactiveboolean nullable

Filter vehicles with active exports but auto-renew disabled

Filter vehicles with active exports but auto-renew disabled

only_retomasboolean nullable

Show only trade-in (retoma) vehicles

Show only trade-in (retoma) vehicles

sem_inspecaoboolean nullable

Filter by inspection validity (true=no valid inspection: overdue or not filled, false=has valid inspection)

Filter by inspection validity (true=no valid inspection: overdue or not filled, false=has valid inspection)

iuc_caducadoboolean nullable

Filter by IUC status (true=missed, unsettled IUC deadline; false=IUC in order). 100%-electric vehicles are exempt and never match.

Filter by IUC status (true=missed, unsettled IUC deadline; false=IUC in order). 100%-electric vehicles are exempt and never match.

localizacaointeger nullable

Filter by location: 0=parque, 1=transporte

Filter by location: 0=parque, 1=transporte

prep_statusstring nullable

Filter by prep status: nao_iniciada, em_curso, concluida

Filter by prep status: nao_iniciada, em_curso, concluida

pronto_entregaboolean nullable

Filter by commercial readiness

Filter by commercial readiness

buffer_blockedboolean nullable

Filter by sale block status

Filter by sale block status

exclude_buffer_blockedboolean nullable

Exclude buffer-blocked vehicles

Exclude buffer-blocked vehicles

current_park_location_idsinteger[]

Filter by one or more current park location IDs

Filter by one or more current park location IDs

searchstring nullable

Search by plate, brand, or model

Search by plate, brand, or model

sort_bystring nullable

Sort field: dataentr, preco, km, marca

Sort field: dataentr, preco, km, marca

sort_orderstring nullable

Sort order: asc or desc

Sort order: asc or desc

Headers

x-api-tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/vehicles/:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes