DMS API Migration Guide
- Table of Contents
Introduction
As part of our platform modernization efforts, we are replatforming all our APIs to enhance performance, security, and functionality. This includes the DMS APIs, which require significant changes to align with modern technology stacks, state-of-the-art architecture, and contemporary software design principles.
To facilitate this transition, we are deprecating the existing APIs and allowing a four-month migration period for clients to switch to the new versions. After this period, the legacy APIs will be permanently discontinued, and only the new APIs described in this document will be available.
This guide provides an overview of the new APIs and demonstrates how to use them effectively.
By following this guide, you can seamlessly migrate to the new DMS APIs, improving performance, security, and flexibility. For further information, refer to the AutoScout24 API Documentation or contact our support team.
Legacy APIs Overview
The following API groups were previously used for DMS integrations:
- Dealers
- Admin
- Configurator Autoi
- Configurator Autoscout (masterdata)
- Configurator Eurotax
- Customer
- Promotion
- Publishing
Security: These legacy APIs were secured using IP whitelisting or API keys.
New APIs Overview
In line with RESTful principles and modern resilience patterns, we have moved away from monolithic designs. Instead, we have adopted a modular approach, where each API serves a specific purpose. This allows for greater flexibility, improved performance, and enhanced reliability.
All new APIs are fully documented on the AutoScout24 Developer Portal, including:
- API Reference ↗ – Comprehensive guide to integration, including authentication details, request/response samples, and error codes for seamless integration.
- OpenAPI Specification ↗ – Open API specification
- Swagger UI ↗ – Interactive API documentation
Within the Swagger documentation, the DMS APIs are organized into the following three groups. Only these APIs should be used for DMS integration:
- Client Authentication
- Inventory Management
- Configurator
By leveraging these new APIs, clients can build more efficient, resilient, and scalable integrations while ensuring compliance with the latest security and performance standards.
Note: This guide outlines one possible implementation approach. Clients are free to design their integrations according to their specific requirements.
Authentication and Authorization ↗
As part of our ongoing commitment to enhancing security, we have transitioned away from using IP address whitelisting and API keys for authentication. We now implement a robust client-credentials flow, aligned with modern security standards and industry best practices for API security. This change ensures more secure and scalable access control for our APIs.
For a detailed explanation of the new authentication and authorization mechanisms—including how to obtain client credentials and access tokens—please refer to our Developer Portal and API Reference documentation.
Inventory management APIs group
The inventory management API group consists of 4 subgroups listing APIs, version APIs, make & model APIs, and other APIs.
Here is a listing resource overview compared with the old vehicle resource for more details about the data type and example, see the Swagger UI.
Listing fields
Legend
- Black → same field, same name
- Red → same field, different name
- Orange → new field
| Listing resource field name | Vehicle resource field name | Note |
|---|---|---|
| availableForExchange | bitwiseProperties | |
| availableForLeasing | bitwiseProperties | |
| axis | axis | |
| batteryCapacity | batteryCapacity | |
| batteryHealthPercentage | NEW | |
| batteryRentPrice | batteryRentPrice | |
| bodyColor | bodyColorId | |
| bodyColorText | originalTextBodyColor | |
| bodyType | bodyTypeId | |
| bootHeight | bootHeight | |
| bootLength | bootLength | |
| bootVolume | bootVolume | |
| bootWidth | bootWidth | |
| certificationNumber | certificationCode | |
| chargingPlugType | NEW | |
| chargingPower | NEW | |
| chargingTime0To100 | NEW | |
| chargingTime0To80 | NEW | |
| co2Emission | co2Emission | |
| combustionEngineHorsePower | hpCombustionEngine | |
| conditionType | conditionTypeId | |
| consumptionCombined | consumptionTotal | |
| consumptionExtraUrban | consumptionLand | |
| consumptionUrban | consumptionCity | |
| cubicCapacity | ccm | |
| cylinderArrangement | cylinderDesignTypeId | |
| cylinders | cylinders | |
| description | comments | |
| directImport | bitwiseProperties | |
| doors | doors | |
| driveSystem | transmissionShaftId | |
| driveType | driveTypeId | |
| electricMotorHorsePower | hpElectro | |
| emissionStandard | pollutionNormTypeId | |
| energyLabel | consumptionRatingTypeId | |
| externalId | externalId | |
| fastChargingPlugType | firstRegMonth | |
| fastChargingPower | firstRegYear | |
| fastChargingTime0To100 | NEW | |
| fastChargingTime0To80 | NEW | |
| firstRegistrationDate | NEW | |
| firstRegistrationYear | NEW | |
| fuelType | fuelTypeId | |
| furnitureTransporter | bitwiseExtras | |
| gasConsumptionCombined | consumptionGasTotal | |
| gasConsumptionExtraUrban | consumptionGasLand | |
| gasConsumptionUrban | consumptionGasCity | |
| gears | gears | |
| hadAccident | bitwiseProperties | |
| handicappedAccessible | bitwiseProperties | |
| hasAdditionalSetOfTires | bitwiseExtras | |
| hasCrane | bitwiseExtras | |
| hasNewTires | bitwiseExtras | |
| hasRestrictorKit25Kw | bitwiseExtras | |
| hasRestrictorKit35Kw | bitwiseExtras | |
| hasTailLift | bitwiseExtras | |
| hasTarpaulin | bitwiseExtras | |
| hasWinch | bitwiseExtras | |
| height | height | |
| horsePower | hp | |
| inspected | bitwiseProperties | |
| interiorColor | interiorColorId | |
| interiorColorText | originalTextInteriorColor | |
| kiloWatts | kw | |
| language | originalTextLanguage | |
| lastInspectionDate | dateLastInspection | |
| length | length | |
| licenseCategory | licenseCategoryTypeId | |
| listPrice | priceNew | |
| metallic | isBodyColorMetallic | |
| mileage | km | |
| payload | payLoad | |
| powerConsumption | consumptionPower | |
| price | price | |
| racingVehicle | bitwiseProperties | |
| range | batteryRange | |
| refrigerator | bitwiseExtras | |
| restrictorKit25KwApplicable | NEW | |
| restrictorKit35KwApplicable | NEW | |
| schoolBus | bitwiseExtras | |
| seats | seats | |
| sellerVehicleId | customerVehicleCode | |
| serialNumber | serialNumber | |
| sleepingBerths | sleepingBerths | |
| teaser | teaser | |
| towingCapacityBraked | trailerLoadBreaked | |
| transmissionType | transmissionTypeId | |
| transmissionTypeGroup | ||
| transporter | bitwiseExtras | |
| tuned | bitwiseProperties | |
| vehicleIdentificationNumber | chassisCode | |
| versionFullName | typeNameFull | |
| versionId | NEW | |
| warrantyDetails | warrantyText | |
| warrantyDuration | warrantyInMonths | |
| warrantyMileage | warrantyMaxKm | |
| warrantyStartDate | warrantyDate | |
| warrantyType | warrantyTypeId | |
| weightCurb | weightKerb | |
| weightTotal | weightTotal | |
| wheelbase | wheelbase | |
| width | width | |
| makeKey | makeId | |
| modelKey | modelId | |
| vehicleCategory | vehicleTypeId | |
| versionIdentificationMethod | NEW |
Migration guide: Property differences
As observed in the table above and in the Swagger schema, several properties have changed in both naming and data type. For instance, the bodyTypeId property now uses a string representation of an enumeration rather than a numeric identifier.
A complete list of updated enumerated values is available via the **Get Reference Data ** API.
Another notable change is the deprecation of the bitwiseProperty field, which has been decomposed into multiple discrete Boolean fields: availableForExchange, availableForLeasing, directImport, hadAccident, handicappedAccessible, inspected, racingVehicle, and tuned. Each of these fields can hold true, false, or null values.
Similarly, bitwiseExtras has been refactored into individual Boolean fields representing specific flags.
These values can be retrieved and populated by using any of the new **Version APIs ** under the configurator section or via the **AutoScout Get Version ** API.
Search attributes
Search attributes are used to filter listings in the search result page (SRP) and product detail page (PDP).
We provide user-friendly names for all search attributes
| Search attribute values |
|---|
| abs |
| active-brake-assistant |
| adaptive-cruise-control |
| adaptive-headlights |
| additional-instrumentation |
| air-condition |
| air-suspension |
| alarm-system |
| alcantara |
| alloy-wheels |
| android-auto |
| anti-theft-device |
| apple-carplay |
| assisted-parking |
| audio-system |
| automatic-air-condition |
| auxiliary-heating |
| backrest |
| blind-spot-system |
| bluetooth-interface |
| 360-camera |
| catalytic-converter |
| chrome-parts |
| cloth-seats |
| cover |
| crash-bar |
| cruise-control |
| custom-exhaust |
| custom-handlebar |
| dab-radio |
| detachable-towbar |
| differential-locking |
| double-disc-brake |
| double-seat |
| electric-seat |
| electric-tailgate |
| esp |
| fast-charging |
| floorboard |
| full-partial-casing |
| hands-free-set |
| hardtop |
| head-up-display |
| heated-grips |
| heated-seats |
| hydraulic-system |
| isofix |
| keyless |
| kitchen |
| lane-assistant |
| laser-headlights |
| leather-seats |
| led |
| liftgate |
| luggage-rack |
| navigation |
| panorama-roof |
| parking-sensor-front |
| parking-sensor-rear |
| partial-leather-seats |
| portable-navigation-system |
| rear-camera |
| reinforced-suspension |
| retarder-intarder |
| retractable-towbar |
| saddlebag |
| shower |
| sliding-door |
| solo-seat |
| speaker |
| special-paint |
| spoked-wheels |
| sport-seats |
| start-stop-system |
| suitcase |
| sunroof |
| tank-bag |
| toilet |
| top-case |
| towbar |
| traction-control |
| tv |
| twin-headlights |
| ventilated-seats |
| windshield |
| wing-doors |
| xenon-headlights |
| electric-windows |
Listing group API
Get listing
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get listings ↗ | GET | /public/v1/sellers/{sellerId}/listings | Returns listings for the specified seller ID. | |
| Get listing ↗ | GET | /public/v1/sellers/{sellerId}/listings/{listingId} | Returns listing details for the specified seller ID and listing ID. | |
| Get listing by externalId ↗ | GET | /public/v1/sellers/{sellerId}/listings/external-id/{externalId} | Returns a listing for the specified seller ID and external ID. | |
| Get listing by sellerVehicleId ↗ | GET | /public/v1/sellers/{sellerId}/listings/seller-vehicle-id/{sellerVehicleId} | Returns a listing for the specified seller ID and seller vehicle ID. |
Listing operations
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Create listing ↗ | POST | /public/v1/sellers/{sellerId}/listings | Creates a listing for the specified seller ID. | This will create a listing in draft status, for status manipulation use activate, deactivate, and remove api. |
| Update listing ↗ | PUT | /public/v1/sellers/{sellerId}/listings/{listingId} | Updates the existing listing for the specified seller ID and listing ID. | |
| Delete listing ↗ | DELETE | /public/v1/sellers/{sellerId}/listings/{listingId} | Deletes listing for the specified seller ID and listing ID. | The listing will be permanently removed. |
| Activate listing ↗ | POST | /public/v1/sellers/{sellerId}/listings/{listingId}/activate | Activates listing for the specified seller ID and listing ID. | The listing will be submitted for verification and will be activated within 20 minutes. |
| Deactivate listing ↗ | POST | /public/v1/sellers/{sellerId}/listings/{listingId}/deactivate | Deactivates listing for the specified seller ID and listing ID. | The listing will no longer be visible and will be removed from the vehicle pool after one year. |
| Remove listing ↗ | POST | /public/v1/sellers/{sellerId}/listings/{listingId}/remove | Removes listing for the specified seller ID and listing ID. | The listing will no longer be visible and will be permanently deleted after 90 days. |
Migration Guide: Create and Update Listing
Listing lifecycle status explanation:
Active → Listing will be visible for the search result page (SRP) and product detail page (PDP) shortly after verification is done.
Deactive → Listing will be removed from the search result page (SRP) and product detail page (PDP) immediately after this action.
Remove → Listing will be removed from the search result page (SRP) and product detail page (PDP) immediately after this action, and will be eligible for deletion after 90 days have passed.
Previous Flow
Previously, the following APIs were used to create a Eurotax, Autoi or AutoScout24 vehicle:
-
POST /public/v1/accounts/{accountId}/eurotax/vehicles -
POST /public/v1/accounts/{accountId}/autoi/vehicles -
POST /public/v1/accounts/{accountId}/as24/vehicles
To update an existing Eurotax, Autoi or AutoScout24 vehicle, these APIs were used:
-
PUT /public/v1/accounts/{accountId}/eurotax/vehicles/{vehicleId} -
PUT /public/v1/accounts/{accountId}/autoi/vehicles/{vehicleId} -
PUT /public/v1/accounts/{accountId}/as24/vehicles/{vehicleId}
New Flow
To create a new listing, use the following endpoint:
POST /public/v1/sellers/{sellerId}/listings
To update an existing listing, use:
PUT /public/v1/sellers/{sellerId}/listings/{listingId}
Important:
The new APIs do not support equipment data. For handling vehicle equipment, please refer to the Listing equipment guide.
Listing images
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get images ↗ | GET | /public/v1/sellers/{sellerId}/listings/{listingId}/images | Returns images for the specified seller ID and listing ID. | |
| Set images ↗ | PUT | /public/v1/sellers/{sellerId}/listings/{listingId}/images | Sets images for the specified seller ID and listing ID. | This will set the order of the previously uploaded images, |
| Upload image ↗ | POST | /public/v1/sellers/{sellerId}/listings/{listingId}/images/upload | Uploads single image to the specified seller ID and listing ID. | This will upload the image, keep in mind that this does not set images. For setting images, use the Set images API. |
Migration Guide: Image Upload and Management
Previous Flow
Previously, the following API was used to upload and set images for a vehicle:
PUT /public/v1/accounts/{accountId}/vehicles/{vehicleId}/images
New Flow
To upload and set images for a specific listing, migrate to the following endpoints:
-
Upload a single image:
POST /public/v1/sellers/{sellerId}/listings/{listingId}/images/uploadYou must call this endpoint once per image (i.e., n times for n images).
-
Set all uploaded images:
PUT /public/v1/sellers/{sellerId}/listings/{listingId}/imagesThis endpoint is used to define the complete list and order of images.
Order matters, and any image not included in the request will be deleted.
To delete an image, simply omit its corresponding key from the request payload when calling the PUT endpoint.
Listing equipment
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get listing equipment ↗ | GET | /public/v1/sellers/{sellerId}/listings/{listingId}/equipment | Returns localized seller listing equipment. | |
| Set listing equipment ↗ | PUT | /public/v1/sellers/{sellerId}/listings/{listingId}/equipment | Sets equipment for the specified seller ID and listing ID. | In order to get equipment id use Get version equipment. |
| Set Eurotax format equipment ↗ | PUT | /public/v1/configurator/eurotax/sellers/{sellerId}/listings/{listingId}/equipment | Sets equipment provided in Eurotax format for the specified seller ID and listing ID. | |
| Set Eurotax Autoscount format equipment ↗ | PUT | /public/v1/configurator/eurotax-autoscout/sellers/{sellerId}/listings/{listingId}/equipment | Sets Eurotax equipment provided in Autoscout format for the specified seller ID and listing ID. | |
| Set Autoi format equipment ↗ | PUT | /public/v1/configurator/autoi/sellers/{sellerId}/listings/{listingId}/equipment | Sets equipment provided in Autoi format for the specified seller ID and listing ID. | |
| Set Autoi Autoscount format equipment ↗ | PUT | /public/v1/configurator/autoi-autoscout/sellers/{sellerId}/listings/{listingId}/equipment | Sets Autoi equipment provided in Autoscout format for the specified seller ID and listing ID. |
Migration Guide: Equipment Handling
Previous Flow
Equipment was previously configured as part of the listing creation API flow.
See: Listing operation: Create and Update Listing Migration Guide
New Flow
To set AutoScout24 equipment for a listing, follow these steps:
-
Fetch available equipment for a version:
GET /public/v1/versions/{versionId}/equipment -
Set selected equipment for your listing:
PUT /public/v1/sellers/{sellerId}/listings/{listingId}/equipment
Eurotax equipments
Eurotax format
label and price fields in the request are optional.
All provided equipments must have checked:true no matter if they are standard or optional options or standard or optional package items.
Request example
{
"eurotaxEquipments": [
{
"label": {
"de": "3-Punkt-Sicherheitsgurte auf allen Plätzen",
"fr": "Ceintures de sécurité à 3 points à toutes les places",
"it": "Cinture di sicurezza a 3 punti a tutti i posti"
},
"price": null,
"id": 1039155,
"checked": true,
"groupId": null,
"isStandard": true
},
{
"label": {
"de": "Ablagen in den Türen",
"fr": "Rangement bas de porte",
"it": "Vani nelle porte"
},
"price": null,
"id": 1045499,
"checked": true,
"groupId": null,
"isStandard": true
},
{
"label": {
"de": "Technikpaket",
"fr": "Pack technique",
"it": "Pacchetto Tecnico"
},
"price": 2415,
"id": 4384464,
"checked": true,
"groupId": null,
"isStandard": false
},
{
"label": {
"de": "Assist: Einparkhilfe plus",
"fr": "Assist: Aide au parking arrière plus",
"it": "Assist: Aiuto al parcheggio plus"
},
"price": null,
"id": 4384132,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Innenspiegel automatisch abblendbar",
"fr": "Rétroviseur intérieur réglable jour/nuit automatique",
"it": "Retrovisore interno regolabile giorno notte automatico"
},
"price": null,
"id": 4383708,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Klima: 3-Zonen-Klimatisierungsautomatik",
"fr": "Climatisation automatique confort 3 zones",
"it": "Climatizzatore automatico confort 3 zone"
},
"price": null,
"id": 4383814,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Komfortschlüssel, advanced key",
"fr": "Advanced Key",
"it": "Advanced Key"
},
"price": null,
"id": 4382803,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Licht: Licht- und Regensensor",
"fr": "Détecteur de luminosité et de pluie",
"it": "Sensore pioggia/luci"
},
"price": null,
"id": 1043482,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Matrix LED Scheinwerfer",
"fr": "Matrix Projecteurs LED",
"it": "Matrix Proiettori LED"
},
"price": null,
"id": 4382698,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Tempomat",
"fr": "Régulateur de vitesse",
"it": "Regolatore di velocità"
},
"price": null,
"id": 1035813,
"checked": true,
"groupId": null,
"isStandard": true
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Response example (Get listing equipment ↗)
{
"standard": [
{
"name": "Tempomat",
"id": 1392,
"packageItems": []
},
{
"name": "Ablagen in den Türen",
"id": 5450,
"packageItems": []
},
{
"name": "3-Punkt-Sicherheitsgurte auf allen Plätzen",
"id": 5277,
"packageItems": []
}
],
"optional": [
{
"name": "Technikpaket",
"id": 106414,
"packageItems": [
"komfortschlussel-advanced-key",
"licht-licht-und-regensensor",
"assist-einparkhilfe-plus",
"innenspiegel-automatisch-abblendbar",
"matrix-led-scheinwerfer",
"klima-3-zonen-klimatisierungsautomatik"
]
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Eurotax Autoscout format
Request example
{
"standard": [
{
"id": 1035813,
"packageItems": []
}
],
"optional": [
{
"id": 4384464,
"packageItems": [
4384132,
4383708,
4383814,
4382803,
1043482,
4382698
]
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Response example (Get listing equipment ↗)
{
"standard": [
{
"name": "Tempomat",
"id": 1392,
"packageItems": []
}
],
"optional": [
{
"name": "Technikpaket",
"id": 106414,
"packageItems": [
"komfortschlussel-advanced-key",
"licht-licht-und-regensensor",
"assist-einparkhilfe-plus",
"innenspiegel-automatisch-abblendbar",
"matrix-led-scheinwerfer",
"klima-3-zonen-klimatisierungsautomatik"
]
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Eurotax equipment search attributes
For both Eurotax and Eurotax Autoscout format equipment APIs, the searchAttributes are determined by merging the provided ones with the
values stored in our database for the specific equipment.
Autoi equipments
Autoi format
price field in the request is optional.
Request example
{
"autoiEquipments": [
{
"label": {
"de": "3-Punkt-Sicherheitsgurte auf allen Plätzen",
"fr": "Ceintures de sécurité à 3 points à toutes les places",
"it": "Cinture di sicurezza a 3 punti a tutti i posti"
},
"price": null,
"id": 1039155,
"checked": true,
"groupId": null,
"isStandard": true
},
{
"label": {
"de": "Ablagen in den Türen",
"fr": "Rangement bas de porte",
"it": "Vani nelle porte"
},
"price": null,
"id": 1045499,
"checked": true,
"groupId": null,
"isStandard": true
},
{
"label": {
"de": "Technikpaket",
"fr": "Pack technique",
"it": "Pacchetto Tecnico"
},
"price": 2415,
"id": 4384464,
"checked": true,
"groupId": null,
"isStandard": false
},
{
"label": {
"de": "Assist: Einparkhilfe plus",
"fr": "Assist: Aide au parking arrière plus",
"it": "Assist: Aiuto al parcheggio plus"
},
"price": null,
"id": 4384132,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Innenspiegel automatisch abblendbar",
"fr": "Rétroviseur intérieur réglable jour/nuit automatique",
"it": "Retrovisore interno regolabile giorno notte automatico"
},
"price": null,
"id": 4383708,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Klima: 3-Zonen-Klimatisierungsautomatik",
"fr": "Climatisation automatique confort 3 zones",
"it": "Climatizzatore automatico confort 3 zone"
},
"price": null,
"id": 4383814,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Komfortschlüssel, advanced key",
"fr": "Advanced Key",
"it": "Advanced Key"
},
"price": null,
"id": 4382803,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Licht: Licht- und Regensensor",
"fr": "Détecteur de luminosité et de pluie",
"it": "Sensore pioggia/luci"
},
"price": null,
"id": 1043482,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Matrix LED Scheinwerfer",
"fr": "Matrix Projecteurs LED",
"it": "Matrix Proiettori LED"
},
"price": null,
"id": 4382698,
"checked": true,
"groupId": 4384464,
"isStandard": true
},
{
"label": {
"de": "Tempomat",
"fr": "Régulateur de vitesse",
"it": "Regolatore di velocità"
},
"price": null,
"id": 1035813,
"checked": true,
"groupId": null,
"isStandard": true
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Response example (Get listing equipment ↗)
{
"standard": [
{
"name": "Tempomat",
"id": 1392,
"packageItems": []
},
{
"name": "Ablagen in den Türen",
"id": 5450,
"packageItems": []
},
{
"name": "3-Punkt-Sicherheitsgurte auf allen Plätzen",
"id": 5277,
"packageItems": []
}
],
"optional": [
{
"name": "Technikpaket",
"id": 57937,
"packageItems": [
"advanced key",
"Licht: Licht- und Regensensor",
"Assist: Einparkhilfe plus",
"Matrix LED Scheinwerfer",
"Klima: 3-Zonen-Klimatisierungsautomatik",
"Innenspiegel automatisch abblendbar",
"Komfortschlüssel"
]
}
],
"searchAttributes": [
"automatic-air-condition",
"cruise-control",
"parking-sensor-front",
"keyless",
"led",
"parking-sensor-rear"
]
}
Autoi Autoscout format
Request example
{
"standard": [
{
"label": {
"de": "Design- und Ausstattungslinie AVANTGARDE",
"fr": "Ligne de design et d'équipement",
"it": "Linea di design ed allestimento"
},
"packageItems": []
},
{
"label": {
"de": "EASY-PACK zusätzlicher Ladeboden mit",
"fr": "Plancher de chargement supplémentaire",
"it": "Pavimento di carico supplementare"
},
"packageItems": []
}
],
"optional": [
{
"label": {
"de": "Technikpaket",
"fr": "Pack technique",
"it": "Pacchetto Tecnico"
},
"packageItems": [
{
"de": "Assist: Einparkhilfe plus",
"fr": "Assist: Aide au parking arrière plus",
"it": "Assist: Aiuto al parcheggio plus"
}
]
},
{
"label": {
"de": "Aussenspiegel in Hochglanzschwarz",
"fr": "Rétroviseurs extérieurs en couleur noir finition brillante",
"it": "Retrovisori esterni in nero brillante"
},
"packageItems": []
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Response example (Get listing equipment ↗)
{
"standard": [
{
"name": "Design- und Ausstattungslinie AVANTGARDE",
"id": 32725,
"packageItems": []
},
{
"name": "EASY-PACK zusätzlicher Ladeboden mit",
"id": 166077,
"packageItems": []
}
],
"optional": [
{
"name": "Technikpaket",
"id": 243254,
"packageItems": [
"Assist: Einparkhilfe plus"
]
},
{
"name": "Aussenspiegel in Hochglanzschwarz",
"id": 13469,
"packageItems": []
}
],
"searchAttributes": [
"parking-sensor-front",
"automatic-air-condition",
"led",
"keyless",
"parking-sensor-rear",
"cruise-control"
]
}
Note:
For Autoi and Eurotax equipment manipulation, please refer to the Listing Equipment section.
Version group API
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get version ↗ | GET | /public/v1/versions/{versionId} | Returns version details for the specified version ID. | This API could be used to prepopulate listing data for specific version. |
| Get version equipment ↗ | GET | /public/v1/versions/{versionId}/equipment | Returns version equipment details for the specified version ID. | This API returns standard and optional options, which could be used to set listing equipment. |
Make & Model group API
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get all makes ↗ | GET | /public/v1/makes | Returns a sorted list of makes for the specified vehicle category. | |
| Get all models ↗ | GET | /public/v1/makes/key/{makeKey}/models | Returns a sorted list of models for the specified makeKey and vehicle category. |
Other group API
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get all vehicle categories ↗ | GET | /public/v1/vehicle-categories | Returns a list of available vehicle categories. | |
| Get reference data ↗ | GET | /public/v1/reference-data | Returns reference data, optionally filtered by vehicle category. | Previously used GET /public/v1/configurator/as24/masterdata has been replaced with GET /public/v1/reference-data. |
Configurator
Version group API
Eurotax
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get versions by vehicle identification number ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/vehicle-identification-number/{vehicleIdentificationNumber} | Returns version information for the provided vehicle identification number. | Every request will be charged. |
| Get versions by make and model ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/make-key/{makeKey} | Returns a list of versions based on the make and model key. | |
| Get versions by certification number and production date ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/certification-number/{certificationNumber} | Returns a list of versions based on the certification number and production date. | |
| Get version by external id ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/external-id/{externalId} | Returns a specific version based on the provided seller ID and external ID (eurotax nat code). | |
| Get versions by serial number and production date ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/serial-number/{serialNumber} | Returns versions for a given serial number and production date. |
Autoi
This part is still in progress. It will be added in the near future.
Equipment group API
Eurotax
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get version’s equipment by vehicle identification number ↗ | GET | /public/v1/configurator/eurotax/sellers/{sellerId}/versions/vehicle-identification-number/{vehicleIdentificationNumber}/equipment | Returns version equipment information for the provided vehicle identification number. |
Autoi
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| to be added | to be added | to be added | to be added | to be added |
Other group API
| Operation | HTTP Method | Path | Api description | Note |
|---|---|---|---|---|
| Get energy label ↗ | GET | /public/v1/vehicle-energy-efficiency/detect | Returns detected vehicle energy efficiency. |
Deprecated or Unsupported Operations in the New API
The following operations are no longer supported in the new API flow:
-
Save Vehicle Document
- Deprecated and no longer supported.
-
Delete Vehicle Document
- Deprecated and no longer supported.
-
SavePrice
-
Single-field updates are not supported.
-
Use the Listing Update API to update the price as part of the full listing payload.
-
-
SaveFrequentlyChangedData (Price, Km, Teaser, and Comments)
-
Updating only these fields is not supported.
-
Use the Listing Update API to update the entire listing.
-
-
SaveRequiredData
- Refer to Swagger documentation to see the list of required fields.
-
GetEmptyVehicle
- Refer to Swagger and the Listing Create API for the correct request structure.