Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There are two environments. One for testing (development) and one for the production (production).

Environment

URL

development

https://api.dev.it.

freshforfinance

fahrzeugmarkt.

de

online/public/v1

production

https://api.

freshforfinance

fahrzeugmarkt.

de

online/public/v1

Authentication

To use the public API, you have to provide the Header X-Authorization in every request (X-Authorization: API_KEY).

Header

Required

Value

Description

X-Authorization

(tick)

API_KEY

Ask our support team for your API_KEY.

Dealerships

Dealerships list

...

Code Block
201 Created

Fields

field

type

required

constraints

description

offer

integer

(error)

The code of the offer. This can be obtained by using the /offers service.

type

integer | string

(error)

The id or the code of the lead-type. This can be obtained by using the /lead-types service.

dealership

integer

(error)

The code of the dealership. This can be obtained by using the /dealerships service.

Note

If offer is set, it will be overridden by the dealership of the offer.

salutation

integer

(tick)

The code of the salutation. This can be obtained by using the /references/salutations service.

firstname

string

(warning)

required if category of salutation is PERSON

lastname

string

(warning)

required if category of salutation is PERSON

company

string

(warning)

required if category of salutation is COMPANY

phone

string

(error)

email

string

(tick)

message

string

(error)

additional-data

array / objekt

(error)

Offers

Offers list

This service will list all the available offers.

...

You can add parameters such as paginate or filter to get the offers according to your needs.

Parameter

Target

Required

Constraints

Request

Description

paginate

pagination

(error)

The maximum value per page is 1000, by default the number per page of items is of 15 if the parameter is not present in the request

GET /offers?paginate=200

Get all the offers with 200 items per page.

code

filter

(error)

Filters by the codes. This is required for the “Merkliste”.

GET /offers?filter[code]=100,150

Get all the offers where the code is 100 OR 150

car.brand

filter

(error)

List available from service /references/brands

GET /offers?filter[car.brand]=20,23

Get all the offers where the car brand is 20 OR 23

car.model

filter

(error)

List available from service /references/brands

GET /offers?filter[car.model]=149

Get all the offers where the car model is 149

car.type

filter

(error)

List available from service /references/car-types

GET /offers?filter[car.type]=NW

Get all the offers where the car type code is “NW”

car.body

filter

(error)

List available from service /references/car-bodies

GET /offers?filter[car.body]=2,1

Get all the offers where the car body is 2 OR 1

car.transmission

filter

(error)

List available from service /references/transmissions

GET /offers?filter[car.transmission]=4

Get all the offers where the car transmission code is 4

car.fuel

filter

(error)

List available from service /references/fuels

GET /offers?filter[car.fuel]=1,3

Get all the offers where the car fuel is 1 OR 3

car.firstRegistration

filter

(error)

This filter needs a range of values like 2019-01,2020-12. If there is only one value, it will be used as the minimum value.

List available from service /references/first-registration

GET /offers?filter[car.firstRegistration]=2019-01,2019-12

Get all the cars registered between 2019-01 AND 2019-12

car.mileage

filter

(error)

This filter needs a range of values like 10000,30000. If there is only one value, it will be used as the minimum value.

List available from service /references/mileage

GET /offers?filter[car.mileage]=0,30000

Get all the cars with mileage between 0 AND 30000

filter

You can combine the filters according to your needs

GET /offers?filter[car.fuel]=1,3&filter[car.brand]=20,23

Get all the offers where the car fuel is 1 OR 3 AND car brand is 20 OR 23

car.brand (ascending)
-car.brand (descending)

sort

(error)

GET /offers?sort=car.brand

car.mileage (ascending)
-car.mileage (descending)

sort

(error)

GET /offers?sort=car.mileage

car.firstRegistration (ascending)
-car.firstRegistration (descending)

sort

(error)

GET /offers?sort=car.firstRegistration

prices.sale.price (ascending)
-prices.sale.price (descending)

sort

(error)

GET /offers?sort=prices.sale.price

Note

The list will only include offers where a price is set.

prices.leasing.grossMonthlyRate (ascending)
-prices.leasing.grossMonthlyRate (descending)

sort

(error)

GET /offers?sort=prices.leasing.grossMonthlyRate

Note

The list will only include offers where a gross monthly rate is set.

prices.rent.grossRentPrice (ascending)
-prices.rent.grossRentPrice (descending)

sort

(error)

GET /offers?sort=prices.rent.grossRentPrice

Note

The list will only include offers where a gross rent price is set.

sort

You can combine the sorts according to your needs

GET /offers?sort=car.brand,car.mileage

Sort the offers by the brand and then by the mileage

Offer

This service will all the details for available offer.

...