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

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

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:

  1. Default grouping uses an internal grouping that takes thorough criterias like engine, model year, etc. into account.
  2. Brand-model grouping groups by unique brand and model combinations.
  3. 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

Gets a single car

Gets a single car

Authorizations:
actor
path Parameters
id
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

Responses

Returns available brands/models/etc...

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

Responses