Product API (1.0.0)

Download OpenAPI specification:

Serves all cars data consumed by our FINN UI

B2C/MiniB2B Products

Returns a list of cars

Authorizations:

actor

query Parameters

view	string or null Default: "available_cars" Enum: "available_cars" "displayed_cars" "coming-soon" "available-and-coming-soon" Which subset of cars to fetch
brands	string or null Car brands separated by commas (e.g. BMW,Fiat)
models	string or null Car models separated by commas (e.g. X6,3er Limousine)
gearshifts	string or null Gearshifts separated by commas (e.g. Automatik,Manuell)
cartypes	string or null Car types separated by commas (e.g. SUV,Kombi)
min_price	number or null Minimum price
max_price	number or null Maximum price
max_price_msrp	number or null Maximum price for MSRP
min_price_msrp	number or null Minimum price for MSRP
available_from	string or null <date> Closest date from which the car is available for delivery
available_to	string or null <date> Latest date to which the car is available for delivery
terms	string or null Terms separated by commas (e.g. 12,24,36)
fuels	string or null Fuels separated by commas (e.g. Diesel,Benzin)
product_group	string or null Product groups separated by commas (e.g. paypal,blackfriday)
product_id	string or null Product id, used as regex for searching by product id
is_for_business	boolean or null Default: false When true, it filters by b2b prices
has_hitch	boolean or null Default: false When true, it filters by cars with hitch
is_young_driver	boolean or null Default: false When true, it filters by cars that allow young drivers
has_deals	boolean or null Default: false When true, it filters by cars with deals or discounts
pricing_type	string or null Default: "normal" Enum: "normal" "downpayment" When set to 'downpayment' will use the downpayment prices
features	string or null Filters cars by the specified features separated by commas (e.g. hitch,AC)
colors	string or null Filters cars by the specified colors (e.g. Schwarz,Weiß)
config_id	number or null Filters cars by the specified config id
hide_related	boolean or null Default: true Hides configs with too many variations
cug_id	string or null Closed User Group ID (e.g. allianz) for which special prices are applied
min_power	number or null Minimum power in kW (e.g. 100)
max_power	number or null Maximum power in kW (e.g. 150)
min_ev_range	number or null Minimum electric range in km (e.g. 300)
max_ev_range	number or null Maximum electric range in km (e.g. 500)
seats	string or null Number of seats
doors	string or null Number of doors
swap_config_id	string or null Config ID of the reference car for recommendation-based sorting. When this is provided and sort is missing or set to desktop, cars with similar brand and price to this reference car will be prioritized.
ml_recommendation	string or null Underscore-separated list of up to 20 config IDs ranked by ML recommendation (e.g., "555_333_999" means 555 has rank 1, 333 has rank 2, 999 has rank 3). When provided along with swap_config_id, cars in this list receive additional similarity score bonus: 80 + (21 - rank). Additional entries beyond 20 are ignored.
sort_models_by	string or null Default: "alphabetical" Enum: "popularity" "alphabetical" Sorts models by popularity or alphabetical
skip-grouping	boolean Default: false When true, it skips the default grouping of cars
group_by	string Default: "default" Enum: "default" "brand-model" "model-version" Groups the cars by the given criteria: Default grouping uses an internal grouping that takes thorough criterias like engine, model year, etc. into account. Brand-model grouping groups by unique brand and model combinations. Model-version groups by unique brand, model and version_name combinations
offset	number >= 0 Default: 0
sort	string Default: "desktop" Enum: "desktop" "asc" "desc" "availability" "last_added"
limit	number >= 1 Default: 9

Responses

Response samples

Content type

application/json

{"offset": 0,
"results": [{"availability": 0,
"available_from_deviation_in_weeks": 0,
"available_from": "string",
"available_states": null,
"available_terms": [0
],
"available_to": "string",
"related_configs": [0
],
"color_list": [{"availability": 0,
"availability_date": "string",
"available_to_date": "string",
"brand": "string",
"car_id": "string",
"color_hex": "string",
"color_specific": "string",
"desktop_sorting": 0,
"id": "string",
"model": "string",
"picture_front_url": "string",
"pricing": [0
],
"sorting": "string",
"uid": 0
}
],
"downpayment_prices": {"msrp": 0,
"extra_km_price": 0,
"available_price_list": {"property1": 0,
"property2": 0
},
"downpayment_discount_percentage": 0,
"downpayment_fixed_amount": 0
},
"price": {"msrp": 0,
"extra_km_price": 0,
"available_price_list": {"property1": 0,
"property2": 0
}
},
"default_term": 0,
"default_downpayment_term": 0,
"availability_by_term": { },
"brand": {"id": "string",
"picture": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"helper_brand_logo": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
}
},
"cartype": "string",
"co2emission": 0,
"co2_class": "string",
"color": {"id": "string",
"color_hex": "string",
"specific": "string"
},
"config": {"link": "string",
"name": "string"
},
"config_drive": "string",
"config_id": 0,
"consumption": 0,
"consumption_city": 0,
"consumption_highway": 0,
"doors": "string",
"efficiency_class": "string",
"efficiency_image": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"energy_class_file": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"engine": "string",
"equipment": {"comfort": "string",
"exterior": "string",
"interior": "string",
"multimedia": "string",
"safety": "string"
},
"equipment_schemas": ["string"
],
"equipment_delimiter": "string",
"equipment_line": "string",
"equipment_packages": {"property1": "string",
"property2": "string"
},
"ev_range": "string",
"financing_type": "string",
"fuel": "string",
"gearshift": "string",
"gross_capitalized_cost": null,
"has_hitch": "string",
"has_real_pictures": true,
"id": "string",
"indexable": true,
"model": "string",
"model_year": "string",
"offer_type": "string",
"picture": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"pictures": [{"url": "string",
"filename": "string",
"type": "string",
"size": 0
}
],
"power": 0,
"product_desktop_sorting": 0,
"product_group": ["string"
],
"product_label": {"label": "string",
"label_color": "string",
"label_inverted": true,
"label_text_color": "string",
"logged_in_only": true
},
"product_path": "string",
"product_stock_preorder": 0,
"product_stock_total": 0,
"product_stock_webflow": 0,
"purchasing_deal_name": "string",
"recurrent_payment_method_list": ["string"
],
"residual_values": null,
"seats": "string",
"seo_canonical_product_id": "string",
"single_payment_method_list": ["string"
],
"source": "string",
"states_stock": null,
"tires": "string",
"trim_name": "string",
"uid": 0,
"vehicle_size": {"width_mm": 0,
"height_mm": 0,
"length_mm": 0
},
"model_slug": "string",
"product_link": "string",
"similarity_score": 0,
"similarity_score_breakdown": {"brandScore": 0,
"priceScore": 0,
"fuelScore": 0,
"cartypeScore": 0,
"mlRecommendationScore": 0,
"mlRecommendationRank": 0
}
}
],
"total_results": 0
}

Gets a single car

Authorizations:

actor

path Parameters

required

string

Can be either a Fleet Config ID or a Growth Product ID

query Parameters

hide_related	boolean or null Default: true Hides configs with too many variations
cug_id	string or null Closed User Group ID (e.g. allianz) for which special prices are applied
include_deleted	boolean or null Default: false When true, includes products that have been deleted (deleted_at is set)

Responses

Response samples

Content type

application/json

{"availability": 0,
"available_from_deviation_in_weeks": 0,
"available_from": "string",
"available_states": null,
"available_terms": [0
],
"available_to": "string",
"related_configs": [0
],
"color_list": [{"availability": 0,
"availability_date": "string",
"available_to_date": "string",
"brand": "string",
"car_id": "string",
"color_hex": "string",
"color_specific": "string",
"desktop_sorting": 0,
"id": "string",
"model": "string",
"picture_front_url": "string",
"pricing": [0
],
"sorting": "string",
"uid": 0
}
],
"downpayment_prices": {"msrp": 0,
"extra_km_price": 0,
"available_price_list": {"property1": 0,
"property2": 0
},
"downpayment_discount_percentage": 0,
"downpayment_fixed_amount": 0
},
"price": {"msrp": 0,
"extra_km_price": 0,
"available_price_list": {"property1": 0,
"property2": 0
}
},
"default_term": 0,
"default_downpayment_term": 0,
"availability_by_term": { },
"brand": {"id": "string",
"picture": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"helper_brand_logo": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
}
},
"cartype": "string",
"co2emission": 0,
"co2_class": "string",
"color": {"id": "string",
"color_hex": "string",
"specific": "string"
},
"config": {"link": "string",
"name": "string"
},
"config_drive": "string",
"config_id": 0,
"consumption": 0,
"consumption_city": 0,
"consumption_highway": 0,
"doors": "string",
"efficiency_class": "string",
"efficiency_image": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"energy_class_file": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"engine": "string",
"equipment": {"comfort": "string",
"exterior": "string",
"interior": "string",
"multimedia": "string",
"safety": "string"
},
"equipment_schemas": ["string"
],
"equipment_delimiter": "string",
"equipment_line": "string",
"equipment_packages": {"property1": "string",
"property2": "string"
},
"ev_range": "string",
"financing_type": "string",
"fuel": "string",
"gearshift": "string",
"gross_capitalized_cost": null,
"has_hitch": "string",
"has_real_pictures": true,
"id": "string",
"indexable": true,
"model": "string",
"model_year": "string",
"offer_type": "string",
"picture": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"pictures": [{"url": "string",
"filename": "string",
"type": "string",
"size": 0
}
],
"power": 0,
"product_desktop_sorting": 0,
"product_group": ["string"
],
"product_label": {"label": "string",
"label_color": "string",
"label_inverted": true,
"label_text_color": "string",
"logged_in_only": true
},
"product_path": "string",
"product_stock_preorder": 0,
"product_stock_total": 0,
"product_stock_webflow": 0,
"purchasing_deal_name": "string",
"recurrent_payment_method_list": ["string"
],
"residual_values": null,
"seats": "string",
"seo_canonical_product_id": "string",
"single_payment_method_list": ["string"
],
"source": "string",
"states_stock": null,
"tires": "string",
"trim_name": "string",
"uid": 0,
"vehicle_size": {"width_mm": 0,
"height_mm": 0,
"length_mm": 0
},
"model_slug": "string",
"product_link": "string",
"similarity_score": 0,
"similarity_score_breakdown": {"brandScore": 0,
"priceScore": 0,
"fuelScore": 0,
"cartypeScore": 0,
"mlRecommendationScore": 0,
"mlRecommendationRank": 0
}
}

Returns available brands/models/etc...

Authorizations:

actor

query Parameters

view	string or null Default: "available_cars" Enum: "available_cars" "displayed_cars" "coming-soon" "available-and-coming-soon" Which subset of cars to fetch
brands	string or null Car brands separated by commas (e.g. BMW,Fiat)
models	string or null Car models separated by commas (e.g. X6,3er Limousine)
gearshifts	string or null Gearshifts separated by commas (e.g. Automatik,Manuell)
cartypes	string or null Car types separated by commas (e.g. SUV,Kombi)
min_price	number or null Minimum price
max_price	number or null Maximum price
max_price_msrp	number or null Maximum price for MSRP
min_price_msrp	number or null Minimum price for MSRP
available_from	string or null <date> Closest date from which the car is available for delivery
available_to	string or null <date> Latest date to which the car is available for delivery
terms	string or null Terms separated by commas (e.g. 12,24,36)
fuels	string or null Fuels separated by commas (e.g. Diesel,Benzin)
product_group	string or null Product groups separated by commas (e.g. paypal,blackfriday)
product_id	string or null Product id, used as regex for searching by product id
is_for_business	boolean or null Default: false When true, it filters by b2b prices
has_hitch	boolean or null Default: false When true, it filters by cars with hitch
is_young_driver	boolean or null Default: false When true, it filters by cars that allow young drivers
has_deals	boolean or null Default: false When true, it filters by cars with deals or discounts
pricing_type	string or null Default: "normal" Enum: "normal" "downpayment" When set to 'downpayment' will use the downpayment prices
features	string or null Filters cars by the specified features separated by commas (e.g. hitch,AC)
colors	string or null Filters cars by the specified colors (e.g. Schwarz,Weiß)
config_id	number or null Filters cars by the specified config id
hide_related	boolean or null Default: true Hides configs with too many variations
cug_id	string or null Closed User Group ID (e.g. allianz) for which special prices are applied
min_power	number or null Minimum power in kW (e.g. 100)
max_power	number or null Maximum power in kW (e.g. 150)
min_ev_range	number or null Minimum electric range in km (e.g. 300)
max_ev_range	number or null Maximum electric range in km (e.g. 500)
seats	string or null Number of seats
doors	string or null Number of doors
swap_config_id	string or null Config ID of the reference car for recommendation-based sorting. When this is provided and sort is missing or set to desktop, cars with similar brand and price to this reference car will be prioritized.
ml_recommendation	string or null Underscore-separated list of up to 20 config IDs ranked by ML recommendation (e.g., "555_333_999" means 555 has rank 1, 333 has rank 2, 999 has rank 3). When provided along with swap_config_id, cars in this list receive additional similarity score bonus: 80 + (21 - rank). Additional entries beyond 20 are ignored.
sort_models_by	string or null Default: "alphabetical" Enum: "popularity" "alphabetical" Sorts models by popularity or alphabetical

Responses

Response samples

Content type

application/json

{"availability": ["string"
],
"brands": [{"id": "string",
"available": true,
"helper_brand_logo": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"models": [{"id": "string",
"available": true,
"picture": {"url": "string",
"filename": "string",
"type": "string",
"size": 0
},
"cheapest_price": 0,
"cheapest_downpayment_price": 0,
"configs_count": 0,
"versions_count": 0,
"grouped_configs_count": 0,
"popularity": 0
}
],
"popularity": 0
}
],
"cartypes": ["string"
],
"colors": [{"id": "string",
"color_hex": "string"
}
],
"fuels": ["string"
],
"gearshifts": ["string"
],
"has_hitch": [true
],
"is_young_driver": [true
],
"indexable": [true
],
"max_price": 0,
"min_price": 0,
"min_price_msrp": 0,
"max_price_msrp": 0,
"models": ["string"
],
"payment_method": ["string"
],
"product_group": ["string"
],
"product_id": ["string"
],
"terms": [0
],
"total_results": 0,
"has_deals": [null
],
"features": ["string"
],
"min_power": 0,
"max_power": 0,
"min_ev_range": 0,
"max_ev_range": 0,
"seats": [0
],
"doors": [0
]
}