Skip to Content
BannersInventoryCarsArchiveBanner

InventoryCarsArchiveBanner

Archive/listing of inventory cars, optionally with filters.

Includes the common banner props.

inventory cars archive preview

Props

id
string
required

CMS id.

hideFilters
boolean
required

If true, filters UI is hidden.

query
string
required

Backend query string used to fetch the listing.

URL filtering behavior

The inventory archive persists interactive filter state in the URL.

  1. With hideFilters = false, URL filters have priority over CMS defaults.
  2. CMS defaults (query) are used only when URL contains no filter state.
  3. With hideFilters = true, URL filter state is ignored and CMS defaults are enforced.

CMS price mode default

Inventory car archives support a CMS-only price display default. In the banner’s Query field, add a query-param row with the key PRICE_MODE and the value NET or GROSS.

PRICE_MODE=NET PRICE_MODE=GROSS

The value is case-insensitive and controls the initial price mode used for the archive request, price filtering, sorting by price and rendered vehicle prices. It is not an interactive inventory filter and should not be added to the URL filter state.

The user can still switch between net and gross prices with the available price-mode switch. That user choice then replaces the CMS default for the current interaction. If PRICE_MODE is omitted, the shared default is gross.

Supported query params

The query prop accepts a standard URL query string. Multiple params are combined via &. Repeating the same key applies a list filter.

ID

Filters by inventory car id.

  • Key: ID
  • Type: string (repeatable)
  • Note: If at least one ID is present, all other archive filters are ignored. sort, order, and page still apply.

Examples:

ID=car_123 ID=car_123&ID=car_456

Brand

Filters by brand.

  • Key: BRAND
  • Type: string (repeatable)

Examples:

BRAND=BMW BRAND=MINI BRAND=Volkswagen BRAND=BMW&BRAND=MINI

Model

Filters by car model.

  • Key: MODEL
  • Type: string (repeatable)

Examples:

MODEL=3 Series MODEL=A4 MODEL=Model 3 MODEL=3 Series&MODEL=X5

Motor

Filters by cars motor type.

  • Key: MOTOR
  • Type: number (repeatable)
  • Allowed values (DriveType):
1 AllWheelDrive 2 FrontWheelDrive 3 RearWheelDrive

Examples:

MOTOR=1 MOTOR=2&MOTOR=3

Gear

Filters by cars gear type.

  • Key: GEAR
  • Type: number (repeatable)
  • Allowed values (TransmissionType):
0 Automatic 1 Manual 2 SemiAutomatic 3 CVT

Examples:

GEAR=0 GEAR=1&GEAR=3

Fuel

Filters by fuel type.

  • Key: FUEL
  • Type: number (repeatable)
  • Allowed values (FuelType):
0 Other 1 Petrol 2 Diesel 3 LPG 4 CNG 6 Electric 7 Hybrid 8 Hydrogen 9 Ethanol 10 HybridDiesel 11 BiFuel

Examples:

FUEL=6 FUEL=1&FUEL=7

Location

Filters by CMS location id.

  • Key: LOCATION
  • Type: string (repeatable)
  • UI note: This filter is available from the All filters dialog only.

Examples:

LOCATION=loc_123 LOCATION=loc_123&LOCATION=loc_456

Used car seal

Filters by the indexed inventory seal code sourced from the eAutoseller dq field.

  • Key: USED_CAR_SEAL
  • Type: number (repeatable)
  • UI note: This filter is available from the All filters dialog only.
  • Reference: See the official eAutoseller seal list at used-car-seals_de.html .
  • Data note: Only inventory rows already written with the new indexed seal column are matched. Older untouched rows may be missing until they are updated by inventory sync.

Known values:

1 VW PKW Zertifizierte Gebrauchtwagen 2 Audi GW-Plus 3 BMW Premium 5 VW NFZ Zertifizierte Gebrauchtwagen 6 MB Junge Sterne 7 Citroen Select 8 Mini Next 9 Renault 7Sterne 10 Ferrari Approved 13 Porsche Approved 14 SEAT "Das Weltauto" 15 Volvo Selekt 17 Peugeot 18 Opel zertifizierte Gebrauchtwagen 22 Hyundai Promise 26 jung@smart 36 MB Junge Sterne Transporter 37 Jaguar Approved 38 Land Rover Approved 41 Nissan Intelligent Choice 43 Skoda Plus Zertifizierte Gebrauchtwagen 44 DS Zertifizierte Gerbauchtwagen 45 Honda Quality Plus 46 KIA Zertifizierte Gerbauchtwagen 47 Ford Premium 71 Lamborghini Certified Pre-Owned 72 Aston Martin Timeless 73 McLaren Qualified 76 Bentley Pre-Owned 77 Spoticar 83 Cupra Approved 85 Toyota Geprüfte Gebrauchtwagen

Examples:

USED_CAR_SEAL=3 USED_CAR_SEAL=3&USED_CAR_SEAL=8

Paintwork

Filters by cars paintwork.

  • Key: PWORK
  • Type: string (repeatable)
  • Matching rule: car passes if colors overlaps the provided list.

Examples:

PWORK=Black PWORK=Black&PWORK=White

Condition

Filters by condition mode.

  • Key: CONDITION
  • Type: string (single)

Allowed values:

DEMONSTRATOR NEW USED

Behavior:

  • DEMONSTRATOR: line.isDemonstrator = true
  • NEW: isNew = true and line.isDemonstrator = false
  • USED: isNew = false and line.isDemonstrator = false

Examples:

CONDITION=NEW CONDITION=DEMONSTRATOR

Payment

Accepted but ignored server-side (currently no effect).

  • Key: PAYMENT
  • Type: string (single)

Example values:

BUY FINANCE LEASE

Examples:

PAYMENT=BUY PAYMENT=FINANCE PAYMENT=LEASE

Price min / Price max

Filters by cars offer price.

  • Keys: PRICE_MIN, PRICE_MAX
  • Type: number (single)
  • Unit: EUR (UI sends euros; DB stores cents)

Examples:

PRICE_MIN=15000 PRICE_MAX=40000 PRICE_MIN=15000&PRICE_MAX=40000

Km min / Km max

Filters by cars kilometers.

  • Keys: KM_MIN, KM_MAX
  • Type: number (single)
  • Unit: kilometers

Examples:

KM_MIN=0 KM_MAX=50000 KM_MIN=10000&KM_MAX=60000

Registration min / Registration max

Filters by cars first registration.

  • Keys: IR_MIN, IR_MAX
  • Type: string (single)
  • Format: YYYY-MM-DD

Examples:

IR_MIN=2021-01-01 IR_MAX=2023-12-31 IR_MIN=2021-01-01&IR_MAX=2023-12-31

Vehicle class

Filters by vehice class.

  • Key: VCLASS
  • Type: string (repeatable)

Allowed values (VehicleClass):

AgriculturalVehicle Bus Car ConstructionMachine EBike ForkliftTruck Motorbike Motorhome SemiTrailer SemiTrailerTruck Trailer TruckOver7500 VanUpTo7500

Examples:

VCLASS=Car VCLASS=Car&VCLASS=Motorbike

Car type

Filters by car type.

  • Key: CAR_TYPE
  • Type: string (repeatable)
  • Note: In the frontend this filter is only shown after a VCLASS selection, because the available car types depend on the chosen vehicle class.

Examples:

CAR_TYPE=SUV CAR_TYPE=Sedan CAR_TYPE=SUV&CAR_TYPE=Coupe

CO2 class

Filters by the rendered CO2 efficiency class.

  • Key: CO2_CLASS
  • Type: string (single)
  • Allowed values:
A B C D E F G
  • Matching rule: For plug-in hybrids the weighted combined WLTP class is used. For all other inventory cars the regular WLTP class is used.

Examples:

CO2_CLASS=A CO2_CLASS=C

CO2 emission min / CO2 emission max

Filters by CO2 emissions in g/km.

  • Keys: CO2_EMISSION_MIN, CO2_EMISSION_MAX
  • Type: number (single)
  • Unit: g/km
  • Matching rule: For plug-in hybrids the weighted combined WLTP emission is used. For all other inventory cars the regular WLTP emission is used.

Examples:

CO2_EMISSION_MIN=95 CO2_EMISSION_MAX=180 CO2_EMISSION_MIN=95&CO2_EMISSION_MAX=180

Combined examples

BRAND=BMW&MODEL=3 Series&CONDITION=USED&PRICE_MAX=30000&KM_MAX=60000
VCLASS=Car&FUEL=6&GEAR=0&MOTOR=2&PWORK=Black&IR_MIN=2022-01-01
VCLASS=Car&CO2_CLASS=A&CO2_EMISSION_MAX=120&CAR_TYPE=SUV
LOCATION=loc_123&USED_CAR_SEAL=3&CONDITION=USED

Sort options

Use the serialized enum values from @haendlerapp/types/src/enums/SortOption.ts and OrderOption.ts when configuring CMS query params.

Creation Date

  • Neueste sort=CREATED_AT&order=DESC

  • Älteste sort=CREATED_AT&order=ASC

Price

  • Preis: Aufsteigend sort=OPRICE&order=ASC

  • Preis: Absteigend sort=OPRICE&order=DESC

Mileage

  • Kilometer: Aufsteigend sort=ODM_KM&order=ASC

  • Kilometer: Absteigend sort=ODM_KM&order=DESC

Brand

  • Marke (A–Z) sort=MAKE&order=ASC

  • Marke (Z–A) sort=MAKE&order=DESC

Model

  • Modell (A–Z) sort=MODEL&order=ASC

  • Modell (Z–A) sort=MODEL&order=DESC

const banner: InventoryCarsArchiveBanner = { typename: BannerTypename.InventoryCarsArchiveBanner, id: 'b_123', title: 'Vehicles', titleTag: 'h2', titleAlign: 'left', cssId: null, cssClasses: null, hideFilters: false, query: 'BRAND=BMW&FUEL=1&CO2_CLASS=A&PRICE_MAX=40000' };
Last updated on