[GET] ~/criteria/variants

Returns a list of variants available for the given selection. FAB-1758: IsActive is filter-aware (subtractive; a no-op unless a real filter is set).

Request Information

URI Parameters

NameDescriptionType
manufacturers

Comma separated list of manufacturer ids.

 Collection of string

series

Comma separated list of series ids.

 Collection of string

models

Comma separated list of model ids..

 Collection of string

modelext

Model extension.

 string

bodies

Comma separated list of bodies. The bodies are fetched through variants.

 Collection of string

bodygroups

Comma separated list of body groups.

 Collection of string

variants

Comma separated list of variants.

 Collection of string

fuellings

Comma separated list of fuellings.

 Collection of string

transmissions

Comma separated list of transmissions.

 Collection of string

usagetypes

Comma separated list of usage type ids.

 Collection of string

drives

Comma separated list of drive ids.

 Collection of string

emissionclasses

Comma separated list of emission class ids.

 Collection of string

mileagemin

Minimum mileage in km.

 integer

mileagemax

Maximum mileage in km.

 integer

registermin

Minimum first registration in year.

 integer

registermax

Maximum first registration in year.

 integer

pricemin

Minimal price in EUR.

 integer

pricemax

Maximal price in EUR.

 integer

financingratemin

Minimal financing rat ein EUR.

 integer

financingratemax

Maximal financing rate in EUR.

 integer

leasingratemin

Minimum leasing rate in EUR.

 integer

leasingratemax

Maximum leasing rate in EUR.

 integer

installmentratemin

Minimum installment rate in EUR.

 integer

installmentratemax

Maximum installment rate in EUR.

 integer

co2emissionmin

Minimum CO2 emission in g/km.

 integer

co2emissionmax

Maximum CO2 emission in g/km.

 integer

powermin

Minimum power in kw.

 integer

powermax

Maximal power in kw.

 integer

horsepowermin

Minimal horsepower in hp.

 integer

horsepowermax

Maximal horsepower in hp.

 integer

seatsmin

Minimal seat count.

 integer

seatsmax

Maximal seat count.

 integer

vatdeductible

Vat deductible

 boolean

interiorcolors

Comma separated list of interior color ids.

 Collection of string

paints

Comma separated list of exterior color ids.

 Collection of string

metallic

Has metallic exterior color.

 boolean

allwheeldrive

Has four wheel drive.

 boolean

upholsteries

Comma separated list of upholstery ids.

 Collection of string

options

Comma separated list of option ids.

 Collection of string

equipments

Comma separated list of equipment ids.

 Collection of string

zip

Zip Code.

 string

distance

Maximal distance to the zip Code in km.

 integer

number

Number of the vehicle.

 string

promotions

Comma separated list of promotion ids.

 Collection of string

locations

Comma separated list of location ids.

 Collection of string

guarantees

Comma separated list of guarantee ids.

 Collection of string

hasguarantee

Has guarantee.

 boolean

qualityseals

Comma separated list of quality seal ids.

 Collection of string

hasqualityseal

Has quality seal.

 boolean

servicepackages

Comma separated list of service package ids.

 Collection of string

hasservicepackage

Has service package.

 boolean

miniminimalism

Has MINI minimalism seal (DEPRECATED).

 boolean

bmwefficientdynamics

Has BMW efficient dynamics seal (DEPRECATED).

 boolean

vicinityhomezipcode

Vicinity home zipcode.

 string

widthMin

Maximal width in cm.

 integer

widthMax

Minimal width in cm.

 integer

lengthMin

Minimal length in cm.

 integer

lengthMax

Maximal length in cm.

 integer

heightMin

Minimal height in cm.

 integer

heightMax

Maximal height in cm.

 integer

sleepingPlacesMin

Minimal count of sleeping places.

 integer

sleepingPlacesMax

Maximal count of sleeping places.

 integer

availableFromDate

Available from date in yyyyMMdd format.

 string

availabilityType

The availability type. Possible values are: "onsite", "byorder"

 string

b2b

How B2B vehicles take part in the selection. B2B vehicles are excluded, if not set.

 B2BSelection

Body Parameters

None.

Request Formats

None.

Response Information

Resource Description

The variants.

An instance of: Collection of ActivatableNameValueLabelPair
NameDescriptionType
IsActive

Indicates, if this option is currently set for at least one vehicle within the vehicle stock.

 boolean

Name

An internal, unique name. May be used to derive a front-end image file name from. Not provided for all options.

 string

Value

Identifying value of this element, to be used in searches.

 string

Label

A human readable label of this element.

 string

IsRetired

Indicates, whether this element should be considered as retired, i.e. it is no longer sold new by the the manufacturer.

 boolean

Response Formats

application/json, text/json

Sample: 
[
  {
    "isActive": true,
    "name": "sample string 1",
    "value": "sample string 2",
    "label": "sample string 3",
    "isRetired": true
  },
  {
    "isActive": true,
    "name": "sample string 1",
    "value": "sample string 2",
    "label": "sample string 3",
    "isRetired": true
  }
]