v1

latestSwagger 2.02026-07-1432213.7 KB
Dealer search

This request returns dealers (dealer, garage, retailer, etc.) for given parameters

get/dealers

Query parameters

dealerIdsstring[]

Array of dealer ids. The dealer id is dealer’s business key, also known as GS Id. e.g. GS0000857,GS0017621

latitudenumber

The latitude geo coordinate.

longitudenumber

The longitude geo coordinate.

radiusValueinteger

The radius value of the search area. The center of the search area is defined by geo coordinates. (latitude, longitude properties) If radiusValue and radiusUnit parameters are missing, then the default radius is 10 km.

radiusUnit'M' | 'KM' | 'MILE'

The radius unit of the search area. The center of the search area is defined by geo coordinates. (latitude, longitude properties) If radiusValue and radiusUnit parameters are missing, then the default radius is 10 km.

countryIsoCodestring

The country of the dealer address defined as ISO two letter ID (e.g. DE, CH, CN, etc.)

citystring

The city of the dealer address.

namestring

A name of the dealer, the name filter will be applied to all Dealer names (e.g. legalName, nameAddition). You can also search for parts of Dealer names, e.g. the search term 'Niederlassung' will also match 'Niederlassung Stuttgart'.

brand'MB' | 'SMT'

Filter by brand, valid values are:

  • MB: Mercedes-Benz
  • SMT: Smart
productGroup'PASSENGER-CAR' | 'VAN'

Filter by a product group

activity'PARTS' | 'SALES' | 'SERVICE' | 'USED-VEHICLES-TRADE'

Filter by activity, valid actitvity values are:

  • PARTS: Spare Parts Sales
  • SALES: Sales of new vehicles
  • SERVICE: Maintaining and repair
  • USED-VEHICLES-TRADE: Sales of used vehicles
fieldsstring

Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned. e.g. fields=dealers(dealerId,address(street,city))

pageinteger

The index of the page to be returned. If this parameter is omitted, the first page will be returned.

pageSizeinteger

The index of the page to be returned. If this parameter is omitted, the first page will be returned.

Response

OK