Enforced Vehicle Request Parameters
Diese Referenz dokumentiert die API-Parameter zur Filterung von Fahrzeugen im Mein-Fahrzeugshop-System. Die Parameter beschreiben verpflichtende bzw. standardisierte Filtermethoden innerhalb der Fahrzeugabfrage. Alle Parameter vom Typ String (Kommasepariert) akzeptieren mehrere Werte getrennt durch Komma.
| Parameter | Typ | Beschreibung | Mögliche Werte | Beispiel |
|---|---|---|---|---|
CarType | String | Einzelne Fahrzeug-Art (Singular zu CarTypes) | Werte siehe CarTypes | &carType=PKW |
CarTypes | String (Kommasepariert) | Fahrzeug-Arten | ALKOVEN, ALLE, ANDERE, ANHAENGER, CABRIO, INTEGRIERT, KASTENWAGEN, KLEINWAGEN, KOMBI, LIMOUSINE, NUTZFAHRZEUG, PKW, SPORTWAGEN, SUV, TEILINTEGRIERT, VAN, WOHNMOBIL, ZWEIRAD | &carTypes=PKW,ZWEIRAD |
DriveTypes | String (Kommasepariert) | Antriebsarten | CombustionEngine, ElectricMotor, FuelCell, Other, PlugInHybrid | &driveTypes=CombustionEngine,ElectricMotor |
EngineCapacityMax | Integer | Maximaler Hubraum | Beliebige Zahl | &engineCapacityMax=2000 |
EngineCapacityMin | Integer | Minimaler Hubraum | Beliebige Zahl | &engineCapacityMin=1000 |
FuelType | String | Einzelne Treibstoff-Art (Singular zu FuelTypes) | Werte siehe FuelTypes | &fuelType=BENZIN |
FuelTypes | String (Kommasepariert) | Treibstoff-Arten | ANDERE, AUTOGAS, BENZIN, BI_FUEL, DIESEL, ELEKTRO, ERDGAS, ETHANOL, HYBRID_BENZIN, HYBRID_DIESEL, WASSERSTOFF | &fuelTypes=BENZIN,DIESEL |
GearBoxType | String | Einzelne Getriebe-Art (Singular zu GearBoxTypes) | Werte siehe GearBoxTypes | &gearBoxType=MANUELL |
GearBoxTypes | String (Kommasepariert) | Getriebe-Arten | ANDERE, AUTOMATIK, HALB_AUTOMATIK, MANUELL | &gearBoxTypes=MANUELL,AUTOMATIK |
HasConditionDocumentUrls | Boolean | Filtert nach hinterlegten Zustandsdokumenten | false, true | &hasConditionDocumentUrls=true |
HasEnVkvLabelDocumentUrl | Boolean | Filtert nach hochgeladenem EnVKV-Label | false, true | &hasEnVkvLabelDocumentUrl=true |
HasImages | Boolean | Nur Fahrzeuge mit mindestens ImagesToCrop Bildern (greift nur bei true) | false, true | &hasImages=true |
HasInitialLeasingInstallment | Boolean | Filtert nach hinterlegter Leasingrate | false, true | &hasInitialLeasingInstallment=true |
Identifiers | String (Kommasepariert) | VIN oder interne ID (Mischung erlaubt) — OR-Filter | Kommaseparierte VINs/IDs | &identifiers=WVWZZZ1KZAW123456,2220951 |
InteriorBaseColorType | String | Einzelne Innenraum-Grundfarbe (Singular zu InteriorBaseColorTypes) | Werte siehe InteriorBaseColorTypes | &interiorBaseColorType=BLACK |
InteriorBaseColorTypes | String (Kommasepariert) | Innenraum-Grundfarben | BEIGE, BLACK, BLUE, BROWN, GOLD, GRAY, GREEN, ORANGE, OTHER, RED, SILVER, VIOLET, WHITE, YELLOW | &interiorBaseColorTypes=BLACK,GRAY |
InteriorTypes | String (Kommasepariert) | Innenausstattungsarten | ALCANTARA, ANDERE, KUNSTLEDER, LEDER, NONE, STOFF, TEILLEDER, VELOUR | &interiorTypes=LEDER,STOFF |
InternalIds | String (Kommasepariert) | Interne Fahrzeugnummern | Kommaseparierte IDs | &internalIds=2220951,1428541,543002 |
IsARecommendation | Boolean | MobileCSV (W/22), greift nur bei true | false, true | &isARecommendation=true |
IsAvailableInstantly | Boolean | Nur sofort verfügbare Fahrzeuge (AvailableFromDate ≤ aktuelles Datum), greift nur bei true | true | &isAvailableInstantly=true |
IsVatDeductable | Boolean | MwSt. ausweisbar | false, true | &isVatDeductable=true |
LengthMax | Integer | Maximale Fahrzeuglänge | Beliebige Zahl | &lengthMax=5000 |
LengthMin | Integer | Minimale Fahrzeuglänge | Beliebige Zahl | &lengthMin=4000 |
Manufacturer | String | Hersteller (Präfix-Match, case-insensitive) | Herstellername | &manufacturer=VW |
MarketingCampaigns | String (Kommasepariert) | Marketing-Kampagnen | Kommaseparierte Kampagnen-Codes | &marketingCampaigns=CAMPAIGN_A,CAMPAIGN_B |
MaxDoors | Integer | Maximale Türanzahl | Beliebige Zahl | &maxDoors=5 |
MaxEngineCylinders | Integer | Maximale Zylinderanzahl | Beliebige Zahl | &maxEngineCylinders=8 |
MaxEnginePower | Integer | Maximale Motorleistung (Vergleich mit PS-Rundung, Faktor 1.35962) | Beliebige Zahl | &maxEnginePower=150 |
MaxInitialRegistration | DateTime | Maximale Erstzulassung (ISO 8601) | Datum | &maxInitialRegistration=2024-12-31 |
MaxMileAge | Integer | Maximaler Kilometerstand | Beliebige Zahl | &maxMileAge=100000 |
MaxPrice | Decimal | Maximaler Preis (brutto bei VatDeductable=true) | Beliebige Zahl | &maxPrice=50000 |
MinDoors | Integer | Minimale Türanzahl | Beliebige Zahl | &minDoors=3 |
MinEngineCylinders | Integer | Minimale Zylinderanzahl | Beliebige Zahl | &minEngineCylinders=4 |
MinEnginePower | Integer | Minimale Motorleistung (Vergleich mit PS-Rundung, Faktor 1.35962) | Beliebige Zahl | &minEnginePower=70 |
MinInitialRegistration | DateTime | Minimale Erstzulassung (ISO 8601; Fahrzeuge ohne Erstzulassung werden eingeschlossen) | Datum | &minInitialRegistration=2020-01-01 |
MinMileAge | Integer | Minimaler Kilometerstand | Beliebige Zahl | &minMileAge=10000 |
MinPrice | Decimal | Minimaler Preis (brutto bei VatDeductable=true) | Beliebige Zahl | &minPrice=10000 |
Model | String | Einzelnes Modell (Exact Match, case-insensitive) | Modellname | &model=GOLF |
Models | String (Kommasepariert) | Modelle | Modellnamen | &models=GOLF,POLO,TIGUAN |
MonthlyFinancingRateExampleMax | Decimal | Maximale monatliche Finanzierungsrate (Beispielrate) | Beliebige Zahl | &monthlyFinancingRateExampleMax=400 |
MonthlyFinancingRateExampleMin | Decimal | Minimale monatliche Finanzierungsrate (Beispielrate) | Beliebige Zahl | &monthlyFinancingRateExampleMin=100 |
MonthlyLeasingRateExampleMax | Decimal | Maximale monatliche Leasingrate (Beispielrate) | Beliebige Zahl | &monthlyLeasingRateExampleMax=500 |
MonthlyLeasingRateExampleMin | Decimal | Minimale monatliche Leasingrate (Beispielrate) | Beliebige Zahl | &monthlyLeasingRateExampleMin=150 |
OrderBy | String | Sortierung (jeweils mit ASC oder DESC) | CREATEDAT, INITIALFINANCINGINSTALLMENT, INITIALLEASINGINSTALLMENT, INITIALREGISTRATION, MILEAGE, PRICE | INITIALREGISTRATION DESC |
PreviousUsageTypes | String (Kommasepariert) | Vorherige Nutzungsarten | 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 | &previousUsageTypes=FIRMENWAGEN,LEASING |
QualitySeals | String (Kommasepariert) | Qualitätssiegel | Kommaseparierte Siegel-Codes | &qualitySeals=SEAL_A,SEAL_B |
SearchTerm | String | Freitext-Suchbegriff | Beliebiger Text | &searchTerm=Pro Performance |
SeatsMax | Integer | Maximale Sitzanzahl | Beliebige Zahl | &seatsMax=5 |
SeatsMin | Integer | Minimale Sitzanzahl | Beliebige Zahl | &seatsMin=2 |
SleepingPlacesMax | Integer | Maximale Schlafplätze | Beliebige Zahl | &sleepingPlacesMax=4 |
SleepingPlacesMin | Integer | Minimale Schlafplätze | Beliebige Zahl | &sleepingPlacesMin=2 |
TotalWeightMax | Integer | Maximales Gesamtgewicht | Beliebige Zahl | &totalWeightMax=3500 |
TotalWeightMin | Integer | Minimales Gesamtgewicht | Beliebige Zahl | &totalWeightMin=1500 |
UsedConditionTypes | String (Kommasepariert) | Fahrzeug-Zustandsarten | GEBRAUCHTWAGEN, JAHRESWAGEN, NEUWAGEN, OLDTIMER, TAGESZULASSUNG, VORFÜHRWAGEN, YOUNGTIMER | &usedConditionTypes=NEUWAGEN,GEBRAUCHTWAGEN |
VarnishBaseColorType | String | Einzelne Lack-Grundfarbe (Singular zu VarnishBaseColorTypes) | Werte siehe VarnishBaseColorTypes | &varnishBaseColorType=BLACK |
VarnishBaseColorTypes | String (Kommasepariert) | Lack-Grundfarben | BEIGE, BLACK, BLUE, BROWN, GOLD, GRAY, GREEN, ORANGE, OTHER, RED, SILVER, VIOLET, WHITE, YELLOW | &varnishBaseColorTypes=BLACK,WHITE |
VehicleDealerLocationIds | String (Kommasepariert) | Händler-Standort-IDs (GUIDs) | Kommaseparierte GUIDs | &vehicleDealerLocationIds=00000000-0000-0000-0000-000000000000 |
VehicleSubTypes | String (Kommasepariert) | Fahrzeug-Untertypen | 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 | &vehicleSubTypes=Cabrio,Limousine |
Exkludierende Parameter
Neu
Ergänzend zu den inkludierenden Filtern können Sie jeden Listen- bzw. Mengenfilter jetzt 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. Kommaseparierte Parameter akzeptieren mehrere Werte. Inkludierende und exkludierende Parameter lassen sich in derselben Abfrage kombinieren; leere bzw. nur aus Leerzeichen bestehende 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 | Typ | Schließt aus | Spiegelt | Beispiel |
|---|---|---|---|---|
ExcludedIdentifiers | String (Kommasepariert) | Fahrzeuge mit passender FIN oder interner Fahrzeugnummer | Identifiers | &excludedIdentifiers=WBA12345,STOCK-0099 |
ExcludedInternalIds | String (Kommasepariert) | Fahrzeuge mit passender interner Fahrzeugnummer | InternalIds | &excludedInternalIds=2220951,1428541 |
ExcludedCarIds | String (Kommasepariert) | Fahrzeuge mit passender ID (Guid) | CarIds | &excludedCarIds=3f2a9c14-...,9b7c0d22-... |
ExcludedManufacturer | String | Hersteller (StartsWith-Abgleich) | Manufacturer | &excludedManufacturer=VW |
ExcludedModels | String (Kommasepariert) | angegebene Modelle | Models | &excludedModels=GOLF,POLO |
ExcludedCarTypes | String (Kommasepariert) | Fahrzeug-Arten | CarTypes | &excludedCarTypes=ZWEIRAD,ANHAENGER |
ExcludedVehicleSubTypes | String (Kommasepariert) | Fahrzeuge mit mind. einem der Untertypen (Any-Match) | VehicleSubTypes | &excludedVehicleSubTypes=TEILINTEGRIERT |
ExcludedUsedConditionTypes | String (Kommasepariert) | Zustandsarten | UsedConditionTypes | &excludedUsedConditionTypes=OLDTIMER |
ExcludedPreviousUsageTypes | String (Kommasepariert) | vorherige Nutzungsarten | PreviousUsageTypes | &excludedPreviousUsageTypes=MIETWAGEN,TAXI |
ExcludedDriveTypes | String (Kommasepariert) | Antriebsarten | DriveTypes | &excludedDriveTypes=ElectricMotor |
ExcludedFuelTypes | String (Kommasepariert) | Treibstoff-Arten | FuelTypes | &excludedFuelTypes=DIESEL |
ExcludedGearBoxTypes | String (Kommasepariert) | Getriebe-Arten | GearBoxTypes | &excludedGearBoxTypes=MANUELL |
ExcludedInteriorTypes | String (Kommasepariert) | Innenausstattungsarten | InteriorTypes | &excludedInteriorTypes=STOFF |
ExcludedEquipmentIds | String (Kommasepariert) | Fahrzeuge mit mind. einer der Ausstattungs-IDs (Any-Match) | EquipmentIds | &excludedEquipmentIds=1234,5678 |
ExcludedVarnishBaseColorTypes | String (Kommasepariert) | Lack-Grundfarben | VarnishBaseColorTypes | &excludedVarnishBaseColorTypes=SCHWARZ |
ExcludedInteriorBaseColorTypes | String (Kommasepariert) | Innenraum-Grundfarben | InteriorBaseColorTypes | &excludedInteriorBaseColorTypes=BEIGE |
ExcludedVehicleDealerLocationIds | String (Kommasepariert) | Händler-Standort-IDs | VehicleDealerLocationIds | &excludedVehicleDealerLocationIds=42,43 |
ExcludedValidForSaleTypes | String (Kommasepariert) | Verkaufsstatus-Arten | ValidForSaleTypes | &excludedValidForSaleTypes=RESERVIERT |
ExcludedQualitySeals | String (Kommasepariert) | Qualitätssiegel | QualitySeals | &excludedQualitySeals=GEPRUEFT |
ExcludedMarketingCampaigns | String (Kommasepariert) | Marketing-Kampagnen | MarketingCampaigns | &excludedMarketingCampaigns=SOMMERAKTION |
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 Ihres Einbindungs-Snippets ein (siehe Shop-Einbindung):
<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.