Enforced Vehicle Request Parameters

Diese Referenz dokumentiert alle Parameter, mit denen sich die Fahrzeugabfrage filtern lässt — also das, was Sie in Shop und Widgets als erzwungenen oder als vorbelegten Filter setzen. Wo Sie die Parameter eintragen, steht unter Wie kann ich ausgewählte Fahrzeuge anzeigen lassen?.

Schreibweise

• Ein Filter besteht aus parameter=wert. Mehrere Filter werden mit & verbunden — ohne führendes & am Anfang: manufacturer=BMW&usedConditionTypes=NEUWAGEN.
• Kommaseparierte Parameter akzeptieren mehrere Werte: carTypes=PKW,KOMBI. Sie wirken als ODER-Filter — ein Fahrzeug muss einen der Werte erfüllen.
• Die zulässigen Werte der Auswahllisten stehen unter Erlaubte Werte der Auswahllisten.
• Leere Werte werden ignoriert.

Paare aus Singular und Plural

Einige Filter gibt es doppelt — etwa CarType und CarTypes. Die Singular-Form nimmt genau einen Wert, die Plural-Form mehrere. Die erlaubten Werte sind identisch.

Fahrzeugart, Aufbau und Maße

Parameter	Beschreibung	Beispiel
CarType / CarTypes	Fahrzeug-Art — erlaubte Werte	carTypes=PKW,ZWEIRAD
VehicleSubTypes	Fahrzeug-Untertypen — erlaubte Werte	vehicleSubTypes=Cabrio,Limousine
MinDoors / MaxDoors	Türanzahl	minDoors=3&maxDoors=5
SeatsMin / SeatsMax	Sitzanzahl	seatsMin=2&seatsMax=5
SleepingPlacesMin / SleepingPlacesMax	Schlafplätze (Wohnmobile)	sleepingPlacesMin=2
LengthMin / LengthMax	Fahrzeuglänge	lengthMin=4000&lengthMax=5000
TotalWeightMin / TotalWeightMax	Gesamtgewicht	totalWeightMax=3500

Motor und Antrieb

Parameter	Beschreibung	Beispiel
DriveTypes	Antriebsarten — erlaubte Werte	driveTypes=ElectricMotor
FuelType / FuelTypes	Treibstoff-Arten — erlaubte Werte	fuelTypes=BENZIN,DIESEL
GearBoxType / GearBoxTypes	Getriebe-Arten — erlaubte Werte	gearBoxTypes=AUTOMATIK
EngineCapacityMin / EngineCapacityMax	Hubraum	engineCapacityMin=1000
MinEngineCylinders / MaxEngineCylinders	Zylinderanzahl	maxEngineCylinders=8
MinEnginePower / MaxEnginePower	Motorleistung (Vergleich mit PS-Rundung, Faktor 1.35962)	minEnginePower=70

Zustand, Nutzung und Verfügbarkeit

Parameter	Beschreibung	Beispiel
UsedConditionTypes	Zustandsarten — erlaubte Werte	usedConditionTypes=NEUWAGEN
PreviousUsageTypes	Vorherige Nutzungsarten — erlaubte Werte	previousUsageTypes=FIRMENWAGEN
MinMileAge / MaxMileAge	Kilometerstand	maxMileAge=100000
MinInitialRegistration / MaxInitialRegistration	Erstzulassung (ISO 8601). Bei MinInitialRegistration werden Fahrzeuge ohne Erstzulassung eingeschlossen.	minInitialRegistration=2020-01-01
IsAvailableInstantly	Nur sofort verfügbare Fahrzeuge. Greift nur bei true.	isAvailableInstantly=true
HasImages	Nur Fahrzeuge mit mindestens ImagesToCrop Bildern. Greift nur bei true.	hasImages=true
HasConditionDocumentUrls	Nur Fahrzeuge mit hinterlegten Zustandsdokumenten	hasConditionDocumentUrls=true
HasEnVkvLabelDocumentUrl	Nur Fahrzeuge mit hochgeladenem EnVKV-Label	hasEnVkvLabelDocumentUrl=true
IsARecommendation	Empfehlung laut Mobile CSV (Feld W/22). Greift nur bei true.	isARecommendation=true
ValidForSaleTypes	Verkaufsstatus: Valid (erfüllt alle Pflichtangaben) oder Invalid (vom System ausgeschlossen, siehe Fahrzeuge nicht online)	validForSaleTypes=Valid

Preis, Finanzierung und Leasing

Parameter	Beschreibung	Beispiel
MinPrice / MaxPrice	Preis (brutto, wenn IsVatDeductable=true)	minPrice=10000&maxPrice=50000
IsVatDeductable	MwSt. ausweisbar	isVatDeductable=true
MonthlyFinancingRateExampleMin / MonthlyFinancingRateExampleMax	Monatliche Finanzierungsrate (Beispielrate)	monthlyFinancingRateExampleMax=400
MonthlyLeasingRateExampleMin / MonthlyLeasingRateExampleMax	Monatliche Leasingrate (Beispielrate)	monthlyLeasingRateExampleMax=500
HasInitialLeasingInstallment	Nur Fahrzeuge mit hinterlegter Leasingrate	hasInitialLeasingInstallment=true

Hersteller, Modell, Farben und Ausstattung

Parameter	Beschreibung	Beispiel
Manufacturer	Hersteller (Präfix-Abgleich, Groß-/Kleinschreibung egal)	manufacturer=VW
Model / Models	Modell (exakter Abgleich, Groß-/Kleinschreibung egal)	models=GOLF,POLO,TIGUAN
VarnishBaseColorType / VarnishBaseColorTypes	Lack-Grundfarben — erlaubte Werte	varnishBaseColorTypes=BLACK,WHITE
InteriorBaseColorType / InteriorBaseColorTypes	Innenraum-Grundfarben — erlaubte Werte	interiorBaseColorTypes=BLACK,GRAY
InteriorTypes	Innenausstattungsarten — erlaubte Werte	interiorTypes=LEDER,STOFF
EquipmentIds	Ausstattungs-IDs — UND-Filter, siehe Hinweis unten	equipmentIds=1234,5678

EquipmentIds verhält sich anders als die übrigen Listenfilter

Bei allen anderen kommaseparierten Parametern genügt einer der angegebenen Werte. Bei EquipmentIds muss das Fahrzeug alle angegebenen Ausstattungs-IDs besitzen. Das Gegenstück ExcludedEquipmentIds schließt dagegen schon aus, wenn eine der IDs zutrifft.

Einzelne Fahrzeuge, Standorte und Kampagnen

Parameter	Beschreibung	Beispiel
Identifiers	FIN oder interne Fahrzeugnummer, Mischung erlaubt (ODER-Filter)	identifiers=WVWZZZ1KZAW123456,2220951
InternalIds	Interne Fahrzeugnummern	internalIds=2220951,1428541
CarIds	Fahrzeug-IDs des Shop-Systems (GUIDs)	carIds=3f2a9c14-...,9b7c0d22-...
VehicleDealerLocationIds	Händler-Standort-IDs (GUIDs)	vehicleDealerLocationIds=00000000-0000-0000-0000-000000000000
MarketingCampaigns	Marketing-Kampagnen (Kampagnen-Codes)	marketingCampaigns=CAMPAIGN_A,CAMPAIGN_B
QualitySeals	Qualitätssiegel (Siegel-Codes)	qualitySeals=SEAL_A,SEAL_B

Suche und Sortierung

Parameter	Beschreibung	Beispiel
SearchTerm	Freitext-Suchbegriff	searchTerm=Pro Performance
OrderBy	Sortierung, jeweils mit ASC oder DESC — erlaubte Werte	orderBy=INITIALREGISTRATION DESC

Erlaubte Werte der Auswahllisten

CarTypes

ALKOVEN · ALLE · ANDERE · ANHAENGER · CABRIO · INTEGRIERT · KASTENWAGEN · KLEINWAGEN · KOMBI · LIMOUSINE · NUTZFAHRZEUG · PKW · SPORTWAGEN · SUV · TEILINTEGRIERT · VAN · WOHNMOBIL · ZWEIRAD

DriveTypes

CombustionEngine · ElectricMotor · FuelCell · Other · PlugInHybrid

FuelTypes

ANDERE · AUTOGAS · BENZIN · BI_FUEL · DIESEL · ELEKTRO · ERDGAS · ETHANOL · HYBRID_BENZIN · HYBRID_DIESEL · WASSERSTOFF

GearBoxTypes

ANDERE · AUTOMATIK · HALB_AUTOMATIK · MANUELL

UsedConditionTypes

GEBRAUCHTWAGEN · JAHRESWAGEN · NEUWAGEN · OLDTIMER · TAGESZULASSUNG · VORFÜHRWAGEN · YOUNGTIMER

PreviousUsageTypes

DE_MIETWAGEN · DIENSTWAGEN · EU_FAHRZEUG · EU_MIETWAGEN · EUROMOBIL · FAHRSCHULE · FIRMENWAGEN · JAHRESWAGEN · KOMMUNAL · LEASING · MIETWAGEN · NONE · PRIVAT · RESTRIKTIONSFAHRZEUG · TAXI · VORFUEHRWAGEN · WA_LEASING · WA_RUECKLAEUFER · WERKDIENSTWAGEN_AUDI · WERKDIENSTWAGEN_SEAT · WERKDIENSTWAGEN_SKODA · WERKDIENSTWAGEN_VW · WERKSWAGEN

InteriorTypes

ALCANTARA · ANDERE · KUNSTLEDER · LEDER · NONE · STOFF · TEILLEDER · VELOUR

Farben

Gilt gleichermaßen für VarnishBaseColorTypes (Lack) und InteriorBaseColorTypes (Innenraum):

BEIGE · BLACK · BLUE · BROWN · GOLD · GRAY · GREEN · ORANGE · OTHER · RED · SILVER · VIOLET · WHITE · YELLOW

OrderBy

CREATEDAT · INITIALFINANCINGINSTALLMENT · INITIALLEASINGINSTALLMENT · INITIALREGISTRATION · MILEAGE · PRICE

VehicleSubTypes

Abrollkipper · Abschleppwagen · Absetzkipper · Alkoven · Andere · AnhaengerBoote · AnhaengerMotorrad · AnhaengerNutzfahrzeuge · AnhaengerPferde · AnhaengerPkw · Autokran · Autotransporter · AutoTransporterSattelAuflieger · Cabrio · ChopperCruiser · DirtBike · Dreiseitenkipper · EnduroReiseenduro · Fahrgestell · Geldtransporter · GespannSeitenwagen · Getraenke · Glastransporter · Hubarbeitsbühne · Integriert · Kastenwagen · Kastenwagen_Nutzfahrzeug · Kastenwagen_Wohnmobil · KastenwagenHoch · KastenwagenHochLang · KastenwagenLang · Kehrmaschine · Kipper · KleinLeichtkraftrad · Kleinwagen · Koffer · Kombi · KombiKleinbusBis9Sitzer · Kuehlkastenwagen · Kuehlkoffer · Limousine · Mobilheim · MofaMokickMoped · Motorrad · Muellwagen · NakedBike · PkwAndere · PocketBike · Pritsche · PritschePlane · Quad · RallyeCross · Rennsport · Rettungswagen · RollerScooter · Saug_Druckwagen · SportlerSupersportler · Sporttourer · Sportwagen · StandardSattelzugmaschine · Streetfighter · SuperMoto · Suv · Tankaufbau · Teilintegrierter · TierPferdetransporter · Tourer · TransporterAndere · Trike · Van · Verkaufaufbau · Wechselfahrgestell · Wohnkabine · WohnmobilAndere · WohnmobilPickup · Wohnwagen · ZweiradAndere

Exkludierende Parameter

Ergänzend zu den inkludierenden Filtern lässt sich jeder Listen- bzw. Mengenfilter auch negieren. So blenden Sie einzelne Fahrzeuge oder ganze Gruppen gezielt aus einer bereits vorgefilterten Auswahl aus — zum Beispiel einzelne Fahrzeuge anhand ihrer Fahrzeugnummer.

Ein typischer Fall: Ihr Shop oder Widget ist auf bestimmte Marken, Modelle oder Zustandsarten vorgefiltert, einzelne Fahrzeuge sollen aber dennoch nicht erscheinen. Dafür gibt es zu jedem inkludierenden Filter ein Excluded*-Gegenstück.

Jeder Excluded*-Parameter spiegelt seinen inkludierenden Gegenpart 1:1: gleiche akzeptierte Werte, gleiche Groß-/Kleinschreibung und Normalisierung. Alle sind kommasepariert — Ausnahme ist ExcludedManufacturer, das genau einen Hersteller aufnimmt. Inkludierende und exkludierende Parameter lassen sich in derselben Abfrage kombinieren; leere Werte werden ignoriert.

Wichtig

Trifft auf ein Fahrzeug gleichzeitig ein inkludierendes und ein exkludierendes Kriterium zu, wird das Fahrzeug ausgeschlossen — der Ausschluss hat immer Vorrang.

Parameter	Schließt aus	Spiegelt
ExcludedIdentifiers	Fahrzeuge mit passender FIN oder interner Fahrzeugnummer	Identifiers
ExcludedInternalIds	Fahrzeuge mit passender interner Fahrzeugnummer	InternalIds
ExcludedCarIds	Fahrzeuge mit passender ID (GUID)	CarIds
ExcludedManufacturer	Hersteller (Präfix-Abgleich)	Manufacturer
ExcludedModels	angegebene Modelle	Models
ExcludedCarTypes	Fahrzeug-Arten	CarTypes
ExcludedVehicleSubTypes	Fahrzeuge mit mindestens einem der Untertypen	VehicleSubTypes
ExcludedUsedConditionTypes	Zustandsarten	UsedConditionTypes
ExcludedPreviousUsageTypes	vorherige Nutzungsarten	PreviousUsageTypes
ExcludedDriveTypes	Antriebsarten	DriveTypes
ExcludedFuelTypes	Treibstoff-Arten	FuelTypes
ExcludedGearBoxTypes	Getriebe-Arten	GearBoxTypes
ExcludedInteriorTypes	Innenausstattungsarten	InteriorTypes
ExcludedEquipmentIds	Fahrzeuge mit mindestens einer der Ausstattungs-IDs	EquipmentIds
ExcludedVarnishBaseColorTypes	Lack-Grundfarben	VarnishBaseColorTypes
ExcludedInteriorBaseColorTypes	Innenraum-Grundfarben	InteriorBaseColorTypes
ExcludedVehicleDealerLocationIds	Händler-Standort-IDs	VehicleDealerLocationIds
ExcludedValidForSaleTypes	Verkaufsstatus-Arten	ValidForSaleTypes
ExcludedQualitySeals	Qualitätssiegel	QualitySeals
ExcludedMarketingCampaigns	Marketing-Kampagnen	MarketingCampaigns

Beispiele: excludedIdentifiers=WBA12345,STOCK-0099 · excludedCarTypes=ZWEIRAD,ANHAENGER · excludedFuelTypes=DIESEL

Ausschluss per Fahrzeugnummer

ExcludedIdentifiers akzeptiert sowohl die FIN als auch die interne Fahrzeugnummer und deckt damit den häufigsten Anwendungsfall aus dem Shop- und Widget-Alltag direkt ab.

Beispiel

Angenommen, Ihr Shop ist auf gebrauchte BMW vorgefiltert, zwei einzelne Fahrzeuge sollen aber dauerhaft nicht erscheinen. Die Parameter tragen Sie als erzwungenen Filter in das Attribut data-enforced-request-params ein:

<script
  src="https://cdn.meinfahrzeugshop.com/v1/shop-hash/loader.js"
  data-tenant="IHRE-MANDANTEN-UUID"
  data-enforced-request-params="manufacturer=BMW&usedConditionTypes=GEBRAUCHTWAGEN&excludedIdentifiers=WBA12345,STOCK-0099"
  async
></script>

Über data-enforced-request-params gesetzte Filter sind immer aktiv und vom Besucher nicht abwählbar. Sollen die Werte lediglich als Startbelegung dienen und für den Besucher änderbar bleiben, verwenden Sie stattdessen data-initial-request-params.

Wichtig

Verwenden Sie für Live-Seiten ausschließlich das Snippet mit Ihren individuellen Werten aus dem Admin-Bereich unter Integration. Der obige Code enthält Platzhalter.