GET: Get Offer By Series

Endpoint Overview

Title: Offers by Series Native

Description: This endpoint returns best Offer for all passed series_ids of AMS database.

We also return the search_more_url and internal_url parameters so you can map them to the search widget page as get params. There is also the redirect link for directly linking to offers.

HTTP Method

Method: GET

URL Path

ams/offer-by-series-native

Final URL: https://api.mivodo.com/ams/offer-by-series-native

Query Parameters

Parameter	Type	Required	Description	Default
series_ids	list of integer	Yes	SeriesIds of AMS comma sep.	–
offer_type	string	Yes	vehicle-leasing-offers, vehicle-buy-offers or vehicle-subscription-offers	–
customer_groups	string	No	privat or gewerbe	privat
vehicle_condition	string	No	new or used	–
vehicle_type	string	No	AMS Vehicle Types	–
fuel_type_slugs	string	No	AMS Fuel Type Slugs	–
limit	int	No	Limits returned offers to maximum of the limit no matter how many series_ids are passed (sorted by price ascending)

Headers

Header	Description
Content-Type	application/json

Example Request

GET /ams/offer-by-series-native?series_ids=809,461,10023&vehicle_type_slug=limousine&fuel_type_slugs=Elektro,Diesel&offer_type=vehicle-leasing-offers

Response

{
    "message": "OK",
    "data": {
        "search_more_url": "mvd_type=vehicle-leasing-offers&mvd_sort=price_asc&mvd_fuel=Elektro%2CDiesel&mvd_customer_groups=privat&mvd_makes_models=audi-q3%2Cmercedes-benz-s-klasse",
        "offers": [
            {
                "name": "Audi Q3",
                "duration": "Laufzeit: 24 Monate",
                "km_per_year": "Kilometer pro Jahr: 10.000 km",
                "delivery_time": "Sofort verfügbar",
                "power": "Leistung: 150 PS / 110 kW | Diesel",
                "fuel_consumption": "Verbrauch: null l/100km / CO2: 132 g/km",
                "price": "282,00 €",
                "type": "vehicle-leasing-offers",
                "external_url": "https://redirect.mivodo.com?entity_id=d9ee5d67-b203-4795-b271-8917502cc6f1&entity_type=vehicle-leasing-offers&subpartner_id=5",
                "internal_url": "mvd_type=vehicle-leasing-offers&mvd_sort=price_asc&mvd_makes_models=audi-q3&mvd_fuel=electric%2Cdiesel&mvd_featured_id=d9ee5d67-b203-4795-b271-8917502cc6f1&mvd_featured_type=vehicle-leasing-offers&mvd_featured_context=share&mvd_subpartner_id=5&mvd_customer_groups=privat"
            },
            {
                "name": "Mercedes-Benz S-Klasse",
                "duration": "Laufzeit: 48 Monate",
                "km_per_year": "Kilometer pro Jahr: 10.000 km",
                "delivery_time": "Sofort verfügbar",
                "power": "Leistung: 330 PS / 243 kW | Diesel",
                "fuel_consumption": "Verbrauch: 7,2 l/100km / CO2: 187 g/km",
                "price": "1.177,01 €",
                "type": "vehicle-leasing-offers",
                "external_url": "https://redirect.mivodo.com?entity_id=db456e5b-9f5b-4064-8289-b78ae956e900&entity_type=vehicle-leasing-offers&subpartner_id=5",
                "internal_url": "mvd_type=vehicle-leasing-offers&mvd_sort=price_asc&mvd_makes_models=mercedes-benz-s-klasse&mvd_fuel=electric%2Cdiesel&mvd_featured_id=db456e5b-9f5b-4064-8289-b78ae956e900&mvd_featured_type=vehicle-leasing-offers&mvd_featured_context=share&mvd_subpartner_id=5&mvd_customer_groups=privat"
            }
        ]
    }
}

Status Codes

Status Code	Meaning
200	Success, data returned.
400	Invalid request parameters.
500	Internal server error.

Error Response Example

Example of a 404 error response:

{
    "status_code": 400,
    "timestamp": "2024-09-12T09:29:39.749Z",
    "path": "/ams/offer-by-series-native",
    "message": [
        "each value in series_ids must be an integer number",
        "series_ids must be an array"
    ]
}