Table of Contents

Basics

Introduction

Overview

The mobile.de Seller-API is an interface to store seller vehicle and user data to the mobile.de-database and make them available on the platform as classified ads. It enables API users to carry out all necessary operations to manage the full lifecycle of listings from creation to deletion.

The API is available at this base URL:

https://services.mobile.de

Main features

  • Create a new ad

  • Delete an ad

  • List all sellers ads

  • List all sellers of an API-account

  • Upload images

  • Change the order of existing images

  • Create Direct Offer for an ad

  • Get Direct Offer for an ad

Prerequisites

Seller API Access can be granted to Transfer Service Providers and Self-Uploading Dealers registered with mobile.de. Self-Uploading Dealers or their tool developers/agencies who only want to provide data for their own account won’t need a separate Seller-API-Account. In case of a company group with one or more accounts belonging to the same company each account will be seen independently and transfer has to be done using the individual upload credentials of each account. They just need to send an email to service@team.mobile.de with the following information

  • the affected mobile.de customer number and company name

  • the request for the customers Seller-API activation

For Transfer Service Providers who want to operate as a TSP for more than ten customers, since the Seller APIs is a highly complex topic, we need the following information to be send to service@team.mobile.de:

  • The name, email and telephone number of the person who handles contractual issues for the requesting company.

  • The name, email and telephone number of the person who handles technical issues for the requesting company.

  • What kind of software applications or tools are currently used (commercial software applications)?

  • Which platform will be supplied? (mobile.de / automobile.fr)?

  • The complete company address.

  • The VAT ID of the requesting company.

  • All mobile.de customer numbers who should be supplied (min. 10)

Limited support for the development process and maintenance:

Please note that all examples provided in our documentation are considered as guidelines for your development process but mobile.de for itself is not able to directly assist with any of your preferred programming languages and/or used scripts.

Test Account

A test environment can be provided. Please send us all information mentioned in our Prerequisites to service@team.mobile.de. For more details see section API Sandbox.

Quick Start

Make a sample REST API call to the testing environment of mobile.de.

Preparation

cURL: This example is using cURL, an open source command line tool, to make http requests. On Mac or Linux systems cURL is usually pre-installed, Windows users can find cURL at https://curl.haxx.se.

For this example you need read access to the Seller API in the API Sandbox environment. Please refer to the Getting a Test Account to get access to the testing environment.

Further Readings:

Make a Test Call

The previous step equipped you with a username and password for the test system. Lets make a test call and list all sellers associated to your test account.

Request
curl -vs -u username:password \
     -H "Accept: application/vnd.de.mobile.api+json" \
     https://sandbox.services.mobile.de/seller-api/sellers
Response
"sellers": [
    {
      "mobileSellerId": "884",
      "customerNumber": "873",
      "type": "DEALER",
      "siteId": "GERMANY",
      "readonly": false,
      "settings": {
        "maxImages": 15,
        "maxHighlights": 1,
        "automatedExports": [
          {
            "marketplace": "ebay-kleinanzeigen.de",
            "eligible": true,
            "active": false
          }
        ],
        "videoUrl": false
      },
      "companyName": "The Wall"
    }
  ]
}

Access and Testing

Authentication and Authorization

The API is available at this base URL:

https://services.mobile.de

In order to upload listings on behalf of mobile.de customers you’ll need to register as an API user on the mobile.de platform. Please contact the Customer Support for further details about the activation process!

The user must be authenticated with a username and password using the HTTP basic authentication scheme. For detailed information on HTTP basic authentication see

During the activation process the Customer Support will provide you with instructions how to get the access credentials. The credentials are unique for each API user and do not dependent on sellers or ads.

API Sandbox

Please note that the returned location headers for POST requests are currently pointing to the production environment.

For testing purposes an api sandbox environment is available.

https://sandbox.services.mobile.de

The sandbox only offers the full functionality of the following apis:

Getting a Test Account

The API test account can be requested by email to service@team.mobile.de. The email should state that you request an API User account for the API Sandbox environment. Including your project and your requirements.

High Level Concepts

API User / TSP

An API user is the entity that has an API account and uses that account to post ads for one or more sellers (which are linked to that account) to the API. Usually the API user is a TSP (Transfer Service Provider) which posts ads for a larger number of sellers. For posting the API User is using his API User authentication credentials for every assigned seller. This is for TSPs wo are having a web based platform.

API User / TSP with individual sellers

In addition to the standard API User / TSP definition on top where the API User is using the API User credentials for API usage there is the possibility to create individual dealer upload credentials also for TSP managed sellers. This is called Self-Upload-Account. This is for TSPs managing several dealers providing an offline based tool where the credentials would be stored on the dealers device.

Individual Dealer

A dealer is able to use the API like a TSP but only for his dealer account. When the Upload Interface is activated an API_User is created. This is for dealers having own tools to manage the inventory on mobile.de.

The ad represents a vehicle for sale that is published on the mobile.de platform. It consists among the others of:

  • vehicle details

  • price

  • images

  • booked features - e.g. TopOfPage to make an appear on the top of the search results to increase the sell probability

Seller

The seller represents information about the owner of the vehicle. It consists among the others of:

  • company name (for commercial sellers)

  • name of the seller (for private sellers)

  • address

  • contact details

mobileAdId

A unique identifier of an ad published on the mobile.de platform. It is primarily used to identify a particular ad when invoking a rest call. For this purpose the mobileAdId is passed as a path parameter.

mobileSellerId

A unique identifier of a seller that publishes ads on the mobile.de platform.

Image Reference

A unique url that identifies an image on the mobile.de platform. This is also known as image url or simply image ref. The image refs are used for associating uploaded images with ads.

{
    "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"
}

Site Id

Also knows as Site Key.

The mobile.de runs different websites in different countries. For example http://www.mobile.de in Germany and http://www.automobile.it in Italy. Each of those sites is identified by a site-key.

You can find a full list of the site ids in our reference data.

However this API is for all of those sites but for the various sites there may exist some different rules for offering a vehicle and different sets of reference data (make and model sets, vehicle classes and feature sets) might be visible.

Each seller is at home on one of these sites. When posting ads, they are created on the site where the seller is at home and so the specific reference data and validation rules of that site apply to new ads.

This is why you should know on which site your sellers are at home. See Seller Resource section to find out the site ids of your sellers.

Reference Data

Reference data is a set of tables that define valid values for a number of fields such as colors, makes, models and others.

For example. Valid values for the field gearbox are defined by the reference data endpoint https://services.mobile.de/refdata/gearboxes.

Please refer to the Reference Data full details section for more information.

Cross Cutting Technical Concerns

This section contains rules and behaviours that are common for all mobile.de apis. Please adhere to the these guides for all api calls unless specified otherwise in the detailed documentation for a particular service call.

REST

In general the API follows the conventions for REST-APIs. All communication is done via HTTP. Correct combination of request methods (verbs) and URL trigger the actions of the API.

You can find more information about the REST principles here:

http://en.wikipedia.org/wiki/Representational_State_Transfer

Resource

A resource in REST terminology means a piece of information such as Ad, Seller or Image.

Http Verbs

Where possible, the Seller API strives to use appropriate HTTP verbs (methods) for each action.

GET

Used for retrieving resources.

POST

Used for creating resources.

PUT

Used for replacing resources or collections.

DELETE

Used for deleting resources.

Idempotent Methods

An idempotent http method is an operation that when called multiple times it does not change state on the server side. The GET, PUT and DELETE are idempotent. The POST operation in general is not idempotent as each call creates a new resource on the server.

Status Codes

Http status codes represents a result of an api call.

200 (OK)

A successful API call will be indicated by an HTTP-status code 200 (OK).

201 (created)

When you have posted something, a successful API call will be indicated by an HTTP-status code 201 (created). Have a look at the returned HTTP header Location.

It contains the URL of the newly created resource and you should memorize at least the id or key of that item, which you can find at the end of the URL.

Example of a newly created ad with the mobileAdId 456:

Location: https://services.mobile.de/seller-api/sellers/123/ads/456
204 (no content)

After deleting something (HTTP method DELETE) a successful API call will be indicated by an HTTP-status code 204 (No Content), though that resource no longer exists.

400 (bad request)

This code is returned when there is something wrong with the content that you have sent. In most cases the response payload contains more details about what went wrong. See Error Responses for more details.

401 (Unauthorized)

The access credentials are not correct. Please see [Authentication and Authorisation] section for more details.

403 (Forbidden)

The API user doesn’t have sufficient permissions to perform the api call.

404 (not found)

This status code is returned when you are trying to access a resource that does not exist. In a simple case this can be a typo in the path you are accessing, but this can also have another reason:

From your point of view, only sellers that are linked to your API account are visible. So if you try to read or write data for a seller that is not linked to your account and therefore not existing in your API universe, you will get an HTTP status code 404.

Example.

The seller with the Id 123 is linked to your account, the seller with the Id 456 is not. Posting an ad to /seller-api/sellers/123/ads results in an HTTP status 201 (created) whereas posting an ad to /seller-api/sellers/456/ads results in an HTTP status 404 (not found).

If you keep getting not found errors, check the following list of possible error causes:

  • Do you use the correct seller-key in your requests URLs?

    Make sure you send your requests to the correct URL containing the seller-key of the customer you are servicing. Ask Customer Support whether the customer account had been properly set for TSP servicing with your mobile.de TSP account.

  • Do you use the correct HTTP method and API service URL?

    Take a look at the API Use Case table provided below and make sure you got the API base URL, resource path and HTTP method right.

405 (method not allowed)

This status code indicates that the endpoint either doesn’t support specified http verb (method) or the requested media type is not supported. Please check the value of the Accept header is correct as specified in the Media Types section.

415 (unsupported media type)

The write endpoint doesn’t accept data in specified format. Please check the value of the Content-Type header is correct as specified in the Media Types section.

5xx

If you receive an HTTP code starting with 5 it indicates that the service faced an internal error. Please contact Customer Support and report the error.

Path Parameters

The api uses path parameters to identify resources. A path parameter is a part of the url that must be replaced with some value (usually a resource id) when making an api call. Parameters are named (prefixed with ":") to make it possible to refer to particular parameter.

For example:

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId

contains two path parameters: mobileSellerId and mobileAdId. When making an api call the values must be specified for all parameters, e.g. assuming that mobileSellerId=12 and mobileAdId=34 the url will be

/seller-api/sellers/12/ads/34

Media Types

The api exchanges the data using either json or xml format. Both representations (media types) use the same schema in terms of fields names and types. Detailed description of data structures for individual operations is available in the Resources Reference section.

The api client indicates the preferred data representation using the Accept header for reading use cases (GET requests) and the Content-Type header for writing use cases (PUT, POST requests).

Operation Media type Http header

read

json

Accept: application/vnd.de.mobile.api+json

write

json

Content-Type: application/vnd.de.mobile.api+json

read

xml

Accept: application/vnd.de.mobile.api+xml

write

xml

Content-Type: application/vnd.de.mobile.api+xml

Json Representation

Sample json response.

GET /seller-api/sellers/12 HTTP/1.1
Accept: application/vnd.de.mobile.api+json
{
    "mobileSellerId": "12",
    "customerNumber": "8",
    "type": "DEALER",
    "siteId": "GERMANY",
    "readonly": false,
    "settings": {
        "maxImages": 30,
        "maxHighlights": 3,
        "usedCarSeals": [
            "VW",
            "AUDI"
        ],
        "automatedExports" : [
            {
                "eligible" : true,
                "marketplace" : "ebay-kleinanzeigen.de",
                "active" : false
            }
        ],
        "videoUrl" : true
    },
    "companyName": "Smoke AG"
}

Xml Representation

Sample xml response.

GET /seller-api/sellers/12 HTTP/1.1
Accept: application/vnd.de.mobile.api+xml
<?xml version="1.0" encoding="UTF-8"?>
<seller>
  <mobileSellerId>12</mobileSellerId>
  <customerNumber>8</customerNumber>
  <type>DEALER</type>
  <siteId>GERMANY</siteId>
  <readonly>false</readonly>
  <settings>
    <maxImages>15</maxImages>
    <maxHighlights>3</maxHighlights>
    <usedCarSeals>
        <value>VW</value>
        <value>AUDI</value>
    </usedCarSeals>
    <automatedExports>
        <automatedExport>
            <marketplace>ebay-kleinanzeigen.de</marketplace>
            <eligible>true</eligible>
            <active>false</active>
         </automatedExport>
    </automatedExports>
    <videoUrl>true</videoUrl>
  </settings>
  <companyName>Smoke AG</companyName>
</seller>

Error Responses

The Seller-API responds with HTTP status 400 (bad request) in case of user caused errors. This includes among the other cases like:

  • unparsable json or xml,

  • syntactically incorrect data - e.g. json data that doesn’t match the schema

  • validation errors - e.g. mandatory fields are missing

In such cases the api tries to include in the error response as much details as possible to help the user to identify the problem.

The error message is sent as the response body using the following schema Error Response

Sample xml parsing response
<?xml version="1.0" encoding="UTF-8"?>
<errorResponse>
  <errors>
    <error>
      <key>xml-parse-error</key>
      <args>
        <arg>
          <key>parser-message</key>
          <value>ParseError at [row,col]:[1,768]
Message: The element type "vehicleClass" must be terminated by the matching end-tag "&lt;/vehicleClass&gt;".</value>
        </arg>
        <arg>
          <key>line</key>
          <value>1</value>
        </arg>
        <arg>
          <key>column</key>
          <value>768</value>
        </arg>
      </args>
    </error>
  </errors>
</errorResponse>
Sample validation response
{
    "errors": [
        {
            "key": "envkv_energy_efficiency_class_is_empty"
        },
        {
            "key": "delivery-period-xor-delivery-date"
        }
    ]
}

The representation of the error response is dictated by the requested media type. See Media Types for more details.

For more details about validation rules for individual resources please visit the [Resources] section.

Special characters in payload

Please make sure to escape any special characters in your JSON and XML payload before sending requests. Ideally, this is automatically handled by your client library. Escapes or unescapes a string removing traces of reserved characters that could prevent parsing.

The following characters are reserved in JSON and must be properly escaped to be used in strings:

  • Double quote is replaced with \"

  • Backslash is replaced with \\

For a full list of reserved characters in JSON please visit http://www.json.org.

Example

Escaping \\ linebreaks for the advanced vehicle discription with WIKI syntax:

{
    "description": "The vehicle has the following additional features:\\\\ * Winter tires Warranty\\\\ * Warranty"
}

Concurrency

Do not send multiple requests for the same ad at the same time. Always wait for the request to be finished before sending the next one (in scope of the same ad) or you will run into problems.

E.g. do not update one ad’s images while another image-update-call for the same ad is still in progress.

Date Time Representation

This part contains general information regarding how to work with date/time based fields in the APIs of mobile.de.

Date Time

The datetime information is represented as text that conforms to the ISO_8601 standard. It is formatted using the Europe/Berlin time zone offset, for example 2015-12-01T18:40:44+01:00.

Json example
{
    "creationDate": "2015-12-01T18:40:44+01:00"
}
Xml example
    <creationDate>2015-12-01T18:40:44+01:00</creationDate>

Month and Year

Some fields require only year and month precision. They are represented as text using yyyyMM format.

Example
{
    "firstRegistration": "200909",
    "generalInspection": "201611"
}

Year

The fields that require information only about the year are represented as a number using yyyy format.

Example
{
    "constructionYear": 2010
}

Working with Ad Data

Overview

Seller API allows you to manage your vehicle inventory in a programmatic way and integrate it with other applications. It enables you to carry out all necessary operations to handle the full lifecycle of listings from creation to deletion.

The main object that you’ll encounter in the API is the ad object. An ad object contains all the data necessary to visually display the vehicle as a listing on the mobile.de marketplace. Currently ad data are exchange in either JSON or XML format. All mobile.de APIs use the same unified data format, you can learn more about it here.

The ad object contains roughly three parts:
Platform meta data for the mobile.de, the vehicle for sale and additional information about the listing.
Platform Meta Data
mobileAdId

The unique identifier for an ad object on mobile.de marketplace.
Example: 123456789123
mobileSellerId

Reference to the seller of this ad object.
Example: 1234567
creationDate

The insertion date of the ad object.
Example: 2015-06-12T11:58:32+02:00
renewalDate

Last date the ad was marked as new. If this field is set, then the ad appears as a newly created ad in search results.
Example: 2015-06-12T11:58:32+02:00
Vehicle Data
classification

General classification of the vehicle.
Example: Car or Motorbike
category

Detailed classification of the vehicle.
Example: Cabrio or Limousine
make

Make of the vehicle.
Example: Mercedes or Toyota
model

Model of the vehicle.
Example: X5 or Prius
modelDescription

Detailed free text description of the vehicle. This is also used as ad title together with the make.
Example: Golf III always parked in garage
Additional Ad Information
price

Provides price information for the vehicle, including currency, VAT rate and price type.
deliveryDate

Date where the vehicle is ready to be delivered to the customer.
damageUnrepaired

Indicates if the vehicle has a damage. e.g. accident vehicle with body damage.

How Ad Data Are Rendered

Representation as JSON data in Seller API

This is an ad fragment in JSON format for demonstration purposes only, some fields are not included. 
{
  "mobileAdId": "57325222", (1)
  "mobileSellerId": "122976",
  "make": "VW",
  "model": "Touran",
  "category": "SmallCar", (2)
  "vehicleClass": "Car",
  "modelDescription": "Car Model Description and Title", (3)
  "damageUnrepaired": false,
  "firstRegistration": "201002",
  "mileage": 250011,
  "deliveryPeriod": 6,
  "price": {
    "consumerPriceGross": "12000.00", (4)
    "vatRate": "19.00",
    "type": "FIXED",
    "currency": "EUR"
  }
}

Representation as listing on mobile.de marketplace

This is how ad data are displayed in the public detail view on mobile.de.
Ad object representation on mobile.de

Workflow example

This section provides a sample workflow from creation to deletion of an ad. You’ll need mobileSellerId and mobileAdId in addition to your authentication credential in order to work with most endpoints in Seller API.

For more information about each resource, have a look at our Resources Reference.

(Optional) Upload images

PUT /seller-api/sellers/images
If you have images, use this endpoint to preupload them one by one before creating your ad. The response will be a reference for each uploaded image, which you have to include in your ad JSON. Please see Images Resource for more details how to upload images.

Image reference example:

{
    "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467631f9-acce-1e7f-ca2b-9f13912d713b?rule=mo-640.jpg"
}
Create a new ad

POST /seller-api/sellers/:mobileSellerId/ads
Insert a new ad for seller identified by mobileSellerId in the resource path. You can send either the complete ad data or only the required fields and update the rest later. At this point it is also possible to book paid features from mobile.de marketplace or order them in a separate update call. You’ll receive a new mobileAdId as reference in the Location header after the ad is created.

Ad created response example:

HTTP/1.1 201 Created
Location: https://services.mobile.de/seller-api/sellers/12/ads/217220
Retrieve ad

GET/seller-api/sellers/:mobileSellerId/ads/:mobileAdId
To retrieve your newly created ad, use GET on the ad resource. See Data Example for some sample data.

Update ad data

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId
To change your ad after it was created, use PUT on the ad resource. The request body must be the complete ad with all fields.

View statistics

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/statistic
Seller API also provides various statistics about your ad performance through this endpoint.

Mark ad as new

POST /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/vehicle-attribute/renewal-date
Use POST on the renewal-date endpoint to renew your ad. It will be relisted and appears like a new ad in search results.

Book features

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId
Book additional paid ad features from mobile.de marketplace to increase your ad performance, e.g. highlight ad with a larger preview image on top of the search result page.

Delete ad

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId
To delete your old ads, use DELETE on the ad resource. Seller API will response with HTTP 200 status when the ad was successfully deleted. All associated images will be purged as well.

How to handle errors

Errors during ad creation and update

In case the submitted data or call syntax in general is incorrect the api call results in HTTP 400 status response. Seller API will provide an error-key as feedback, if available. You can find the explaination for each error key under Error Keys.

Example response with error-key:

HTTP/1.1 400 Bad Request

{
    "errors": [
        {
            "key": "invalid-value"
            "args": [
                {
                    "key": "path",
                    "value": "gearbox"
                },
                {
                    "key": "invalid-value",
                    "value": "XYZ"
                }
            ],
        }
    ]
}

Upload image failures

Once uploaded, the image could be associated with a newly created or existing ad. Calls may take longer duration due to file uploading and storage, so consider checking the timeouts and/or retries in case of an error. In case Seller API response with an error-key, you can check the details in this list for image error keys.

Data Example

This section provides some sample data from a typical ad object in JSON format.

For a complete description of all fields, see Ad Schema. 
{
  "mobileAdId": "123456789",
  "mobileSellerId": "98761",
  "creationDate": "2016-12-06T12:55:36+01:00",
  "modificationDate": "2017-03-02T14:22:47+01:00",
  "uploadSticky": false,
  "vehicleClass": "Car",
  "category": "EstateCar",
  "make": "AUDI",
  "model": "A4",
  "modelDescription": "A4 Avant 2.0 TFSI multitronic Attraction",
  "condition": "USED",
  "firstRegistration": "201002",
  "mileage": 250011,
  "cubicCapacity": 1984,
  "power": 155,
  "gearbox": "AUTOMATIC_GEAR",
  "fuel": "PETROL",
  "fourWheelDrive": true,
  "envkvCompliant": true,
  "energyEfficiencyClass": "A",
  "co2": 172,
  "consumptionInner": 9.8,
  "consumptionOuter": 5.9,
  "consumptionCombined": 7.3,
  "consumptionUnit": "LITER",
  "envkvPetrolType": "SUPER",
  "emissionSticker": "EMISSIONSSTICKER_GREEN",
  "images": [
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acce-1e7f-ca2b-9f13912d713b?rule=mo-640.jpg",
          "hash": "fda8487ed7fcfbecdf1eb55cf582fccf"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acce-1d7f-ca2b-9f13912d713b?rule=mo-640.jpg",
          "hash": "fda8487ed7fcfbecdf1eb55cf582fccf"
        }
  ],
  "emissionClass": "EURO4",
  "exteriorColor": "SILVER",
  "manufacturerColorName": "Silver Moon",
  "doors": "FOUR_OR_FIVE",
  "seats": 5,
  "interiorColor": "GREY",
  "interiorType": "ALCANTARA",
  "generalInspection": "201402",
  "constructionDate": "2010-07-15T00:00:00+02:00",
  "numberOfPreviousOwners": 2,
  "countryVersion": "DE",
  "roadworthy": false,
  "abs": true,
  "airbag": "FRONT_AND_SIDE_AND_MORE_AIRBAGS",
  "alloyWheels": true,
  "centralLocking": true,
  "climatisation": "AUTOMATIC_CLIMATISATION",
  "electricHeatedSeats": true,
  "electricWindows": true,
  "esp": true,
  "immobilizer": true,
  "powerAssistedSteering": true,
  "description": "This is really a nice car. The only strange thing is that so called flux capacitor that it is equipped with. The previous owner told me that he took it from an old DeLorean. No idea what it is good for.",
  "schwackeCode": 10110413,
  "deliveryPeriod": 6,
  "price": {
    "dealerPriceGross": "13090.00",
    "consumerPriceGross": "13090.00",
    "dealerPriceNet": "11000.00",
    "consumerPriceNet": "11000.00",
    "vatRate": "19.00",
    "type": "FIXED",
    "currency": "EUR"
  }

References

Resources Reference

This section contains a detailed description of all rest apis provided by the Seller API.

Please note the that below endpoints are available on the following base url:

https://services.mobile.de

Please refer to the Access and Testing paragraph to get more information how to access the api and the test environment.
Name Method Endpoint

Seller

List all sellers

GET

/seller-api/sellers

Retrieve a single seller

GET

/seller-api/sellers/:mobileSellerId

Retrieve ad feature settings

GET

/seller-api/sellers/:mobileSellerId/feature-settings

Retrieve individual contacts

GET

/seller-api/sellers/:mobileSellerId/individual-contacts

Retrieve multi locations

GET

/seller-api/sellers/:mobileSellerId/multi-locations

Ad

Create a new ad

POST

/seller-api/sellers/:mobileSellerId/ads

List all sellers ads

GET

/seller-api/sellers/:mobileSellerId/ads

Retrieve a single ad

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Update an ad

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Delete an ad

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Image

Upload Image

POST

/seller-api/images

Associate images

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Upload images multipart

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Get all image URLs

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Delete all images

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Auto Panorama

Upload Interior Image

POST

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior-image

Create Interior Auto Panorama

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Get Interior Auto Panorama

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Delete Interior Auto Panorama

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Upload Exterior Image

POST

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior-image

Create Exterior Auto Panorama

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Get Exterior Auto Panorama

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Delete Exterior Auto Panorama

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Price Rating

Retrieve ad price rating

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/price-rating

Preview ad price rating

POST

/seller-api/sellers/:mobileSellerId/ads/price-rating

Statistic

Retrieve ad statistics

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/statistic

SelfUploadAccount

Create upload credentials

POST

/seller-api/sellers/:mobileSellerId/self-upload-account

Retrieve upload credentials

GET

/seller-api/sellers/:mobileSellerId/self-upload-account

Delete upload credentials

DELETE

/seller-api/sellers/:mobileSellerId/self-upload-account

Dealer Ratings

Retrieve dealer rating overview

GET

/seller-api/sellers/:mobileSellerId/rating/overview

Retrieve dealer ratings

GET

/seller-api/sellers/:mobileSellerId/rating/ratings

Retrieve single dealer rating

GET

/seller-api/sellers/:mobileSellerId/rating/ratings/:ratingId

Reply on dealer rating

PUT

/seller-api/sellers/:mobileSellerId/rating/ratings/:ratingId/comment

Retrieve dealer rating invites and inviteables

GET

/seller-api/sellers/:mobileSellerId/rating/invites

Invite buyers to submit dealer rating

POST

/seller-api/sellers/:mobileSellerId/rating/invites/:mobileAdId

Leasing

Create or update leasing rate

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

Get leasing rate

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

Delete leasing rate

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

OBS Attributes

Set OBS attributes

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/data

Get OBS attributes

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/data

OBS Documents

Upload OBS documents

POST

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

List OBS documents

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Delete OBS documents

DELETE

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Add description to already uploaded OBS documents

PATCH

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Direct Offer

Create or update direct offer

PUT

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/direct-offer

Get direct offer

GET

/seller-api/sellers/:mobileSellerId/ads/:mobileAdId/direct-offer

Seller

This is a readonly interface that allows retrieving information about the sellers associated with a given Api User account.

The information contains also the maximum number of images the seller is allowed to upload per each ad. Please note that this number may vary for different sellers and could change over the time.

List all sellers

GET /seller-api/sellers

Provides a list of Sellers associated with the given Api User. The result contains all details so there is no need to make an additional call to Retrieve a single seller endpoint for more details.

Data Types
Request Success Response Error Response

n/a

Sellers

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Request
GET /seller-api/sellers HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "sellers": [
        {
            "mobileSellerId": "12",
            "customerNumber": "8",
            "type": "DEALER",
            "siteId": "GERMANY",
            "readonly": false,
            "settings": {
                "maxImages": 30,
                "maxHighlights": 3,
                "usedCarSeals": [
                    "VW",
                    "AUDI"
                ],
                "automatedExports" : [
                    {
                        "eligible" : true,
                        "marketplace" : "ebay-kleinanzeigen.de",
                        "active" : false
                     }
                ],
                "videoUrl" : true,
                "leasing": {
                    "maxPrivateRates": 16,
                    "maxCommercialRates": 16
                }
            },
            "companyName": "Smoke AG"
        },
        {
            "mobileSellerId": "2173",
            "customerNumber": "2186",
            "type": "DEALER",
            "siteId": "GERMANY",
            "readonly": false,
            "settings": {
                "maxImages": 15,
                "maxHighlights": 0,
                "usedCarSeals": [
                    "VW"
                ],
                "automatedExports" : [
                    {
                        "eligible" : true,
                        "marketplace" : "ebay-kleinanzeigen.de",
                        "active" : false
                     }
                ],
                "videoUrl" : true,
                "leasing": {
                    "maxPrivateRates": 16,
                    "maxCommercialRates": 16
                }
            },
            "companyName": "Weatherill's"
        }
    ]
}

Retrieve a single seller

GET /seller-api/sellers/:mobileSellerId

Retrieves a single Seller identified by the mobileSellerId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Sellers

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read details of the specified seller.
Request
GET /seller-api/sellers/12 HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "mobileSellerId": "12",
    "customerNumber": "8",
    "type": "DEALER",
    "siteId": "GERMANY",
    "readonly": false,
    "settings": {
        "maxImages": 30,
        "maxHighlights": 3,
        "usedCarSeals": [
            "VW",
            "AUDI"
        ],
        "automatedExports" : [
            {
                "eligible" : true,
                "marketplace" : "ebay-kleinanzeigen.de",
                "active" : false
            }
        ],
        "videoUrl" : true,
        "leasing": {
            "maxPrivateRates": 16,
            "maxCommercialRates": 16
        },
        "directOffer": {
            "eligible": true,
            "blocked": false
        }
    },
    "companyName": "Smoke AG",
    "billingForecast": {
        "billingPeriod": "2017-07",
        "calculationDate": "2017-07-23",
        "invoiceLanguage": "de",
        "currency": "EUR",
        "invoiceItems": [
            {
                "descriptor": "VEHICLE_COUNT",
                "accountType": "COMPACT",
                "fromDate": "2017-07-01",
                "toDate": "2017-07-31",
                "unitPrice": "169.99",
                "totalPrice": "169.99",
                "articleCount": "8.04",
                "quantityAmount": "23.0",
                "quantityUnit": "DAY"
            },
            {
                "descriptor": "VEHICLE_INSERTION",
                "accountType": "",
                "fromDate": "2017-07-01",
                "toDate": "2017-07-31",
                "unitPrice": "2.99",
                "totalPrice": "0.0",
                "articleCount": "8.0",
                "quantityAmount": "0.0",
                "quantityUnit": "ITEM"
            }
        ],
        "freeContingents": [
            {
                "descriptor": "TOP_OF_PAGE",
                "description": "Top-Inserat inkl. kostenfreiem Kontingent",
                "available": "0",
                "contingentUnlimited": false
            }
        ]
    }
}

Billing forecast details will be omitted in case it is not up to date.

Retrieve ad feature settings

GET /seller-api/sellers/:mobileSellerId/feature-settings

Retrieves Feature Settings for Booking Buddy and Cost Control from a single Seller identified by the mobileSellerId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Feature Settings

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read details of the specified seller.
Request
GET /seller-api/sellers/12/feature-settings HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
  "bookingAssistant": {
    "topOfPage": {
      "mobileAdIds": [
        "405967", "35345003", "5485002"
      ]
    },
    "eyeCatcher": {
      "mobileAdIds": [
        "7891012", "24522453"
      ]
    }
  }
}

Billing forecast details will be omitted in case it is not up to date.

Retrieve individual contacts

GET /seller-api/sellers/:mobileSellerId/individual-contacts

Retrieves Individual Contact defined by a single Seller identified by the mobileSellerId path parameter.

More information about Individual Contact management in dealer area and in general can be found at the individual contact page.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Individual Contact

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read details of the specified seller.
Request
GET /seller-api/sellers/12/individual-contacts HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

[
    {
        "individualContactId": "64c232e9c19479425a9bb5c4",
        "firstName": "Max",
        "lastName": "Muster",
        "email": "max@mobile.de",
        "jobTitle": "Salesagent",
        "phone": {
            "countryCallingCode": "49",
            "areaCode": "030",
            "number": "1234567890"
        }
    },
    {
        "individualContactId": "64ca1066312cd92e09108323",
        "firstName": "Martha",
        "lastName": "Muster",
        "email": ",martha@mobile.de",
        "jobTitle": "Manager",
        "phone": {
            "countryCallingCode": "49",
            "areaCode": "045",
            "number": "1234567890"
        }
    }
]

JSON example when assigning an individual contact to an ad (can be done as part of listings creation or via changing it afterwards):

PUT /seller-api/sellers/12/ads/207648 HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
    "mobileAdId": "207648",
    "mobileSellerId": "21127",
    "vehicleClass": "Car",
    "category": "Limousine",
    "make": "ALFA ROMEO",
    "model": "Giulia",
    ...
    "individualContactId": "64c232e9c19479425a9bb5c4"
}

If the individualContactId is unknown the contact will be ignored but the ad is still created/updated.

Retrieve multi locations

GET /seller-api/sellers/:mobileSellerId/multi-locations

Retrieves Multi Location defined by a single Seller identified by the mobileSellerId path parameter.

More information about Multi Location Listings management in dealer area and in general can be found at the multi location listings page.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Multi Location

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read details of the specified seller.
Request
GET /seller-api/sellers/12/multi-locations HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

[
    {
        "id": "64ca0bd5eda6a6578e2cfcb8",
        "name": "My Location 1",
        "deliveryOption": {
            "period": 30,
            "fee": "0"
        },
        "location": {
            "street": "Am See",
            "houseNumber": "2",
            "zip": "67547",
            "city": "Worms",
            "country": "DE"
        }
    },
    {
        "id": "64ca0bb4eda6a6578e2cfcb7",
        "name": "My Location 2",
        "deliveryOption": {
            "period": 14,
            "fee": "50"
        },
        "location": {
            "street": "Lechlweg",
            "houseNumber": "1",
            "zip": "83607",
            "city": "Holzkirchen",
            "country": "DE"
        }
    }
]

JSON example when assigning multiple locations to an ad (can be done as part of listings creation or via changing it afterwards):

PUT /seller-api/sellers/12/ads/207648 HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
    "mobileAdId": "207648",
    "mobileSellerId": "21127",
    "vehicleClass": "Car",
    "category": "Limousine",
    "make": "ALFA ROMEO",
    "model": "Giulia",
    ...
    "multiLocations": [
        {
            "id": "64ca0bd5eda6a6578e2cfcb8"
        },
        {
            "id": "64ca0bb4eda6a6578e2cfcb7"
        }
    ]
}

If the multiLocations id is wrong the location will be ignored and the ad is still created/updated.

Ad

This resource allows complete management of a seller’s inventory. It provides a CRUD set of operations to manipulate ad data.

Create a new ad

POST /seller-api/sellers/:mobileSellerId/ads

Creates a new ad for the seller identified by mobileSellerId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Http Headers
Header Explanation

X-Mobile-Insertion-Request-Id

Unique value per ad creation operation. Please refer to Avoiding Duplicated Ads In Case Of Failure for more details. Restrictions:

  • max length 100 characters

  • subset of UTF-8 characters excluding control characters

  • characters allowed by http RFC specification
Data Types
Request Success Response Error Response

Ad

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

303

This ad already exists. Please refer to Avoiding Duplicated Ads In Case Of Failure for more details.

404

Indicates that the given Api User does not have permission to create ads for the specified seller.
Sample Success Request
POST /seller-api/sellers/12/ads HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
    "vehicleClass": "Car",
    "category": "Cabrio",
    "make": "ASTON MARTIN",
    "model": "DB9",
    "modelDescription": "DB9 Volante",
    "condition": "NEW",
    "power": 283,
    "gearbox": "AUTOMATIC_GEAR",
    "fuel": "PETROL",
    "envkvCompliant": true,
    "energyEfficiencyClass": "A_1",
    "co2": 155.0,
    "consumptionInner": 19.5,
    "consumptionOuter": 14.9,
    "consumptionCombined": 17.5,
    "consumptionUnit": "LITER",
    "envkvPetrolType": "SUPER",
    "emissionSticker": "EMISSIONSSTICKER_GREEN",
    "exteriorColor": "BLACK",
    "manufacturerColorName": "schwarz",
    "metallic": true,
    "interiorColor": "BLACK",
    "interiorType": "LEATHER",
    "countryVersion": "BE",
    "damageUnrepaired": false,
    "accidentDamaged": false,
    "roadworthy": false,
    "abs": true,
    "centralLocking": true,
    "climatisation": "AUTOMATIC_CLIMATISATION",
    "electricHeatedSeats": true,
    "electricWindows": true,
    "esp": true,
    "navigationSystem": true,
    "parkingAssistants": [
        "REAR_SENSORS"
    ],
    "powerAssistedSteering": true,
    "description": "Getriebe Automatik-6-Gang, ASR Antriebsschlupfregelung, CD-Wechsler, Radio/CD, Aussentemperaturanzeige, Diebstahlwarnanlage, Scheinwerferreinigung, Bordcomputer/Reiserechner, Heckantrieb, Lenksaeule mech/elektrisch einstellbar, elektrisch einklappbare Aussenspiegel, 19-\" Felgen, Designpaket Royal, Windschott, Raucherpaket",
    "deliveryPeriod": 14,
    "dealerHomepage": true,
    "warranty": true,
    "price": {
        "consumerPriceGross": "20498.94",
        "vatRate": "19.00",
        "type": "FIXED",
        "currency": "EUR"
    },
    "individualContactId": "64c232e9c19479425a9bb5c4",
    "nationalDelivery": {
        "radius": 400,
        "period": 90,
        "fee": 50,
        "additionalInformation": "Lieferung über unseren Dienstleister 'InstantoCar'"
    }
}
Sample Success Response
HTTP/1.1 201 Created
Location: https://services.mobile.de/seller-api/sellers/12/ads/217220

The Location header in the response identifies the newly created ad.
Sample Error Request
POST /seller-api/sellers/12/ads HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Motorbike",
  "category": "Motorcycle",
  "make": "CAGIVA",
  "modelDescription": "Gilera",
  "condition": "USED",
  "firstRegistration": "200302",
  "mileage": 26000,
  "cubicCapacity": 665,
  "power": 45,
  "gearbox": "XYZ",
  "fuel": "PETROL",
  "fullServiceHistory": true,
  "damageUnrepaired": false,
  "drivingMode": "CHAIN_DRIVE",
  "electricStarter": true,
  "windshield": true,
  "price": {
    "consumerPriceGross": "2000.00",
    "type": "FIXED",
    "currency": "EUR"
  }
}
Sample Error Response
HTTP/1.1 400 Bad Request

{
    "errors": [
        {
            "key": "invalid-value"
            "args": [
                {
                    "key": "path",
                    "value": "gearbox"
                },
                {
                    "key": "invalid-value",
                    "value": "XYZ"
                }
            ]
        }
    ]
}
Sample Request with Images
POST /seller-api/sellers/12/ads HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
    "vehicleClass": "Car",
    "category": "Cabrio",
    "make": "ASTON MARTIN",
    "model": "DB9",
    "modelDescription": "DB9 Volante",
    "condition": "NEW",
    "power": 283,
    "gearbox": "AUTOMATIC_GEAR",
    "fuel": "PETROL",
    "envkvCompliant": true,
    "energyEfficiencyClass": "A_1",
    "co2": 155.0,
    "consumptionInner": 19.5,
    "consumptionOuter": 14.9,
    "consumptionCombined": 17.5,
    "consumptionUnit": "LITER",
    "envkvPetrolType": "SUPER",
    "emissionSticker": "EMISSIONSSTICKER_GREEN",
    "exteriorColor": "BLACK",
    "manufacturerColorName": "schwarz",
    "metallic": true,
    "interiorColor": "BLACK",
    "interiorType": "LEATHER",
    "countryVersion": "BE",
    "damageUnrepaired": false,
    "accidentDamaged": false,
    "roadworthy": false,
    "abs": true,
    "centralLocking": true,
    "climatisation": "AUTOMATIC_CLIMATISATION",
    "electricHeatedSeats": true,
    "electricWindows": true,
    "esp": true,
    "navigationSystem": true,
    "parkingAssistants": [
        "REAR_SENSORS"
    ],
    "powerAssistedSteering": true,
    "description": "Getriebe Automatik-6-Gang, ASR Antriebsschlupfregelung, CD-Wechsler, Radio/CD, Aussentemperaturanzeige, Diebstahlwarnanlage, Scheinwerferreinigung, Bordcomputer/Reiserechner, Heckantrieb, Lenksaeule mech/elektrisch einstellbar, elektrisch einklappbare Aussenspiegel, 19-\" Felgen, Designpaket Royal, Windschott, Raucherpaket",
    "deliveryPeriod": 14,
    "dealerHomepage": true,
    "warranty": true,
    "price": {
        "consumerPriceGross": "20498.94",
        "vatRate": "19.00",
        "type": "FIXED",
        "currency": "EUR"
    },
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942c713b?rule=mo-640.jpg"
        }
    ]
}
Avoiding Duplicated Ads In Case Of Failure

When the POST operation fails e.g. due to network connectivity problems or internal server error, the user does not know whether the ad has been created or not. If the user retries the POST operation it is possible that duplicated ad is created.

In order to address this issue the Seller-API has been extended with new functionality. The new functionality allows the user to retry the POST operation in a safe manner, so that it will not create a duplicated ad in case it has been created with the initial call.

In order to correlate the retry call with the initial POST call, the user must send a unique value in the newly introduced http header X-Mobile-Insertion-Request-Id. It makes the POST call idempotent.

Let’s consider the following scenario.

Intial POST request
POST https://services.mobile.de/seller-api/sellers/28481/ads HTTP/1.1
X-Mobile-Insertion-Request-Id: my-unique-id-for-this-ad
Content-Type: application/vnd.de.mobile.api+json

<some ad data>
Failing Response
HTTP/1.1 500 internal server error
Date: Tue, 04 Sep 2018 09:23:34 GMT

At this stage the user does not know whether the ad has been created. The retry call with the same X-Mobile-Insertion-Request-Id: my-unique-id-for-this-ad as previously

Retry POST request
POST https://services.mobile.de/seller-api/sellers/28481/ads HTTP/1.1
X-Mobile-Insertion-Request-Id: my-unique-id-for-this-ad
Content-Type: application/vnd.de.mobile.api+json

<some ad data>

responds with http status 303 when the ad has already been created in the initial call. The Location header will point to the ad created originally.

Response pointing to the ad created in the previous call
HTTP/1.1 303 See Other
Date: Tue, 04 Sep 2018 09:23:34 GMT
Content-Type: application/vnd.de.mobile.api+json
Location: https://services.mobile.de/seller-api/sellers/28481/ads/1001
Content-Length: 0

Otherwise the API responds with http status 201 as usual

Usual successful response
HTTP/1.1 201 Created
Date: Tue, 04 Sep 2018 09:23:34 GMT
Content-Type: application/vnd.de.mobile.api+json
Location: https://services.mobile.de/seller-api/sellers/28481/ads/1001
Content-Length: 0

The X-Mobile-Insertion-Request-Id must be unique per each ad creation.

If the user whats to create five different ads, five different values must be sent to the Seller-API. The same value must be resued only for the retry calls.

The recommended strategy to create unique values is to use a UUID generator.

List all sellers ads

GET /seller-api/sellers/:mobileSellerId/ads

Provides a list of Ads for a Seller identified by mobileSellerId path parameter. The result contains all ad details so there is no need to make an extra call to Retrieve a single ad endpoint for more details.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Ads

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read ads for the specified seller.
Curl
curl -i -X GET 'https://services.mobile.de/seller-api/sellers/12/ads' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
GET https://services.mobile.de/seller-api/sellers/12/ads HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Tue, 18 Apr 2017 12:58:23 GMT
Content-Type: application/vnd.de.mobile.api+json
Transfer-Encoding: chunked

{
  "ads": [
    {
      "mobileAdId": "173955",
      "mobileSellerId": "12",
      "creationDate": "2015-12-01T18:40:44+01:00",
      "modificationDate": "2016-03-02T17:09:41+01:00",
      "uploadSticky": false,
      "export": false,
      "vehicleClass": "Car",
      "category": "Cabrio",
      "make": "ASTON MARTIN",
      "model": "DB9",
      "modelDescription": "DB9 Volante EU",
      "condition": "NEW",
      "envkvCompliant": true,
      "energyEfficiencyClass": "A_1",
      "co2": 155.0,
      "consumptionInner": 19.5,
      "consumptionOuter": 14.9,
      "consumptionCombined": 17.5,
      "consumptionUnit": "LITER",
      "envkvPetrolType": "SUPER",
      "dealerHomepage": true,
      "price": {
        "consumerPriceGross": "20498.94",
        "consumerPriceNet": "17226.00",
        "vatRate": "19.00",
        "currency": "EUR"
      },
      "esp": true,
      "exteriorColor": "BLACK",
      "countryVersion": "BE",
      "fuel": "PETROL",
      "damageUnrepaired": false,
      "electricHeatedSeats": true,
      "accidentDamaged": false,
      "manufacturerColorName": "schwarz",
      "metallic": true,
      "electricWindows": true,
      "roadworthy": false,
      "parkingAssistants": [
        "FRONT_SENSORS",
        "REAR_SENSORS"
      ],
      "interiorColor": "BLACK",
      "powerAssistedSteering": true,
      "abs": true,
      "centralLocking": true,
      "climatisation": "AUTOMATIC_CLIMATISATION",
      "navigationSystem": true,
      "deliveryPeriod": 14,
      "warranty": true,
      "gearbox": "AUTOMATIC_GEAR",
      "power": 283,
      "interiorType": "LEATHER"
    },
    {
      "mobileAdId": "190366",
      "mobileSellerId": "12",
      "creationDate": "2015-12-23T15:15:04+01:00",
      "modificationDate": "2015-12-23T15:15:04+01:00",
      "uploadSticky": false,
      "export": false,
      "vehicleClass": "TruckOver7500",
      "category": "BreakdownTruck",
      "make": "IVECO",
      "modelDescription": "Top Zustand ohne optische Mängel!",
      "condition": "USED",
      "emissionClass": "EURO3",
      "price": {
        "consumerPriceGross": "32055.00",
        "consumerPriceNet": "26936.97",
        "vatRate": "19.00",
        "currency": "EUR"
      },
      "esp": true,
      "exteriorColor": "GREEN",
      "constructionYear": 2010,
      "retarder": true,
      "fuel": "DIESEL",
      "europalletStorageSpaces": 17,
      "damageUnrepaired": false,
      "wheelFormula": "WHEEL_DRIVE_6x2",
      "cubicCapacity": 1480,
      "axles": 2,
      "metallic": true,
      "firstRegistration": "200909",
      "generalInspection": "201611",
      "drivingCab": "LONG_DISTANCE_TRAFFIC",
      "climatisation": "NO_CLIMATISATION",
      "loadingSpace": {
        "length": 9045,
        "width": 1441,
        "height": 2873
      },
      "hydraulicInstallation": "TANKER_HYDRAULIC_INSTALLATION",
      "municipal": true,
      "gearbox": "MANUAL_GEAR",
      "power": 144,
      "tailLift": true,
      "compressor": true,
      "licensedWeight": 4474,
      "mileage": 80020
    },
    {
      "mobileAdId": "231922",
      "mobileSellerId": "12",
      "creationDate": "2016-04-01T15:42:47+02:00",
      "modificationDate": "2016-04-05T15:42:47+02:00",
      "renewalDate": "2016-04-02T15:42:47+02:00",
      "reserved": true,
      "uploadSticky": true,
      "export": true,
      "vehicleClass": "Car",
      "category": "EstateCar",
      "make": "AUDI",
      "model": "A4",
      "modelDescription": "A4 Avant 2.0 TFSI multitronic Attraction",
      "condition": "USED",
      "internalNumber": "E1063",
      "envkvCompliant": true,
      "energyEfficiencyClass": "A",
      "co2": 172.0,
      "consumptionInner": 9.8,
      "consumptionOuter": 5.9,
      "consumptionCombined": 7.3,
      "consumptionUnit": "LITER",
      "envkvPetrolType": "SUPER",
      "emissionSticker": "EMISSIONSSTICKER_GREEN",
      "emissionClass": "EURO4",
      "description": "Airbag Beifahrerseite abschaltbar, Außenspiegel elektr. verstell- und heizbar, beide, Connectivity-Paket, Dachkuppel Kontrastfarbe (Dach, Dachbogen und Dachkantenspoiler), Einparkhilfe vorn und hinten, optisch (APS Plus), Frontscheibe mit Bandfilter oben, Innenlicht-Paket LED, Klimaautomatik, Lenkrad (Sport/Leder - 3-Speichen) mit Multifunktion, Licht- und Regensensor, Metallic-Lackierung, Multi-Media-Interface MMI Basic / MMI Radio, Sitzheizung vorn, Sound-System DSP / Audi Sound-System, Xenon-Scheinwerfer Plus (Abblend- und Fernlicht), Airbag Fahrer-/Beifahrerseite, Anti-Blockier-System (ABS), Antriebs-Schlupfregelung (ASR), Außenspiegel elektr. verstellbar, beide, Außenspiegel und Heckspoiler in Kontrastfarbe, Dachhimmel Stoff, titangrau, Dachkantenspoiler, Einstiegleisten mit Schriftzug, Elektron. Differentialsperre (EDS), Elektron. Stabilitäts-Programm (ESP), Fahrer-Informations-System (FIS), Fensterheber elektrisch vorn, Getriebe 5-Gang, Heckleuchten LED, Isofix-Aufnahmen für Kindersitz, Karosserie: 4-türig, Kopf-Airbag-System (Sideguard), Lendenwirbelstützen verstellbar, Lenksäule (Lenkrad) mech. Höhen-/Längsverstellung, LM-Felgen, Reifenkontroll-Anzeige, Rücksitzlehne geteilt/klappbar, Schadstoffarm nach Abgasnorm Euro 6, Seitenairbag vorn, Servolenkung, Sitz-Paket, Sitze vorn höhenverstellbar, Sportsitze vorn, Start/Stop-Anlage, Stoßfänger lackiert, Tagfahrlicht, Warnanlage für Sicherheitsgurte, Wegfahrsperre (elektronisch), Wärmeschutzverglasung grün getönt, Zentralverriegelung mit Fernbedienung, Fondsitzanlage (3 Sitzplätze), Audi music interface, Scheibenwaschdüsen heizbar, Scheinwerfer-Reinigungsanlage (SRA), Tagfahrlicht LED, Universal-Schnittstelle Bluetooth",
      "images": [
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f10922d713b?rule=mo-640.jpg",
          "hash": "e7f6e858ba6fb12ae29163f14ac71b4c"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f13922d713b?rule=mo-640.jpg",
          "hash": "808d5b6fdbc7ca73883f0690e49146fd"
        }
      ],
      "videoUrl": "https://www.youtube.com/watch?v\u003dtGk5ioEXlIM",
      "dealerHomepage": true,
      "price": {
        "dealerPriceGross": "12541.81",
        "consumerPriceGross": "13169.72",
        "dealerPriceNet": "10486.46",
        "consumerPriceNet": "11011.47",
        "vatRate": "19.60",
        "type": "FIXED",
        "currency": "EUR"
      },
      "financing": {
        "annualPercentageRate": "3.25",
        "nominalInterestRate": "7.75",
        "typeOfNominalInterestRate": "VARIABLE",
        "firstInstallment": 8000,
        "monthlyInstallment": 1000,
        "finalInstallment": 2000,
        "paybackPeriod": "MONTHS_12",
        "netLoanAmount": "17000.00",
        "grossLoanAmount": "18000.00",
        "closingCosts": "2000.00",
        "paymentProtectionInsurance": "5000.00",
        "bank": "Postbank Berlin"
      },
      "esp": true,
      "countryVersion": "DE",
      "constructionYear": 2010,
      "fuel": "PETROL",
      "accidentDamaged": false,
      "seats": 5,
      "firstRegistration": "201002",
      "electricWindows": true,
      "roadworthy": false,
      "fourWheelDrive": true,
      "interiorColor": "GREY",
      "centralLocking": true,
      "climatisation": "AUTOMATIC_CLIMATISATION",
      "immobilizer": true,
      "deliveryPeriod": 6,
      "vin": "WAUZZZ8E9TA002011",
      "gearbox": "AUTOMATIC_GEAR",
      "power": 155,
      "mileage": 25000,
      "exhaustInspection": "201402",
      "exteriorColor": "SILVER",
      "damageUnrepaired": false,
      "cubicCapacity": 1984,
      "kba": {
        "hsn": "0588",
        "tsn": "AHQ"
      },
      "numberOfPreviousOwners": 2,
      "schwackeCode": 10110413,
      "electricHeatedSeats": true,
      "manufacturerColorName": "Silver Moon",
      "metallic": true,
      "doors": "FOUR_OR_FIVE",
      "parkingAssistants": [
        "FRONT_SENSORS",
        "REAR_SENSORS"
      ],
      "generalInspection": "201402",
      "powerAssistedSteering": true,
      "abs": true,
      "alloyWheels": true,
      "airbag": "FRONT_AND_SIDE_AND_MORE_AIRBAGS",
      "constructionDate": "2010-07-15T00:00:00+02:00",
      "interiorType": "ALCANTARA",
      "highlights": [
        "low mileage",
        "loaded"
      ]
    },
    {
      "mobileAdId": "260251",
      "mobileSellerId": "12",
      "creationDate": "2016-06-14T11:47:39+02:00",
      "modificationDate": "2016-08-02T11:16:49+02:00",
      "uploadSticky": false,
      "export": false,
      "vehicleClass": "Car",
      "category": "Cabrio",
      "make": "ASTON MARTIN",
      "model": "DB9",
      "modelDescription": "DB9 Volante",
      "condition": "NEW",
      "internalNumber": "NEW-10",
      "envkvCompliant": true,
      "energyEfficiencyClass": "A_1",
      "co2": 155.0,
      "consumptionInner": 19.5,
      "consumptionOuter": 14.9,
      "consumptionCombined": 17.5,
      "consumptionUnit": "LITER",
      "envkvPetrolType": "SUPER",
      "emissionSticker": "EMISSIONSSTICKER_GREEN",
      "description": "Getriebe Automatik-6-Gang, ASR Antriebsschlupfregelung, CD-Wechsler, Radio/CD, Aussentemperaturanzeige, Diebstahlwarnanlage, Scheinwerferreinigung, Bordcomputer/Reiserechner, Heckantrieb, Lenksaeule mech/elektrisch einstellbar, elektrisch einklappbare Aussenspiegel, 19-\" Felgen, Designpaket Royal, Windschott, Raucherpaket",
      "images": [
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f13912d713b?rule=mo-640.jpg",
          "hash": "ee57b82fbcb7a091f25ce675fa26a782"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "364073fc1bde17f2e4e647157396a621"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "45729bb7ed3b8c3b1e5b6fa0ed599a96"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "71118268569645506f1be100c3a377e5"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcba-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "161a9f5587a2bf0de992b2917c2bc6fe"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbb-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6f208e48b519a9d60aa4b6dc25ef052e"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbc-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6805fb7063af2809929ea2aefc78b7c0"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbe-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "a763df0b59cab1a951ceacc313a79f2d"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "78663268a5d2eb28c61f3594cc0b54c4"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-1f13912d713b?rule=mo-640.jpg",
          "hash": "08d8d0f2513ad26f6bbdb009ed8c9d91"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-3f13912d713b?rule=mo-640.jpg",
          "hash": "42eaab22cc1b27b52eb0130a1a55b805"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6cd4c61ac4622de2c2eb3b465b609693"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-5f13912d713b?rule=mo-640.jpg",
          "hash": "fbf49e92d9c33669889957e265fba5ad"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-6f13912d713b?rule=mo-640.jpg",
          "hash": "8e718608901fa00ab2e8ebb1d917f4af"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-7f13912d713b?rule=mo-640.jpg",
          "hash": "d61f0f80caf5e396d25e967ff8b74a25"
        }
      ],
      "dealerHomepage": true,
      "price": {
        "consumerPriceGross": "19000.00",
        "type": "FIXED",
        "currency": "EUR"
      },
      "esp": true,
      "countryVersion": "BE",
      "fuel": "PETROL",
      "accidentDamaged": false,
      "electricWindows": true,
      "roadworthy": false,
      "interiorColor": "BLACK",
      "centralLocking": true,
      "climatisation": "AUTOMATIC_CLIMATISATION",
      "deliveryPeriod": 14,
      "warranty": true,
      "gearbox": "AUTOMATIC_GEAR",
      "power": 283,
      "exteriorColor": "BLACK",
      "damageUnrepaired": false,
      "electricHeatedSeats": true,
      "manufacturerColorName": "schwarz",
      "metallic": true,
      "parkingAssistants": [
        "REAR_SENSORS"
      ],
      "powerAssistedSteering": true,
      "abs": true,
      "navigationSystem": true,
      "interiorType": "LEATHER"
    },
    {
      "mobileAdId": "260252",
      "mobileSellerId": "12",
      "creationDate": "2016-06-14T11:47:39+02:00",
      "modificationDate": "2016-08-02T11:16:49+02:00",
      "uploadSticky": false,
      "export": false,
      "vehicleClass": "Car",
      "category": "Cabrio",
      "make": "ASTON MARTIN",
      "model": "DB9",
      "modelDescription": "DB9 Volante",
      "condition": "NEW",
      "internalNumber": "NEW-10",
      "envkvCompliant": true,
      "energyEfficiencyClass": "A_1",
      "co2": 155.0,
      "consumptionInner": 19.5,
      "consumptionOuter": 14.9,
      "consumptionCombined": 17.5,
      "consumptionUnit": "LITER",
      "envkvPetrolType": "SUPER",
      "emissionSticker": "EMISSIONSSTICKER_GREEN",
      "description": "Getriebe Automatik-6-Gang, ASR Antriebsschlupfregelung, CD-Wechsler, Radio/CD, Aussentemperaturanzeige, Diebstahlwarnanlage, Scheinwerferreinigung, Bordcomputer/Reiserechner, Heckantrieb, Lenksaeule mech/elektrisch einstellbar, elektrisch einklappbare Aussenspiegel, 19-\" Felgen, Designpaket Royal, Windschott, Raucherpaket",
      "images": [
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f13912d713b?rule=mo-640.jpg",
          "hash": "ee57b82fbcb7a091f25ce675fa26a782"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "364073fc1bde17f2e4e647157396a621"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "45729bb7ed3b8c3b1e5b6fa0ed599a96"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "71118268569645506f1be100c3a377e5"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcba-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "161a9f5587a2bf0de992b2917c2bc6fe"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbb-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6f208e48b519a9d60aa4b6dc25ef052e"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbc-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6805fb7063af2809929ea2aefc78b7c0"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcbe-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "a763df0b59cab1a951ceacc313a79f2d"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "78663268a5d2eb28c61f3594cc0b54c4"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-1f13912d713b?rule=mo-640.jpg",
          "hash": "08d8d0f2513ad26f6bbdb009ed8c9d91"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-3f13912d713b?rule=mo-640.jpg",
          "hash": "42eaab22cc1b27b52eb0130a1a55b805"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-4f13912d713b?rule=mo-640.jpg",
          "hash": "6cd4c61ac4622de2c2eb3b465b609693"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-5f13912d713b?rule=mo-640.jpg",
          "hash": "fbf49e92d9c33669889957e265fba5ad"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-6f13912d713b?rule=mo-640.jpg",
          "hash": "8e718608901fa00ab2e8ebb1d917f4af"
        },
        {
          "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-7f13912d713b?rule=mo-640.jpg",
          "hash": "d61f0f80caf5e396d25e967ff8b74a25"
        }
      ],
      "dealerHomepage": true,
      "price": {
        "consumerPriceGross": "19000.00",
        "type": "FIXED",
        "currency": "EUR"
      },
      "esp": true,
      "countryVersion": "BE",
      "fuel": "PETROL",
      "accidentDamaged": false,
      "electricWindows": true,
      "roadworthy": false,
      "interiorColor": "BLACK",
      "centralLocking": true,
      "climatisation": "AUTOMATIC_CLIMATISATION",
      "deliveryPeriod": 14,
      "warranty": true,
      "gearbox": "AUTOMATIC_GEAR",
      "power": 283,
      "exteriorColor": "BLACK",
      "damageUnrepaired": false,
      "electricHeatedSeats": true,
      "manufacturerColorName": "schwarz",
      "metallic": true,
      "parkingAssistants": [
        "REAR_SENSORS"
      ],
      "powerAssistedSteering": true,
      "abs": true,
      "navigationSystem": true,
      "interiorType": "LEATHER"
    },
    {
      "mobileAdId": "363142",
      "mobileSellerId": "12",
      "creationDate": "2017-03-21T12:52:54+01:00",
      "modificationDate": "2017-03-21T13:10:54+01:00",
      "uploadSticky": false,
      "export": false,
      "vehicleClass": "TruckOver7500",
      "category": "CementMixerTruck",
      "make": "IVECO",
      "modelDescription": "420 SX",
      "condition": "USED",
      "price": {
        "type": "ON_REQUEST",
        "currency": "EUR"
      },
      "damageUnrepaired": false,
      "firstRegistration": "200302",
      "mileage": 26000
    }
  ]
}

Retrieve a single ad

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Retrieves a single Ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Ad

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to read ads for the specified seller.
Curl
curl -i -X GET 'https://services.mobile.de/seller-api/sellers/12/ads/231922' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
GET https://services.mobile.de/seller-api/sellers/12/ads/231922 HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Tue, 18 Apr 2017 12:58:23 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 4641

{
  "mobileAdId": "231922",
  "mobileSellerId": "12",
  "creationDate": "2016-04-01T15:42:47+02:00",
  "modificationDate": "2016-04-05T15:42:47+02:00",
  "renewalDate": "2016-04-02T15:42:47+02:00",
  "reserved": true,
  "uploadSticky": true,
  "export": true,
  "vehicleClass": "Car",
  "category": "EstateCar",
  "make": "AUDI",
  "model": "A4",
  "modelDescription": "A4 Avant 2.0 TFSI multitronic Attraction",
  "condition": "USED",
  "internalNumber": "E1063",
  "envkvCompliant": true,
  "energyEfficiencyClass": "A",
  "co2": 172.0,
  "consumptionInner": 9.8,
  "consumptionOuter": 5.9,
  "consumptionCombined": 7.3,
  "consumptionUnit": "LITER",
  "envkvPetrolType": "SUPER",
  "emissionSticker": "EMISSIONSSTICKER_GREEN",
  "emissionClass": "EURO4",
  "description": "Airbag Beifahrerseite abschaltbar, Außenspiegel elektr. verstell- und heizbar, beide, Connectivity-Paket, Dachkuppel Kontrastfarbe (Dach, Dachbogen und Dachkantenspoiler), Einparkhilfe vorn und hinten, optisch (APS Plus), Frontscheibe mit Bandfilter oben, Innenlicht-Paket LED, Klimaautomatik, Lenkrad (Sport/Leder - 3-Speichen) mit Multifunktion, Licht- und Regensensor, Metallic-Lackierung, Multi-Media-Interface MMI Basic / MMI Radio, Sitzheizung vorn, Sound-System DSP / Audi Sound-System, Xenon-Scheinwerfer Plus (Abblend- und Fernlicht), Airbag Fahrer-/Beifahrerseite, Anti-Blockier-System (ABS), Antriebs-Schlupfregelung (ASR), Außenspiegel elektr. verstellbar, beide, Außenspiegel und Heckspoiler in Kontrastfarbe, Dachhimmel Stoff, titangrau, Dachkantenspoiler, Einstiegleisten mit Schriftzug, Elektron. Differentialsperre (EDS), Elektron. Stabilitäts-Programm (ESP), Fahrer-Informations-System (FIS), Fensterheber elektrisch vorn, Getriebe 5-Gang, Heckleuchten LED, Isofix-Aufnahmen für Kindersitz, Karosserie: 4-türig, Kopf-Airbag-System (Sideguard), Lendenwirbelstützen verstellbar, Lenksäule (Lenkrad) mech. Höhen-/Längsverstellung, LM-Felgen, Reifenkontroll-Anzeige, Rücksitzlehne geteilt/klappbar, Schadstoffarm nach Abgasnorm Euro 6, Seitenairbag vorn, Servolenkung, Sitz-Paket, Sitze vorn höhenverstellbar, Sportsitze vorn, Start/Stop-Anlage, Stoßfänger lackiert, Tagfahrlicht, Warnanlage für Sicherheitsgurte, Wegfahrsperre (elektronisch), Wärmeschutzverglasung grün getönt, Zentralverriegelung mit Fernbedienung, Fondsitzanlage (3 Sitzplätze), Audi music interface, Scheibenwaschdüsen heizbar, Scheinwerfer-Reinigungsanlage (SRA), Tagfahrlicht LED, Universal-Schnittstelle Bluetooth",
  "images": [
    {
      "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcce-1c7f-ca2b-9f13912d713b?rule=mo-640.jpg",
      "hash": "e7f6e858ba6fb12ae29163f14ac71b4c"
    },
    {
      "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acce-1c7f-ca2b-9f13912d713b?rule=mo-640.jpg",
      "hash": "808d5b6fdbc7ca73883f0690e49146fd"
    }
  ],
  "videoUrl": "https://www.youtube.com/watch?v\u003dtGk5ioEXlIM",
  "dealerHomepage": true,
  "price": {
    "dealerPriceGross": "12541.81",
    "consumerPriceGross": "13169.72",
    "dealerPriceNet": "10486.46",
    "consumerPriceNet": "11011.47",
    "vatRate": "19.60",
    "type": "FIXED",
    "currency": "EUR"
  },
  "financing": {
    "annualPercentageRate": "3.25",
    "nominalInterestRate": "7.75",
    "typeOfNominalInterestRate": "VARIABLE",
    "firstInstallment": 8000,
    "monthlyInstallment": 1000,
    "finalInstallment": 2000,
    "paybackPeriod": "MONTHS_12",
    "netLoanAmount": "17000.00",
    "grossLoanAmount": "18000.00",
    "closingCosts": "2000.00",
    "paymentProtectionInsurance": "5000.00",
    "bank": "Postbank Berlin"
  },
  "esp": true,
  "countryVersion": "DE",
  "constructionYear": 2010,
  "fuel": "PETROL",
  "accidentDamaged": false,
  "seats": 5,
  "firstRegistration": "201002",
  "electricWindows": true,
  "roadworthy": false,
  "fourWheelDrive": true,
  "interiorColor": "GREY",
  "centralLocking": true,
  "climatisation": "AUTOMATIC_CLIMATISATION",
  "immobilizer": true,
  "deliveryPeriod": 6,
  "vin": "WAUZZZ8E9TA002011",
  "gearbox": "AUTOMATIC_GEAR",
  "power": 155,
  "mileage": 25000,
  "exhaustInspection": "201402",
  "exteriorColor": "SILVER",
  "damageUnrepaired": false,
  "cubicCapacity": 1984,
  "kba": {
    "hsn": "0588",
    "tsn": "AHQ"
  },
  "numberOfPreviousOwners": 2,
  "schwackeCode": 10110413,
  "electricHeatedSeats": true,
  "manufacturerColorName": "Silver Moon",
  "metallic": true,
  "doors": "FOUR_OR_FIVE",
  "parkingAssistants": [
    "FRONT_SENSORS",
    "REAR_SENSORS"
  ],
  "generalInspection": "201402",
  "powerAssistedSteering": true,
  "abs": true,
  "alloyWheels": true,
  "airbag": "FRONT_AND_SIDE_AND_MORE_AIRBAGS",
  "constructionDate": "2010-07-15T00:00:00+02:00",
  "interiorType": "ALCANTARA",
  "highlights": [
    "low mileage",
    "loaded"
  ]
}

Update an ad

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Updates an ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

Ad

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to update ads for the specified seller.
Request
PUT /seller-api/sellers/12/ads/217221 HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
	"vehicleClass": "Motorbike",
	"category": "Motorcycle",
	"make": "CAGIVA",
	"modelDescription": "Gilera",
	"condition": "USED",
	"firstRegistration": "200302",
	"mileage": 26000,
	"cubicCapacity": 665,
	"power": 45,
	"gearbox": "MANUAL_GEAR",
	"fuel": "PETROL",
	"fullServiceHistory": true,
	"damageUnrepaired": false,
	"drivingMode": "CHAIN_DRIVE",
	"electricStarter": true,
	"windshield": true,
	"description": "Mint condition",
	"price": {
		"consumerPriceGross": "2000.00",
		"type": "FIXED",
		"currency": "EUR"
	}
}
Response
HTTP/1.1 200 OK

  • Please note that for the update call the whole ad must be submitted.

  • Please see Error Handling and Data Validation for more information about error cases and validation.
Update Ad with Images
PUT /seller-api/sellers/12/ads/217221 HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Motorbike",
  "category": "Motorcycle",
  "make": "CAGIVA",
  "modelDescription": "Gilera",
  "condition": "USED",
  "firstRegistration": "200302",
  "mileage": 26000,
  "cubicCapacity": 665,
  "power": 45,
  "gearbox": "MANUAL_GEAR",
  "fuel": "PETROL",
  "fullServiceHistory": true,
  "damageUnrepaired": false,
  "drivingMode": "CHAIN_DRIVE",
  "electricStarter": true,
  "windshield": true,
  "description": "Mint condition",
  "price": {
    "consumerPriceGross": "2000.00",
    "type": "FIXED",
    "currency": "EUR"
  },
  "images": [
    {
      "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"
    },
    {
      "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942c713b?rule=mo-640.jpg"
    }
  ]
}

  • When the images element is not present the existing images are unchanged.

  • When the images is an empty list e.g. "images": [] the existing images are removed.

  • Otherwise existing images are replaced with the ones specified in the images element.

Delete an ad

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId

Deletes an Ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to delete ads for the specified seller.
Request
DELETE /seller-api/sellers/12/ads/217221 HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK

  • It is not necessary to delete the images before deleting the ad.

  • Even though this call doesn’t return any data, please specify the Accept header in order to indicate representation of the error message should the call fails.

Images

Images associated with the ads are hosted by mobile.de which means that the image data must be uploaded to us through the Seller-API. Once an image is uploaded it is stored internally on the Picture Service and it is identified using a unique url, for example:

{
    "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942d713b?rule=mo-640.jpg"
}

Upload Images Overview

There are two flows how the images are uploaded and associated with the ads.

Upload Images For Given Ad

This is the traditional flow which consists of the following steps.

  1. A new ad is created.

  2. All images are uploaded using a multipart request using the mobileAdId of newly created ad from step 1.

This flow has certain limitations:

  • All images are sent in a single request. When processing of a single image fails the API rejects the entrie call and all images must be uploaded again.

  • It is not the most efficient option from the performance perspective as all images are transmitted to us sequentially.

  • It is relatively difficult to implement a multipart http call in a correct way.

Images Uploaded Upfront

This is the recommended way of uploading the images

To mitigate the limitations of the previous image upload flow the Seller-API has been extended with a new functionality. The new flow consists of the following steps:

Upload images before ad creation

  1. Images are uploaded one by one using the Upload Image endpoint. Each call responds with the image reference.

  2. A new ad is created using the Create a new ad endpoint with the list of image references passed in the payload. Please refer to the example how to include images in the create ad call.

Associate images after ad creation

  1. A new ad is created using the Create a new ad endpoint.

  2. Images are uploaded one by one using the Upload Image endpoint. Each call responds with the image reference.

  3. Once all images are uploaded they are associated with the ad using the Associate images endpoint by passing a list of image references collected in the step 2 and the mobileAdId of newly created ad from step 1.

Alternatively the images can be associated using the regular Update an ad endpoint. It requires however passing the entire ad information rather than just the image references.

  • Steps 1 and 2 are independent and they could be done in any order also in parallel.

  • Step 2 requires multiple calls to upload individual images and:

    • it gives more granular control for the error handling - only the image that fails to process must be reuploaded rather than all images

    • images could be transmitted in parallel to make the entire process much shorter

    • it is a regular rest call (no multipart required) so it is much easier to integrate
Image Quality Requirements And Restrictions

  • The images have to be in JPG-format.

  • The maximum number of images per ad depends on the seller settings. Please refer to the retrieving seller information section for details.

  • The images must not be larger than 2097152 bytes.

  • The image width + height must not be smaller than 20 pixels.

  • The image width + height must not be larger than 9000 pixels.

  • The image colorspace must be RGB. CMYK is not possible.

  • Calls may take longer duration due to file uploading and storage, so consider checking the timeouts and/or retries in case of an error.

Upload Image

POST /seller-api/images

Uploads a single image to the mobile.de platform. Once uploaded the image could be associated with a newly created or existing ad.

Data Types
Request Success Response Error Response

binary image data with the image/jpeg content type

Image

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation Remedy

400

not-a-jpeg-file

Submitted image doesn’t meet the criteria.

The image can’t be uploaded. Please use another image.

500

n/a

Unable to upload image due to network or storage error

Retry the call
Curl command

This is a sample curl command assuming that the image img1.jpeg is in current directory.

curl -u username:password \
  -H "Content-Type: image/jpeg" \
  -H "Accept: application/vnd.de.mobile.api+json" \
  -T img1.jpeg \
  -X POST 'https://services.mobile.de/seller-api/images'
Request
POST /seller-api/images HTTP/1.1
Host: services.mobile.de
Content-Type: image/jpeg
Accept: application/vnd.de.mobile.api+json
Content-Length: 97451

<binary image data>
Response
HTTP/1.1 201 Created
Content-Length: 204
Content-Type: application/vnd.de.mobile.api+json
Location: https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg

{
  "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg",
  "hash": "ee57b82fbcb7a091f25ce675fa26a782"
}

Associate images

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Associates images identified by references to the ad identified by the mobileAdId path parameter. The response provides a list of associated images. In case some invalid image references are submitted they will be ignored and not included in the response.

Data Types
Request Success Response Error Response

Images

Images

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation Remedy

400

invalid-url-syntax

Unable to parse the specified image reference.

Correct the image reference.

400

images-per-ad-limit-exeeded

Too many images for a given ad.

Please refer to the retrieving seller information endpoint for details how to get the maximum number of allowed images.

400

concurrent-update-error

Concurrent update on the ad resource.

Retry the upload call.
Request
PUT /seller-api/sellers/12/ads/217221/images HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942c713b?rule=mo-640.jpg"
        }
    ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg",
            "hash": "0be1f77c12883d9ee8d5045f5afbd87b"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942c713b?rule=mo-640.jpg",
            "hash": "4da20fd3c37ec93f928ece5ae9f015a0"
        }
    ]
}

If the number of returned images is smaller than in the request it means that some image references were not accepted. They were either broken or did not exist in our database anymore.

Upload images multipart

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Uploads images for an Ad identified by the mobileAdId path parameter. The API call to add images supports two modes:

Add pictures initially

All images, which are related to the ad are added to it via the API in one single call.

The content-type of the request entity must be multipart/form-data. The content type of a single part must be image/jpeg. The parts are named "image".

The images are attached to the ad in the same order as you put them into the request.

The response will be a list of image URLs. You have to store those URLs as a reference for future image operations an this ad.

Change pictures

After initially putting images to the ad you can also remove single images, change image order or add other images to the ad.

In this case a single part of the request entity contains either an image in the way described above or the internal image url. A part containing an internal image url must be named image-ref. Please note that external URLs will be rejected!

Just send another multipart request. You only need to provide binary image data for new images. All existing images are referenced by their picture-service-URLs. In this case the name of the single part is image-ref. Images that are no longer referenced will be deleted. New images included as binary data will be added. The order in the multipart request becomes the order of the ads images. Have a look at the below example.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Images

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation Remedy

500

n/a

Unable to upload image due to network or storage error

Retry the call

400

not-a-jpeg-file

Submitted image doesn’t meet the criteria.

The image can’t be uploaded. Please use another image.

400

invalid-url-syntax

Unable to parse the specified image reference.

Correct the image reference.

400

images-per-ad-limit-exeeded

Too many images for a given ad.

Please refer to the retrieving seller information endpoint for details how to get the maximum number of allowed images.

400

unsupported-form-element

The multipart POST request contains invalid form elements.

Please refer to the Add pictures initially and Change pictures for details how to build a multipart request.

400

broken-multipart-upload

The POST data is not a syntactically correct multipart request.

Please refer to the Add pictures initially and Change pictures for details how to build a multipart request.

400

concurrent-update-error

Concurrent update on the ad resource.

Retry the upload call.
Upload new images curl command

This is a sample curl command assuming that the images img1.jpeg and img2.jpeg are in current directory.

curl -v -s -u username:password \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/vnd.de.mobile.api+json" \
  -F "image=@img1.jpeg;type=image/jpeg" \
  -F "image=@img2.jpeg;type=image/jpeg" \
  -XPUT 'https://services.mobile.de/seller-api/sellers/12/ads/217221/images'

Alternative syntax with enummeration for files, e.g. image1=@img1.jpeg, image2=@img2.jpeg:

curl -v -s -u username:password \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/vnd.de.mobile.api+json" \
  -F "image1=@img1.jpeg;type=image/jpeg" \
  -F "image2=@img2.jpeg;type=image/jpeg" \
  -XPUT 'https://services.mobile.de/seller-api/sellers/12/ads/217221/images'
Request
PUT /seller-api/sellers/12/ads/217221/images HTTP/1.1
Host: services.mobile.de
Content-Type: multipart/form-data; boundary=vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx

--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx
Content-Disposition: form-data; name="image"; filename="img1.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: binary

 ...some binary JPEG data omitted here...
--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx
Content-Disposition: form-data; name="image"; filename="img2.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: binary

 ...some binary JPEG data omitted here...
--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx--
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg",
            "hash": "5420c3991bd070d64fc3d5e9815c7de6"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942d713b?rule=mo-640.jpg",
            "hash": "d42dceec6006b1c45dc4c9a7afaedd97"
        }
    ]
}
Change the order of existing images curl command
curl -v -s -u username:password \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/vnd.de.mobile.api+json" \
  -F 'image-ref=https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4b7f-ba2b-5f50922d713b?rule=mo-640.jpg' \
  -F 'image-ref=https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg' \
  -X PUT 'https://services.mobile.de/seller-api/sellers/12/ads/217221/images'

  • No need to re-upload the binary data again. Now we send references to previously uploaded images using image-ref field and ref value from the original upload call.

  • Please note that now the images are in different order.

  • Both methods could be mixed in a single call, i.e. referencing existing images and uploading new ones.
Request
PUT /seller-api/sellers/12/ads/217221/images HTTP/1.1
Host: services.mobile.de
Content-Type: multipart/form-data; boundary=vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx

https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942d713b?rule=mo-640.jpg
--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx
Content-Disposition: form-data; name="image-ref"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg
--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx
Content-Disposition: form-data; name="image-ref"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

--vjrLeiXjJaWiU0JzZkUPO1rMcE2HQ-n7XsSx--
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942d713b?rule=mo-640.jpg"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg"
        }
    ]
}

Get all image URLs

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Lists images for an Ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Images

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Request
GET /seller-api/sellers/12/ads/217221/images HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "images": [
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942d713b?rule=mo-640.jpg"
        },
        {
            "ref": "https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50922d713b?rule=mo-640.jpg"
        }
    ]
}

Delete all images

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/images

Deletes images associated with the Ad identified by the mobileAdId path parameter.

It is NOT required to delete the images before deleting the ad.
Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Request
DELETE /seller-api/sellers/12/ads/217221/images HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 204 No Content

Auto Panorama

Upload Interior Image

POST /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior-image

Uploads an image of the vehicle interior that in the second step will be used for creating Auto Panorama view. The result of this call is an image reference e.g. /api/media/1000 which will be used as an argument to the Create Interior Auto Panorama call.

Image requirements:

  • Ratio: 2:1

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

binary image data with the image/jpeg content type

AutoPanoramaImage

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code

Explanation

400

not-a-jpeg-file

The uploaded image does not meet the required criterias or is empty.

404

n/a
Curl
curl -X POST 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior-image' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: image/jpeg; charset=ISO-8859-1' -T '/path/to/file/with/<image data>'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
POST https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior-image HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: image/jpeg; charset=ISO-8859-1

<image data>
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:10 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 25

{
  "ref": "/api/media/1003"
}

Create Interior Auto Panorama

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Creates an interior Auto Panorama from an image uploaded through the Upload Interior Image api call.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

AutoPanoramaInterior

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

empty-image-reference

The submitted request does not contain image reference.

400

invalid-image-reference

The submitted image reference is not valid any more.

404

n/a

Indicates that the given Api User does not have permission to update ads for the specified seller.
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior' \
     -H 'Accept: */*' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1' -d '
{
  "image": {
    "ref": "/api/media/14796"
  }
}
'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
PUT https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior HTTP/1.1
Accept: */*
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1

{
  "image": {
    "ref": "/api/media/14796"
  }
}
Response
HTTP/1.1 204 No Content
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json

Get Interior Auto Panorama

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Retrieves an interior Auto Panorama for given ad.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

AutoPanoramaInterior

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
GET https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 36

{
  "image": {
    "ref": "/api/media/14796"
  }
}

Delete Interior Auto Panorama

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/interior

Deletes an interior Auto Panorama for given ad.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to update ads for the specified seller.
Curl
curl -X DELETE 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
DELETE https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/interior HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 204 No Content
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json

Upload Exterior Image

POST /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior-image

Uploads an image - a single frame of a 360 degree external Auto Panorama. The result of this call is an image reference e.g. /api/media/1000. Once all frames of the external Auto Panorama are uploaded and image references collected, they will be used as an argument to the Create Exterior Auto Panorama call.

Image requirements:

  • Resolution: up to 3240 × 2160 Pixel

  • Number of images: 12-60

  • File size: 1-4MB optimal

  • Ratio: 3:2 or 2:1

To reduce the total amount of time needed to create an external Auto Panorama, it is recommended to upload the images of individual frames in parallel.
Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

binary image data with the image/jpeg content type

AutoPanoramaImage

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

400

not-a-jpeg-file

The uploaded image does not meet the required criterias or is empty.

404
Curl
curl -X POST 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior-image' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: image/jpeg; charset=ISO-8859-1' -T '/path/to/file/with/<image data>'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
POST https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior-image HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: image/jpeg; charset=ISO-8859-1

<image data>
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:10 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 25

{
  "ref": "/api/media/1004"
}

Create Exterior Auto Panorama

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Creates an exterior Auto Panorama from an images uploaded through the Upload Exterior Image api call. The image references must be specified in correct order.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

AutoPanoramaExterior

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

empty-image-reference

The submitted request does not contain image reference.

400

invalid-image-reference

The submitted image reference is not valid any more.

404

n/a

Indicates that the given Api User does not have permission to update ads for the specified seller.
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior' \
     -H 'Accept: */*' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1' -d '
{
  "images": [
    {
      "ref": "/api/media/1001"
    },
    {
      "ref": "/api/media/1002"
    },
    {
      "ref": "/api/media/1003"
    },
    {
      "ref": "/api/media/1004"
    },
    {
      "ref": "/api/media/1005"
    },
    {
      "ref": "/api/media/1006"
    },
    {
      "ref": "/api/media/1007"
    },
    {
      "ref": "/api/media/1008"
    },
    {
      "ref": "/api/media/1009"
    },
    {
      "ref": "/api/media/1010"
    }
  ]
}
'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
PUT https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior HTTP/1.1
Accept: */*
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1

{
  "images": [
    {
      "ref": "/api/media/1001"
    },
    {
      "ref": "/api/media/1002"
    },
    {
      "ref": "/api/media/1003"
    },
    {
      "ref": "/api/media/1004"
    },
    {
      "ref": "/api/media/1005"
    },
    {
      "ref": "/api/media/1006"
    },
    {
      "ref": "/api/media/1007"
    },
    {
      "ref": "/api/media/1008"
    },
    {
      "ref": "/api/media/1009"
    },
    {
      "ref": "/api/media/1010"
    }
  ]
}
Response
HTTP/1.1 204 No Content
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json

Get Exterior Auto Panorama

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Retrieves an exterior Auto Panorama for given ad.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

AutoPanoramaExterior

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
GET https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 66

{
  "images": [
    {
      "ref": "/api/media/14796"
    },
    {
      "ref": "/api/media/14797"
    }
  ]
}

Delete Exterior Auto Panorama

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/auto-panorama/exterior

Deletes an exterior Auto Panorama for given ad.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to update ads for the specified seller.
Curl
curl -X DELETE 'https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior' \
     -H 'Accept: application/vnd.de.mobile.api+json'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
DELETE https://services.mobile.de/seller-api/sellers/28481/ads/34561/auto-panorama/exterior HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 204 No Content
Date: Thu, 04 Apr 2024 14:23:11 GMT
Content-Type: application/vnd.de.mobile.api+json

Price Rating

It is possible to retrieve a price rating for a specific vehicle shortly after the vehicle is created. It is also possible to preview price rating information for vehicles that have not been created yet. mobile.de rates the offer price by analyzing a wide range of vehicle data and comparing it with similar offers. Buyers can then assess the price immediately. This will be reflected in the label element.

Retrieve ad price rating

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/price-rating

Retrieves price rating information for an Ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

PriceRating

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Endpoint

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/price-rating

Request
GET /seller-api/sellers/12/ads/217221/price-rating HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "label": "GOOD_PRICE"
}

Preview ad price rating

POST /seller-api/sellers/:mobileSellerId/ads/price-rating

Preview price rating information for an Ad that has not been created yet.

Price rating prediction is only working for the new data format (xml+json).
Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

Ad

PriceRating

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Endpoint

POST /seller-api/sellers/:mobileSellerId/ads/price-rating

Request
POST /seller-api/sellers/:mobileSellerId/ads/price-rating HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Car",
  "category": "Limousine",
  "make": "AUDI",
  "model": "A7",
  "modelDescription": "A7 Premium",
  "condition": "USED",
  "firstRegistration": "201003",
  "mileage": 20000,
  "cubicCapacity": 1699,
  "power": 85,
  "gearbox": "MANUAL_GEAR",
  "fuel": "PETROL",
  "seats": 5,
  "damageUnrepaired": false,
  "abs": true,
  "alloyWheels": true,
  "centralLocking": true,
  "climatisation": "MANUAL_CLIMATISATION",
  "electricWindows": true,
  "esp": true,
  "powerAssistedSteering": true,
  "description": "",
  "kba": {
    "hsn": "999",
    "tsn": "ALU"
  },
  "price": {
    "consumerPriceGross": "20000.00",
    "type": "FIXED",
    "currency": "EUR"
  }
 }
Response
HTTP/1.1 200 OK
Content-Length: 314
Content-Type: application/vnd.de.mobile.api+json

{
  "label": "INCREASED_PRICE",
  "labelRanges": [
    {
      "label": "VERY_GOOD_PRICE",
      "from": "13600",
      "to": "16200"
    },
    {
      "label": "GOOD_PRICE",
      "from": "16200",
      "to": "17300"
    },
    {
      "label": "REASONABLE_PRICE",
      "from": "17300",
      "to": "19200"
    },
    {
      "label": "INCREASED_PRICE",
      "from": "19200",
      "to": "21400"
    },
    {
      "label": "HIGH_PRICE",
      "from": "21400",
      "to": "23100"
    }
  ]
}
NO_RATING Response

In case there is no price rating available a reason will be provided. Currently possible reason codes are:

reason code

damaged_cars_not_supported

unrepaired_cars_not_supported

only_ready_to_drive_cars_supported

new_cars_not_supported

price_below_8000_euro

price_over_40000_euro

seats_over_9

over_10_years_old

usage_type_not_supported

mileage_above_1000_km

disabled_accessible_cars_not_supported

only_category_cars_supported

model_not_supported

only_german_market_cars_supported

price_below_3000_euro

price_over_150000_euro

mileage_below_1000_km

price_too_low

price_too_high

mileage_negative

power_negative

cubic_capacity_negative

first_registration_invalid

unsupported_make_model
Example
HTTP/1.1 200 OK
Content-Length: 58
Content-Type: application/vnd.de.mobile.api+json

{
  "label": "NO_RATING",
  "reasons": [
    "unsupported_make_model"
  ]
}

Statistics

It is possible to retrieve important demand metrics for an ad. This function delivers strictly private information, which must not be displayed to any other user except the corresponding customer. It is not allowed to store this information longer than the duration of the ad it relates to or to aggregate this data.

You need special permission to be able to do this API call.

Retrieve ad statistics

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/statistic

Retrieves statistics for an Ad identified by the mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Statistic

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Endpoint

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/statistic

Request
GET /seller-api/sellers/12/ads/217221/statistic HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "impressions": 32,
    "parkings": 5,
    "emails": 2,
    "calls": 3
}
Other Errors Cases
Error Key Description

not-allowed-to-see-statistics

The user doesn’t have permission to read the statistics.

Seller Upload Credentials

Using this SellerAPI resource it is possible to create, retrieve and delete upload credentials for assigned dealers. This should be usually used for offline installed TSP-Tools as it is not allowed to store the TSP-Account-Credentials on the dealers device.

  • As long as individual credentials are present write actions are not allowed using the TSP-Account-Credentials.

  • This resource is only implemented for the new data format.

Create upload credentials

POST /seller-api/sellers/:mobileSellerId/self-upload-account

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

SelfUploadAccount

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Curl
curl -X POST 'https://services.mobile.de/seller-api/sellers/16/self-upload-account' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1'
Request
POST https://services.mobile.de/seller-api/sellers/16/self-upload-account HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1
Response
HTTP/1.1 201 Created
Date: Thu, 04 Apr 2024 14:23:19 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 63

{
  "accountName": "itsp_tsp-1_dealer-1",
  "password": "B0jcWJ2wigiy"
}

  • Results in an HTTP status 403 (Forbidden) if an account already exists.

Retrieve upload credentials

GET /seller-api/sellers/:mobileSellerId/self-upload-account

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

SelfUploadAccount

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/15/self-upload-account' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/15/self-upload-account HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:19 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 80

{
  "accountName": "itsp_tsp-1_dealer-1",
  "creationTime": "2017-03-16T16:07:45+01:00"
}

Delete upload credentials

DELETE /seller-api/sellers/:mobileSellerId/self-upload-account

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Curl
curl -X DELETE 'https://services.mobile.de/seller-api/sellers/15/self-upload-account' \
     -H 'Accept: application/vnd.de.mobile.api+xml'
Request
DELETE https://services.mobile.de/seller-api/sellers/15/self-upload-account HTTP/1.1
Accept: application/vnd.de.mobile.api+xml
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:19 GMT
Content-Type: application/vnd.de.mobile.api+xml
Content-Length: 0

Dealer Ratings

This set of resources allow the management of dealer ratings via Seller-API. Dealer ratings can be retrieved, answered and buyers can be invited to submit dealer ratings. The concept is similar to the implementation in dealer area. More information about dealer rating management in dealer area and in general can be found at dealer rating page.

  • The dealer must be at least in account package Comfort and must have activated dealer rating management for TSPs in dealer area.

  • This resource is only implemented for the new data format.

Check Permissions

If a dealer has activated the rating API can be checked via the seller resource. See Seller for the field description:

Request
GET /seller-api/sellers/12 HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    ...
    "settings": {
        ...
        "dealerRating": {
            "eligible": true,
            "active": true,
            "personalizedInviteText": true
        }
        ...
    },
    ...
}

Retrieve dealer rating overview

The dealer rating overview is the summary of the dealers ratings. It needs a certain amount of ratings to be available.

GET /seller-api/sellers/:mobileSellerId/rating/overview

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

RatingOverview

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

Either the dealer did not activate dealer rating management for the TSP or the rating overview is not available.
Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/15/rating/overview' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/15/rating/overview HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:32 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 134

{
  "score": 4.4,
  "totalActiveRatings": 9,
  "advice": 4.13,
  "friendliness": 4.44,
  "responseTime": 4.67,
  "recommendation": 86,
  "vehicleAsDescribed": 86
}

Retrieve dealer ratings

Retrieve a list of all relevant dealer ratings.

GET /seller-api/sellers/:mobileSellerId/rating/ratings

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Ratings

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

The dealer did not activate dealer rating management for the TSP.
Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/15/rating/ratings' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/15/rating/ratings HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:32 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 1695

{
  "ratings": [
    {
      "ratingId": "1846374855",
      "completionTime": "2019-08-12T19:34:59+02:00",
      "advice": 4.0,
      "friendliness": 4.0,
      "responseTime": 4.0,
      "recommendation": "YES",
      "vehicleAsDescribed": "YES",
      "dealerContactedBy": {
        "phone": true,
        "email": false,
        "personally": false
      },
      "likeAboutDealer": "Super toll.",
      "notLikeAboutDealer": "Das Auto fährt nicht.",
      "ratingWasHelpfulResponses": 0,
      "ratingAuthor": {
        "salutation": "MALE",
        "name": "Max Mustermann"
      },
      "dealerContactPerson": {
        "salutation": "MALE",
        "name": "Mustermann"
      },
      "ad": {
        "title": "Ford Transit Custom Kombi 320L1 Trend Navi|Kamera|DAB",
        "price": "26970.01",
        "firstRegistration": "201902",
        "mileage": 22679,
        "power": "96 kW (131 PS)",
        "gearbox": "AUTOMATIC_GEAR",
        "exteriorColor": "GREY",
        "internalNumber": "XYZ9110"
      }
    },
    {
      "ratingId": "1760660222",
      "completionTime": "2019-06-20T14:17:29+02:00",
      "advice": 5.0,
      "friendliness": 5.0,
      "responseTime": 5.0,
      "recommendation": "YES",
      "vehicleAsDescribed": "YES",
      "boughtTheCar": "YES",
      "dealerContactedBy": {
        "phone": true,
        "email": false,
        "personally": true
      },
      "likeAboutDealer": "Die Beratung fand in freundlicher Athmosphäre statt.\nDer Verkäufer war sehr kompetent und hat alle meine Fragen sehr gut beantwortet.\nSehr gut fand ich, dass ich das Fahrzeug schon einen Tag früher als vereinbart bekommen konnte und so meine Fahraufträge sicher waren.",
      "notLikeAboutDealer": "",
      "ratingWasHelpfulResponses": 0,
      "ratingAuthor": {
        "salutation": "MALE",
        "name": "Peter Mustermann"
      },
      "dealerContactPerson": {
        "salutation": "MALE",
        "name": "Max Mustermann"
      },
      "ad": {
        "title": "Ford Transit Custom 2.0 TDCi 320 L2 Trend Kombi",
        "price": "25440.0",
        "firstRegistration": "201812",
        "mileage": 15905,
        "power": "96 kW (131 PS)",
        "gearbox": "AUTOMATIC_GEAR",
        "exteriorColor": "WHITE",
        "internalNumber": "XZY46477"
      }
    }
  ]
}

Retrieve single dealer rating

PUT /seller-api/sellers/:mobileSellerId/rating/ratings/:ratingId

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

ratingId

Unique identifier of a rating for a specific dealer.
Data Types
Request Success Response Error Response

n/a

Rating

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

The dealer did not activate dealer rating management for the TSP or the rating id is not available.
Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/15/rating/ratings/1195501264' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/15/rating/ratings/1195501264 HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:33 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 792

{
  "ratingId": "1195501264",
  "completionTime": "2018-04-20T19:34:41+02:00",
  "advice": 5.0,
  "friendliness": 5.0,
  "responseTime": 5.0,
  "recommendation": "YES",
  "vehicleAsDescribed": "YES",
  "boughtTheCar": "YES",
  "dealerContactedBy": {
    "phone": true,
    "email": true,
    "personally": true
  },
  "likeAboutDealer": "Super Beratung, Kofferraumgröße war wichtig, konnte Probepacke machen ",
  "notLikeAboutDealer": "Zu weit entfernt von meinem Wohnort",
  "ratingWasHelpfulResponses": 0,
  "ratingAuthor": {
    "salutation": "FEMALE",
    "name": "Musterfrau"
  },
  "dealerContactPerson": {
    "salutation": "MALE",
    "name": "Mustermann"
  },
  "ad": {
    "title": "Ford Focus 1.0 EcoBoost Business WinterP|Navi|PCD",
    "price": "15980.0",
    "firstRegistration": "201706",
    "mileage": 9450,
    "power": "92 kW (125 PS)",
    "gearbox": "MANUAL_GEAR",
    "exteriorColor": "WHITE",
    "internalNumber": "XYZ3311"
  }
}

Reply on dealer rating

PUT /seller-api/sellers/:mobileSellerId/rating/ratings/:ratingId/comment

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

ratingId

Unique identifier of a rating for a specific dealer.
Data Types
Request Success Response Error Response

RatingReply

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

rating_reply_too_long

A rating reply can be maximum 1000 characters.

400

rating_reply_is_empty

A rating reply can not be empty.

403

rating_reply_already_exists

Only one reply can be sent per rating.

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

The dealer did not activate dealer rating management for the TSP or the rating id is not available.
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/15/rating/ratings/1846374856/comment' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: text/plain; charset=ISO-8859-1' -d '{"comment":"Sehr geehrter Herr Mustermann, \n\n vielen Dank für die tolle Bewertung. \nWir wünschen Ihnen viel Spass mit Ihrem neuen Auto. \n\nIhr Autohaus"}'
Request
PUT https://services.mobile.de/seller-api/sellers/15/rating/ratings/1846374856/comment HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: text/plain; charset=ISO-8859-1

{"comment":"Sehr geehrter Herr Mustermann, \n\n vielen Dank für die tolle Bewertung. \nWir wünschen Ihnen viel Spass mit Ihrem neuen Auto. \n\nIhr Autohaus"}
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:35 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 0

Retrieve dealer rating invites and inviteables

The dealer can send out rating invitations. This resource provides a list of invites including mobileAdIds which are eligible for invitation and invites where invitations have been triggered already by the dealer or TSP.

GET /seller-api/sellers/:mobileSellerId/rating/invites

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

EmailInvites

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

The dealer did not activate dealer rating management for the TSP.
Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/15/rating/invites' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/15/rating/invites HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:33 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 2139

{
  "invites": [
    {
      "mobileAdId": "257859209",
      "title": "Ford Transit Custom 2.0 TDCi 320 L2 Trend Kombi",
      "internalNumber": "XYZ46477",
      "price": "25440.0",
      "firstRegistration": "201812",
      "mileage": 15905,
      "deletionTime": "2019-11-01T12:03:44+01:00",
      "state": "ELIGIBLE"
    },
    {
      "mobileAdId": "283873237",
      "title": "AUDI A6 Allroad 3.0 TDI PARKASSIST,NACHTSICHT,20ZOLL",
      "internalNumber": "1-11",
      "price": "33880.0",
      "firstRegistration": "201501",
      "mileage": 49800,
      "deletionTime": "2019-10-05T09:18:51+02:00",
      "buyerEmail": "foo@bar.de",
      "personalizedInviteText": "personal invite text",
      "invitationTime": "2019-11-04T19:20:36+01:00",
      "reinviteable": true,
      "state": "SENT"
    },
    {
      "mobileAdId": "285423509",
      "title": "VW CC 2.0 TDI KEYLESS GO,MEMORY,KAMERA,PANORAMADACH",
      "internalNumber": "2-22",
      "price": "15880.0",
      "firstRegistration": "201207",
      "mileage": 46006,
      "deletionTime": "2019-10-25T15:10:51+02:00",
      "buyerEmail": "foo2@ybar.de",
      "personalizedInviteText": "Sehr geehrter Herr Mustermann, \n\nwir gratulieren Ihnen zum Kauf Ihres neuen Fahrzeugs und bedanken uns herzlich für Ihr Vertrauen.\n\nWir würden uns freuen, wenn Sie sich einige Minuten Zeit nehmen könnten, um uns zu bewerten.\n\nMit freundlichen Grüßen\n\nIhr Musterautohaus",
      "invitationTime": "2019-10-31T19:01:04+01:00",
      "reinviteable": false,
      "state": "STARTED"
    },
    {
      "mobileAdId": "262167514",
      "title": "ACURA RSX",
      "internalNumber": "",
      "price": "13298.0",
      "firstRegistration": "201603",
      "mileage": 55555,
      "deletionTime": "2019-10-21T12:38:35+02:00",
      "buyerEmail": "foobar@com",
      "reinviteable": false,
      "state": "PENDING"
    },
    {
      "mobileAdId": "283471667",
      "title": "VW Caddy 1.6 TDI Kasten BOTT WERKSTATT-EINBAU,AHK",
      "internalNumber": "4-44",
      "price": "8880.0",
      "firstRegistration": "201401",
      "mileage": 31270,
      "deletionTime": "2019-10-08T13:21:54+02:00",
      "buyerEmail": "foo4@bar.com",
      "personalizedInviteText": "Sehr geehrter Herr Mustermann, \n\nwir gratulieren Ihnen zum Kauf Ihres neuen Fahrzeugs und bedanken uns herzlich für Ihr Vertrauen.\n\nWir würden uns freuen, wenn Sie sich einige Minuten Zeit nehmen könnten, um uns zu bewerten.\n\nMit freundlichen Grüßen\n\nIhr Musterautohaus",
      "invitationTime": "2019-10-30T19:28:55+01:00",
      "reinviteable": false,
      "state": "SENT"
    }
  ]
}

Invite buyers to submit dealer rating

After a purchased vehicle is deleted from mobile.de marketplace an invitation can be sent to the buyer to rate the dealer. Which mobileAdIds are eligible for invitation can be found out via the above GET /seller-api/sellers/:mobileSellerId/rating/invites endpoint. When the dealer made a mistake or would like to send a reminder a second invite can be sent to the buyer as soon as the first invite has been processed, which takes normally one day. Before an invitation can be send to the buyer the dealer must get the buyers consent for the invitation and sharing of his email address with mobile.de. The dealer can download a personalized consent form at https://handel.mobile.de/dealerratings/invite-consent-form or without the need to login here.

POST /seller-api/sellers/:mobileSellerId/rating/invites/:mobileAdId

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

EmailInvite

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

buyer_email_not_allowed

There are certain rules to prevent cheating.

400

invite_for_ad_already_exists

An invite for the mobileAdId already exists.

400

rating_for_ad_already_exists

A rating for the mobileAdId already exists.

400

personalized_invite_text_not_supported

Dealer needs to be at least in package Premium for this feature.

400

not_reinviteable

This mobileAdId is not reinviteable.

400

invite_email_invalid

Email address needs to be valid.

400

invite_email_empty

Email address can not be empty.

400

invite_text_empty

When no personalized invite text is required, it should not be sent or set to null, but can not be blank.

400

invite_text_too_long

The personalized invite text can be maximum 3000 characters long.

403

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

404

n/a

The resource is not found or the dealer did not activate dealer rating management for the TSP.
Curl
curl -X POST 'https://services.mobile.de/seller-api/sellers/15/rating/invites/123' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: text/plain; charset=ISO-8859-1' -d '{"buyerEmail":"dealer@rating.com"}'
Request
POST https://services.mobile.de/seller-api/sellers/15/rating/invites/123 HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: text/plain; charset=ISO-8859-1

{"buyerEmail":"dealer@rating.com"}
Response
HTTP/1.1 204 No Content
Date: Thu, 04 Apr 2024 14:23:35 GMT
Content-Type: application/vnd.de.mobile.api+json
States of the Invitation
ELIIGIBLE --(1)-> PENDING --(2)-> SENT --(3)-> STARTED
                     ^_____(4)_____|
ELIGIBLE

There is an eligible ad for which the dealer can request the rating.

GET :sellerId/rating/invites/:mobileAdId
{
    "mobileAdId": "262167561",
    "title": "ACURA RSX",
    "price": "5555.0",
    "firstRegistration": "201603",
    "mileage": 55555,
    "state": "ELIGIBLE"
}

Transitions:

(1) The dealer submits the email address of the user.

POST :sellerId/rating/invites/:mobileAdId
{
    "buyerEmail": "foobar@gmx.de",
    "inviteText": "hello there"
}
PENDING

The email address is submitted and the invitation email is scheduled for sending.

GET :sellerId/rating/invites/:mobileAdId
{
    "mobileAdId": "262167561",
    "title": "ACURA RSX",
    "price": "5555.0",
    "firstRegistration": "201603",
    "mileage": 55555,
    "state": "PENDING",
    "buyerEmail": "foobar@gmx.de",
    "inviteText": "hello there"
}

Transitions:

(2) The rating engine sends the email to the user.

SENT

The invitation is sent to the user. The user can start completing the survey.

GET :sellerId/rating/invites/:mobileAdId
{
    "mobileAdId": "262167561",
    "title": "ACURA RSX",
    "price": "5555.0",
    "firstRegistration": "201603",
    "mileage": 55555,
    "state": "SENT",
    "buyerEmail": "foobar@gmx.de",
    "inviteText": "hello there",
    "reinviteable": true
}

Transitions:

(3) The user starts completing the survey.

(4) There is no reaction from the user. The dealer decides to resend the invitation or use another email address.

POST :sellerId/rating/invites/:mobileAdId
{
    "buyerEmail": "foobaz@gmx.de",
    "inviteText": "hello there"
}
STARTED

The user has already started the survey. Once the survey is completed a new dealer rating will be created.

Leasing

An ad can be extended with leasing information to show a specific number of leasing rates to the potential vehicle buyer. At the moment, we only support mileage leasing (kilometer leasing). And we only support offers to customers in Germany due to VAT regulations. Leasing information consists of some general information relevant for all leasing rates of this ad and specific rates. A leasing rate in this case is a combination of duration of the leasing contract in month, the annual mileage allowed in the contract terms and, in the future, a down payment. Currently, the down payment is always 0, but this might change in the future. It is not possible to submit two rates with the same annualMileage and termOfContract within the same rate type.

Create or update leasing rate

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

Create or update leasing rates for the ad of a seller identified by mobileSellerId and mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

A unique identifier of the ad published on the mobile.de platform.
Data Types
Request Success Response Error Response

Leasing

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

duplicate_mileage_contract

Duplicate annualMileage and termOfContract within same rate type.

400

leasing_ad_has_no_vat

Leasing not possible for the given ad when the price has no VAT set

404

n/a

Indicates that the given Api User does not have permission to create leasing for the ad of specified seller.
Sample Success Request
PUT /seller-api/sellers/12/ads/217220/leasing HTTP/1.1
Host: services.mobile.de
Content-Type: application/vnd.de.mobile.api+json

{
  "grossListPrice": 20000,
  "vatRate": "19.00",
  "lender": "Test-Auto",
  "rates": [
    {
      "type": "PRIVATE",
      "downPayment": 0,
      "termOfContract": "12",
      "annualMileage": "10000",
      "totalAmount": "300.50",
      "grossRate": "300.50",
      "netLoanAmount": "50.00",
      "annualPercentageRate": "15.00",
      "nominalInterestRate": "19.00",
      "destinationCharges": "40.00",
      "registrationFees": "30.00",
      "extraMileageCosts": "20.50",
      "lowMileageCompensation": "15.99",
      "maintenanceMonthlyCost": "10.0",
      "wearMonthlyCost": "11.0",
      "maintenanceAndWearCombinedMonthlyCost": "21.0",
      "liabilityInsuranceMonthlyCost": "15.0",
      "liabilityInsuranceDeductible": "200.0",
      "fullyComprehensiveInsuranceMonthlyCost": "25.0",
      "fullyComprehensiveInsuranceDeductible": "300.0",
      "vehicleTaxMonthlyCost": "12.0",
      "summerAndWinterTiresMonthlyCost": "50.0",
      "tuevMonthlyCost": "22.0",
      "returnInsuranceMonthlyCost": "15.0"
    },
    {
      "type": "COMMERCIAL",
      "downPayment": 0,
      "termOfContract": "12",
      "annualMileage": "15000",
      "totalAmount": "400.50",
      "netRate": "350.50",
      "netLoanAmount": "50.00",
      "annualPercentageRate": "15.00",
      "nominalInterestRate": "19.00",
      "destinationCharges": "40.00",
      "registrationFees": "30.00",
      "extraMileageCosts": "25.50",
      "lowMileageCompensation": "19.99",
      "maintenanceMonthlyCost": "10.0",
      "wearMonthlyCost": "11.0",
      "maintenanceAndWearCombinedMonthlyCost": "21.0",
      "liabilityInsuranceMonthlyCost": "15.0",
      "liabilityInsuranceDeductible": "200.0",
      "fullyComprehensiveInsuranceMonthlyCost": "25.0",
      "fullyComprehensiveInsuranceDeductible": "300.0",
      "vehicleTaxMonthlyCost": "12.0",
      "summerAndWinterTiresMonthlyCost": "50.0",
      "tuevMonthlyCost": "22.0",
      "returnInsuranceMonthlyCost": "15.0"
    }
  ],
  "comment": "my leasing comment"
}
Sample Success Response
HTTP/1.1 200 Ok

Get leasing rate

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

Get leasing rates for the ad of a seller identified by mobileSellerId and mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

Leasing

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Status Code Explanation

404

Indicates that the given Api User does not have permission to create leasing for the ad of specified seller.
Request
GET /seller-api/sellers/12/ads/217221/leasing HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
  "grossListPrice": 20000,
  "vatRate": "19.00",
  "lender": "Test-Auto",
  "rates": [
    {
      "type": "PRIVATE",
      "downPayment": 0,
      "termOfContract": "12",
      "annualMileage": "10000",
      "totalAmount": "300.50",
      "grossRate": "300.50",
      "netLoanAmount": "50.00",
      "annualPercentageRate": "15.00",
      "nominalInterestRate": "19.00",
      "destinationCharges": "40.00",
      "registrationFees": "30.00",
      "extraMileageCosts": "20.50",
      "lowMileageCompensation": "15.99"
    },
    {
      "type": "COMMERCIAL",
      "downPayment": 0,
      "termOfContract": "12",
      "annualMileage": "15000",
      "totalAmount": "400.50",
      "netRate": "350.50",
      "netLoanAmount": "50.00",
      "annualPercentageRate": "15.00",
      "nominalInterestRate": "19.00",
      "destinationCharges": "40.00",
      "registrationFees": "30.00",
      "extraMileageCosts": "25.50",
      "lowMileageCompensation": "19.99"
    }
  ],
  "comment": "my leasing comment"
}

Delete leasing rate

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/leasing

Deletes leasing rates associated with the Ad identified by mobileSellerId and mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the ad on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Request
DELETE /seller-api/sellers/12/ads/217221/leasing HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 204 No Content

OBS

Under the business model “Online Buying and Selling” (short “OBS”, German: “Online-Kauf”) mobile.de buys the vehicle from the dealer and acts as the contracting party towards the end customer. To fulfil its legal duties towards end customers and to mitigate its liability risks, mobile.de is obliged to ensure that the condition of the sold vehicles is as advertised. Therefore, mobile.de requests from participating partner dealers additional information, especially vehicle documents and additional input about the vehicle’s condition. Furthermore, mobile.de asks its partner dealers for contact information that is required to handle the pickup from the dealer’s location and the shipping to the end customer as smoothly as possible.

The endpoints described in the following are used to enrich already existing classifieds listings (given by the mobileAdId) with OBS-relevant information to allow mobile.de to perform quality checks before publishing them under OBS. API users may further use these endpoints to read, alter and delete previously submitted OBS-relevant information. The endpoints use the already existing authentication of the Seller API.

Please, note that mobile.de currently explores the possibility of allowing its OBS partner dealers to sell directly to the end customer via Online-Kauf. Under this scenario mobile.de as a platform provider will, independently of its own liability risk towards the end customer, maintain its right to scrutinise listings and to request additional information for the advertised vehicles to ensure a high level of quality and transparency for all published Online-Kauf listings.

The number of OBS partner dealers is steadily growing and new partner dealers are signed for OBS individually. Please, note that mobile.de does not yet provide an endpoint for transfer service providers to query whether their customers take part in OBS or not.

The new endpoints can only be used for listings belonging to onboarded OBS partner dealers. API requests to the new endpoints will return a 403 error (“Forbidden”) if the listings do not belong to an onboarded OBS partner dealer. For test purposes, the sandbox test accounts API1 to API5 are marked as OBS partner dealers. For further information about test accounts, please refer to https://services.mobile.de/docs/seller-api.html#_test_account.

To ensure the eligibility of the classifieds listings for OBS, certain fields need to be filled. When creating classified listings to test the OBS specific endpoints, it is advised to use the following example values.

  • “vehicleClass”: “Car”

  • “condition”: “USED”

  • “mileage”: 40000

  • “firstRegistration”: “202301”

  • "numberOfPreviousOwners": 1

  • “consumerPriceGross”: "40000.00"

  • “accidentDamaged”: false

  • “roadworthy”: true

  • “damageUnrepaired”: false

Since verifying the quality of the enriched listings is partially a manual process, there is no automatic update / API response regarding the status of the listing (whether it was published under OBS or not). An additional GET endpoint may be included in later releases to cover this use case.

All fields described are optional. We encourage participating dealers and their contracted transfer service providers to submit as many details as possible. mobile.de maintains quality checks of all OBS listings and may not publish listings if critical information is missing. Further details are communicated to the participating dealers during the onboarding for OBS and via the dealer usage agreement (“Händlernutzungsvereinbarung”) for OBS.

Lastly, the upload of all documents, especially of damage images and the odometer photo, is of course free of charge and independent of the package booked by the dealer or API user.

Set OBS attributes

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/data

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

ObsAttributes

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -H 'Accept: application/vnd.de.mobile.api+json' \
  -H 'Content-Type: application/vnd.de.mobile.api+json' \
  -X PUT 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/data' \
  -d '{
        "noDamagesOrExcessiveTracesOfUse": true,
        "vehicleCondition": "Fahrzeug ist in einem guten Zustand",
        "rentalOrCarSharing": true,
        "warrantyExpirationDate": "202306",
        "pickupEarliestDate": "2023-07-30T09:05:12.494Z",
        "optOutOfSellingThroughMobileDe": true,
        "pickupTires": "WINTER",
        "pickupContact": {
            "firstName": "Max",
            "lastName": "Mustermann",
            "role": "Operations",
            "email": "max.mustermann@maxmustermann.de",
            "phoneNumber": "1234556",
            "mobileNumber": "1234556"
        },
        "pickupAddress": {
            "companyName": "Autohaus Mustermann GmbH",
            "street": "Albert-Einstein Ring",
            "houseNumber": "1",
            "city": "Kleinmachnow",
            "zipCode": "14532",
            "note": "Bitte an der Rezeption melden"
        }
    }'
Request
PUT /seller-api/sellers/12/ads/217221/obs/data HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json

{
    "noDamagesOrExcessiveTracesOfUse": true,
    "vehicleCondition": "Fahrzeug ist in einem guten Zustand",
    "rentalOrCarSharing": true,
    "warrantyExpirationDate": "202306",
    "pickupEarliestDate": "2023-07-30T09:05:12.494Z",
    "optOutOfSellingThroughMobileDe": true,
    "pickupTires": "WINTER",
    "pickupContact": {
        "firstName": "Max",
        "lastName": "Mustermann",
        "role": "Operations",
        "email": "max.mustermann@maxmustermann.de",
        "phoneNumber": "1234556",
        "mobileNumber": "1234556"
    },
    "pickupAddress": {
        "companyName": "Autohaus Mustermann GmbH",
        "street": "Albert-Einstein Ring",
        "houseNumber": "1",
        "city": "Kleinmachnow",
        "zipCode": "14532",
        "note": "Bitte an der Rezeption melden"
    }
}
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

Get OBS attributes

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/data

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

ObsAttributes

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -H 'Accept: application/vnd.de.mobile.api+json' \
  -X GET 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/data'
Request
GET /seller-api/sellers/12/ads/217221/obs/data HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "noDamagesOrExcessiveTracesOfUse": true,
    "vehicleCondition": "Fahrzeug ist in einem guten Zustand",
    "rentalOrCarSharing": true,
    "warrantyExpirationDate": "202306",
    "pickupEarliestDate": "2023-07-30T09:05:12.494Z",
    "optOutOfSellingThroughMobileDe": true,
    "pickupTires": "WINTER",
    "pickupContact": {
        "firstName": "Max",
        "lastName": "Mustermann",
        "role": "Operations",
        "email": "max.mustermann@maxmustermann.de",
        "phoneNumber": "1234556",
        "mobileNumber": "1234556"
    },
    "pickupAddress": {
        "companyName": "Autohaus Mustermann GmbH",
        "street": "Albert-Einstein Ring",
        "houseNumber": "1",
        "city": "Kleinmachnow",
        "zipCode": "14532",
        "note": "Bitte an der Rezeption melden"
    }
}

Upload OBS documents

POST /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

The POST request returns a list of documents with URLs. These URLs need to be stored on the side of the transfer service provider or dealer to be able to reference documents for future requests. Please note that only the role DamageImages is able to store multiple documents. All other document types only allow one single document to be associated with an ad at a time.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.

role

Type of OBS document.
Data Types
Request Success Response Error Response

binary data

ObsDocuments

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

content-too-large

Indicates that one of the files exceeds the max size of 10MB.

400

unsupported-media-type

Indicates that one of the files has a media type which is not supported for the role.

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -H 'Accept: application/vnd.de.mobile.api+json' \
  -H 'Content-Type: multipart/form-data' \
  -X POST 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/media/DamageImages' \
  -F 'files=@car1.jpeg;type=image/jpeg' \
  -F 'files=@audi.jpeg;type=image/jpeg'
Request
POST /seller-api/sellers/12/ads/217221/obs/media/DamageImages HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Content-Type: multipart/form-data

<binary image data>
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "obsDocuments": [
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/38/38200674-6b3a-49ae-a882-53dda10e95a9"
        },
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/b6/b69f39f2-91cd-45bf-880f-b3da42810f14"
        }
    ]
}

List OBS documents

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.

role

Type of OBS document.
Data Types
Request Success Response Error Response

n/a

ObsDocuments

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -H 'Accept: application/vnd.de.mobile.api+json' \
  -X GET 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/media/DamageImages'
Request
GET /seller-api/sellers/12/ads/217221/obs/media/DamageImages HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "obsDocuments": [
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/38/38200674-6b3a-49ae-a882-53dda10e95a9",
            "description": "example description"
        },
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/b6/b69f39f2-91cd-45bf-880f-b3da42810f14",
            "description": "example description"
        }
    ]
}

Delete OBS documents

Note: It is only possible to delete all documents of a certain role. Therefore, if you would like to delete a single damage image (the only role that allows multiple files), you need to first delete all damage images and then reupload the intended images using the POST endpoint described above.

DELETE /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.

role

Type of OBS document.
Data Types
Request Success Response Error Response

n/a

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -X DELETE 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/media/DamageImages'
Request
DELETE /seller-api/sellers/12/ads/217221/obs/media/DamageImages HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 204 No Content

Add description to already uploaded OBS documents

To add a description to a damage image, make an additional PATCH call, as shown in the example below.

Note: This endpoint is only applicable to damage images.

PATCH /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/obs/media/:role

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

Unique identifier of the seller on the mobile.de platform.

role

Type of OBS document.
Data Types
Request Success Response Error Response

ObsDocuments

ObsDocuments

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

403

invalid-seller

Indicates that the given mobileSellerId is not prepared for OBS.
Curl
curl -u username:password \
  -H 'Accept: application/vnd.de.mobile.api+json' \
  -H 'Content-Type: application/vnd.de.mobile.api+json' \
  -X PATCH 'https://services.mobile.de/seller-api/sellers/12/ads/217221/obs/media/DamageImages'
  -d '{
    "obsDocuments": [
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/38/38200674-6b3a-49ae-a882-53dda10e95a9",
            "description": "new description"
        }
    ]
}'
Request
PATCH /seller-api/sellers/12/ads/217221/obs/media/DamageImages HTTP/1.1
Host: services.mobile.de
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json

{
    "obsDocuments": [
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/38/38200674-6b3a-49ae-a882-53dda10e95a9",
            "description": "new description"
        }
    ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.de.mobile.api+json

{
    "obsDocuments": [
        {
            "imageUrl": "img.classistatic.de/api/v1/mo-prod/images/38/38200674-6b3a-49ae-a882-53dda10e95a9",
            "description": "new description"
        }
    ]
}

Direct Offer

A Direct offer can be created for an ad, This direct offer will be shown to all perspective buyers who have parked your ad.

Constraints

The Direct offer request must follow the following constraints.

  • The offer text must not contain phone numbers or email addresses.

  • The offer text must contain only characters from Latin-1 (also known as ISO-8859-1) character set.

  • The offer text length must be between 3 and 1000 characters.

  • The validForDays value must be greater than or equal to 1 and lower than or equal to 14.

Expired offers

When an active offer reaches its expiration date (after the validUntil date), it will no longer be displayed to consumers. However, dealers can view the offer for an ad for up to 30 days after validUntilDate. The offer will be permanently deleted when the 30-day period is over.

Create or update direct offer

PUT /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/direct-offer

Create or update Direct Offer for the ad of a seller identified by mobileSellerId and mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

A unique identifier of the ad published on the mobile.de platform.
Data Types
Request Success Response Error Response

DirectOffer

n/a

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

400

offerText-missing

The request is missing a offer text.

400

validForDays-missing

The request is missing validForDays.

400

offerText-invalid

The offer text contains forbidden values such as email address and/or phone numbers or invalid characters.

400

offerText-length

The offer text length is not within the allowed limits, the allowed length is maximum 1000 and minimum 3 characters.

400

validForDays-invalid

The validForDays value is invalid, the allowed value must be greater than or equal to 1 and lower than or equal to 14.

400

no-parking

There are no parkings for the given ad.

403

customer-blocked

The customer is blocked from creating Direct offers by Customer Support.

403

customer-not-eligible

The customer’s package does not provide Direct offers functionality.

404

n/a

Indicates that the given Api User does not have permission to create direct offer for the ad or the ad doesn’t exist.
Sample Success Request
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1' -d '
{
  "offerText": "Here is 15% discount if you reach out in the next 7 days",
  "validForDays": 3
}
'

Please refer to the Authentication and Authorization section to learn how to authenticate the user.
Request
PUT https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1

{
  "offerText": "Here is 15% discount if you reach out in the next 7 days",
  "validForDays": 3
}
Response
HTTP/1.1 201 Created
Date: Thu, 04 Apr 2024 14:23:21 GMT
Content-Type: application/vnd.de.mobile.api+json
Location: http://localhost:40915/sellers/11/ads/13318/direct-offer
Content-Length: 0
Sample Bad Request - Forbidden Content
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1' -d '
{
  "offerText": "Here is my email email@email.com and phone number 0151234567",
  "validForDays": 3
}
'
Request
PUT https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1

{
  "offerText": "Here is my email email@email.com and phone number 0151234567",
  "validForDays": 3
}
Response
HTTP/1.1 400 Bad Request
Date: Thu, 04 Apr 2024 14:23:21 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 137

{
  "errors": [
    {
      "key": "offerText-invalid",
      "args": [
        {
          "key": "forbidden-content",
          "value": "phone"
        },
        {
          "key": "forbidden-content",
          "value": "email"
        }
      ]
    }
  ]
}
Sample Bad Request - Offer Validity
Curl
curl -X PUT 'https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer' \
     -H 'Accept: application/vnd.de.mobile.api+json' \
     -H 'Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1' -d '
{
  "offerText": "This is a test",
  "validForDays": 15
}
'
Request
PUT https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Content-Type: application/vnd.de.mobile.api+json; charset=ISO-8859-1

{
  "offerText": "This is a test",
  "validForDays": 15
}
Response
HTTP/1.1 400 Bad Request
Date: Thu, 04 Apr 2024 14:23:21 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 43

{
  "errors": [
    {
      "key": "validForDays-invalid"
    }
  ]
}

Get direct offer

GET /seller-api/sellers/:mobileSellerId/ads/:mobileAdId/direct-offer

Retrieve Direct Offer for the ad of a seller identified by mobileSellerId and mobileAdId path parameter.

Parameters
Parameter Explanation

mobileSellerId

Unique identifier of the seller on the mobile.de platform.

mobileAdId

A unique identifier of the ad published on the mobile.de platform.
Data Types
Request Success Response Error Response

n/a

DirectOfferResponse

ErrorResponse
Http/REST Specifics

Please refer to the Media Types and Status Codes sections for more details.

Non-standard Response Codes
Http Status Error code Explanation

404

n/a

Indicates that the direct offer for the given ad doesn’t exist.
Curl
curl -X GET 'https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer' \
     -H 'Accept: application/vnd.de.mobile.api+json'
Request
GET https://services.mobile.de/seller-api/sellers/11/ads/13318/direct-offer HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Response
HTTP/1.1 200 OK
Date: Thu, 04 Apr 2024 14:23:21 GMT
Content-Type: application/vnd.de.mobile.api+json
Content-Length: 158

{
  "offerText": "Here is 15% discount if you reach out in the next 7 days",
  "validUntil": "2024-04-07",
  "createdAt": "2023-06-13",
  "mobileAdId": 13318,
  "blocked": false
}

Data Format Reference

This section describes various aspects of the data exchanged through the api calls.

Data Types Reference

This section contains a detailed definition of the data consumed and produced by the apis. The data consists of a number of fields and each field is of certain type. A type could be a simple value such as String or Int or a complex type that groups logically other fields.

For Example

The data fragment below contains fields of types String, Int, Boolean and Price

{
  "make": "AUDI", (1)
  "cubicCapacity": 665, (2)
  "fullServiceHistory": true, (3)
  "price": { (4)
    "consumerPriceGross": "2000.00",
    "type": "FIXED",
    "currency": "EUR"
  }
  ...
} (5)
1 The make field is of type String
2 The cubicCapacity field is of type Int
3 The fullServiceHistory field is of type Boolean
4 The price field is of type Price which logically groups some other fields
5 The top level type for ad data is Ad - it specifies that e.g. make and price are valid field names on this level

The below sections contain explanation of all the fields and how they are grouped together into types.

Ad

Top level type for representing Ad data in the Seller-API.

Field Name Type Description

PLATFORM METADATA

mobileAdId

String

mobile-platform Ad ID

mobileSellerId

String

mobile-platform Seller ID

creationDate

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

modificationDate

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

VEHICLE

Key Fields

vehicleClass

String

The GENERAL classification of vehicles e.g. Car or Motorbike. See vehicle classes for possible values.

category

String

The DETAILED classification of vehicles e.g. Cabrio or Limousine. See categories for possible values.

make

String

Make of the vehicle e.g. Mercedes, Toyota. See makes for possible values.

model

String

Model of the vehicle e.g. X5, Prius. See models for possible values.

modelDescription

String

Detailed description of the model. Also used as ad title. Example Golf III always parked in garage. This field is restricted to a subset of UTF-8 characters.

condition

String

Is the vehicle new or used? See conditions for possible values.

usageType

String

Type of used car. See usage types for possible values.

firstRegistration

String

yyyyMM. See Date Time Representation for details.

mileage

Int

mileage in km

vin

String

The vehicle identification number (aka VIN or FIN). See http://en.wikipedia.org/wiki/Vehicle_Identification_Number. The field is case sensitive. Please send capital letters.

internalNumber

String

A reference key used by the seller. Also known as internal-number or internal-ID. If it is present, then it must be unique per seller. An empty string is treated same as if the element was not present. This field is restricted to a subset of UTF-8 characters.

Engine / Drive Train

cubicCapacity

Int

Cubic-capacity of the engine. Notation integer.

power

Int

Power of the vehicle. Notation in KW

gearbox

String

Stickshift, automatic? See gear boxes for possible values.

fuel

String

Type of fuel. See fuel for possible values.

axles

Int

Number of axles, integer. Information only for commercial vehicles

fourWheelDrive

Boolean

Four wheel drive

wheelFormula

String

The actuation of the vehicle. See wheel formulas for possible values.

hybridPlugin

Boolean

A plug-in hybrid electric vehicle (PHEV) is a hybrid electric vehicle that uses rechargeable batteries, or another energy storage device, that can be recharged by plugging it in to an external source of electric power. See Fuel And Energy Consumption Validation Rules.

chargingTime

Int

Charging time the car needs at a 11KW charging station (comparable to the charging power of a Wallbox installed at home). Notation in minutes, integer. The value must be in a range from 1 to 1439.

chargingTimeFast

Int

Charging time the car needs at a fast charging station with 50KW or more. Only the charging time up to 80% is relevant here. Notation in minutes, integer. The value must be in a range from 1 to 1439.

plugTypes

Collection of String

Set of supported plug types available at the vehicle. See plug types for possible values.

e10Enabled

Boolean

is the vehicle enabled for using E10 fuel

catalyticConverter

Boolean

Catalytic converter - motorcycles only

particulateFilterDiesel

Boolean

Particulate filter diesel

biodieselConversion

Boolean

Biodiesel conversion

biodieselSuitable

Boolean

Biodiesel suitable - Biodiesel suitable, only for diesel fuel - Biodiesel geeignet

vegetableoilfuelConversion

Boolean

Vegetableoilfuel conversion

vegetableoilfuelSuitable

Boolean

Vegetableoilfuel suitable - only cars and semi trailer trucks, only diesel fuel

performanceHandlingSystem

Boolean

Performance handling system - (Sportfahrwerk)

startStopSystem

Boolean

Start stop system

envkvCompliant

Boolean

Option to send vehicle with envkv values, see semantic rules if applicable Values can be send according to NEDC (New European Driving Cycle see validation rules) or according to WLTP (Worldwide harmonized Light Duty Test Procedure see here. As NEDC is still the legal driving cycle, provide these values if available.

envkvPetrolType

String

When you want to provide EnVKV compliant values, for fuel type petrol, you have to specify the exact petrol type, that the consumption values are based on. petrol types

wltpValues

WltpValues

Emission, range and consumption values according to WLTP (Worldwide harmonized Light Duty Test Procedure)

energyEfficiencyClass

String

the label for the applicable class of energy consumption according to NEDC, ranges between A+++, A++, A+, A, B, C, D, E, F or G

co2

Float

Indicates the amount of carbon dioxide emissions in grams per kilometer traveled according to NEDC.

consumptionInner

Float

Fuel consumption as measured in specific tests executed in city traffic situations according to NEDC. Number in l/100km (natural gas (CNG) in kg/100km, is ignored for electric vehicles)

consumptionOuter

Float

Fuel consumption as measured in specific tests executed in highway traffic situations according to NEDC. Number in l/100km (natural gas (CNG) in kg/100km, is ignored for electric vehicles)

consumptionCombined

Float

Fuel consumption as measured in specific tests executed in city and highway traffic situations according to NEDC. Number in l/100km (natural gas (CNG) in kg/100km, electric vehicles in kWh/100km)

consumptionPowerCombined

Float

according to NEDC See Fuel And Energy Consumption Validation Rules

consumptionUnit

String

The unit of the consumption values. This element is only readonly. For write usecases the unit is derived from the fuel type. fuel consumption units

emissionSticker

String

Emission sticker for German low emission zones (Feinstaubplakette für Umweltzone). See emission stickers for possible values.

emissionClass

String

EURO 1, 2, 3, 4, …​. See emission classes for possible values.

EBike Specific Fields

frameHeight

Int

Height of the frame. The value must be between (and including) 30 and 80. Notation in cm.

frameMaterial

String

Material of the frame. See frame materials for possible values.

frameShape

String

Shape of the frame. See frame shapes for possible values.

frameNumber

String

Frame number. Free text. Max 25 characters.

batteryPosition

String

The position of the battery. See battery positions for possible values.

batteryCapacityWh

Int

The capacity of the battery. The value must be between (and including) 250 and 1500. Notation in Wh.

batteryManufacturer

String

The manufacturer of the battery. See bike manufacturers for possible values.

wheelSize

String

The wheel size of the E-Bike. The input must correspond to one of the following values 20, 24, 26, 27.5, 28, 29. Notation in inch.

weight

Int

The total weight of the E-Bike. The value must be between (and including) 8 and 90. Notation in kg.

bikeGearType

String

Gear type of the E-Bike. See bike gear types for possible values.

numberOfGears

Int

The number of available gears. The value must be between (and including) 1 and 24.

motorPosition

String

The position of the motor. See motor positions for possible values.

bikeSuitableFor

String

Bike suitability. See bike suitability for possible values.

ebikeLeasing

EBikeLeasing

Indicates if the E-Bike is suitable for leasing. No additional details such as leasing company or rate are supported for the initial iteration

Exterior / Interior

exteriorColor

String

The mobile.de color name. This is a fixed set of colors. colors for possible values

manufacturerColorName

String

Free text field for color. This field is restricted to a subset of UTF-8 characters.

metallic

Boolean

Metallic

doors

String

Number of doors. See door counts for possible values.

seats

Int

number of seats. For categories Car, Bus, Truck up to 7,5t.

interiorColor

String

Information about the color of the interior of the vehicle. See interior colors for possible values.

interiorType

String

Information about the material used in the interior of the vehicle. See interior types for possible values.

Facts

generalInspection

String

yyyyMM. See Date Time Representation for details.

exhaustInspection

String

yyyyMM. See Date Time Representation for details.

newHuAu

Boolean

Buyer get’s a new HU/AU

constructionYear

Int

Format yyyy. Information only for commercial vehicles

constructionDate

String

The day when the vehicle was built. See Date Time Representation for details.

numberOfPreviousOwners

Int

Information about the number of previous owners of the vehicle

fullServiceHistory

Boolean

Full service history - (Scheckheftgeplfegt)

nonSmokerVehicle

Boolean

Nonsmoker vehicle

countryVersion

String

ISO-3166-1 alpha-2 code of the country for which the vehicle was built. See country versions for possible values. For newcars this field is mandatory.

damageUnrepaired

Boolean

See http://services.mobile.de/manual/damage.html

accidentDamaged

Boolean

See http://services.mobile.de/manual/damage.html (available only for cars)

roadworthy

Boolean

See http://services.mobile.de/manual/damage.html (available only for cars)

taxi

Boolean

Usable if the car is or was a taxi

Vehicle Details

abs

Boolean

Abs

airbag

String

Information about the airbags of the vehicle. See airbags for possible values.

airSuspension

Boolean

Air suspension

alloyWheels

Boolean

Alloy wheels

automaticRainSensor

Boolean

Rain sensor

auxiliaryHeating

Boolean

Auxiliary heating

awning

Boolean

An awning or overhang is a secondary covering attached to the exterior wall of a building.

bed

Boolean

Bed

bluetooth

Boolean

Bluetooth

box

Boolean

Box

bss

Boolean

Boom Suspension System

bunkBed

Boolean

Bunk bed

cabin

Boolean

Cabin

cdMultichanger

Boolean

CD multichanger

cdPlayer

Boolean

CD Player

centralLocking

Boolean

Central locking

centralLubricantApplication

Boolean

A system that delivers controlled amounts of lubricant to multiple locations on a machine while the machine is operating.

circularSeatingArrangement

Boolean

Circular seating arrangement

climatisation

String

Information on the climatisation of the vehicle. See climatisations for possible values.

coldstore

Boolean

Fridge

compressor

Boolean

Compressor

crane

Boolean

Crane

damageByHail

Boolean

Damage by hail

dimension

Dimension

The external dimension of the vehicle.

disabledAccessible

Boolean

Disabled accessible

disabledConversion

Boolean

Disabled conversion

discBrake

Boolean

Disc brake

divider

Boolean

Divider

driversSleepingCompartment

Boolean

Drivers sleeping compartment

drivingCab

String

Information about the cab of the truck. See driving cabs for possible values.

drivingMode

String

Does the motorbike have a chain or something else? See driving modes for possible values.

ebs

Boolean

Electronic Braking System

electricAdjustableSeats

Boolean

Electric adjustable seats

electricExteriorMirrors

Boolean

Electric mirrors

electricHeatedSeats

Boolean

Electric heated seats

electricStarter

Boolean

Electric starter

electricWindows

Boolean

Electric windows

esp

Boolean

Esp

europalletStorageSpaces

Int

Information about how many europallets suit in the vehicle.

frontFogLights

Boolean

Front fog lights

frontHydraulics

Boolean

Front hydraulics

frontJack

Boolean

Front Jack for Accessoires

fullFairing

Boolean

Full fairing increases effiency

handsFreePhoneSystem

Boolean

Hands free phone system

headUpDisplay

Boolean

Headup display

hydraulicInstallation

String

Indicates the type of hydraulic installation. See hydraulic installations for possible values.

immobilizer

Boolean

Immobilizer

installationHeight

Int

Notation in mm, integer. Information only for commercial vehicles

isofix

Boolean

ISOFIX is the international standard for attachment points for child safety seats in passenger cars

kickstarter

Boolean

Kickstarter - motorcycles only

kitchen

Boolean

Kitchen

licensedWeight

Int

Notation in kg, integer. Information only for commercial vehicles.

liftingCapacity

Int

Notation in kg, integer. Information only for commercial vehicles

liftingHeight

Int

Notation in mm, integer. Information only for commercial vehicles

lightSensor

Boolean

Light sensor

loadCapacity

Int

Notation in kg, integer. Information only for commercial vehicles

loadingSpace

Dimension

The loading space dimensions.

middleSeatingArrangement

Boolean

Middle seating arrangement

multifunctionalWheel

Boolean

Multifunctional wheel

municipal

Boolean

Municipal

navigationSystem

Boolean

Is the car having a build in navigation system. Not be be set for portable navigation systems

numberOfBunks

Int

The number of bunks. Only for Motorhome.

onBoardComputer

Boolean

On board computer

operatingHours

Int

Notation integer. Information only for commercial vehicles

panoramicGlassRoof

Boolean

Panoramic glass roof

parkingAssistants

Collection of String

Information about the parking assistants of the vehicle. parking assistants for possible values.

speedControl

String

Information about the speed control of the vehicle. See speed controls for possible values.

radio

Collection of String

Information about the radio of the vehicle. See radios for possible values.

daytimeRunningLamps

String

Information about the type of daytime running lamps of the vehicle. See [daytimeRunningLamps_refdata. daytime running lamps] for possible values.

slidingDoorType

String

Information about the type of sliding door of the vehicle. See sliding door types for possible values.

headlightType

String

Information about the headlight types of the vehicle. See headlight types for possible values.

bendingLightsType

String

Information about the type of cornering/bending lights of the vehicle. See bending lights types for possible values.

breakdownService

String

Information about the type of breakdown service kit of the vehicle. See breakdown services for possible values.

battery

String

Information about the battery of the electric vehicle. See batteries for possible values.

trailerCouplingType

String

Information about the trailer coupling type of the vehicle. See trailer coupling types for possible values.

trimLine

String

Information about the trim line a.k.a feature sets (Ausstattungslinie) of the vehicle. See trimlines.

modelRange

String

Information about the model range a.k.a. Baureihe of the vehicle. See modelranges.

firstModelsProductionDate

String

yyyyMM. See Date Time Representation for details.

batteryCapacity

Int

Battery capacity of the vehicle. Notation in kWh, integer

powerAssistedSteering

Boolean

Power assisted steering

protectionRoof

Boolean

Protection roof

quickChangeAttachment

Boolean

Quick change attachment

rearGarage

Boolean

Rear garage

retarder

Boolean

Used if the vehicle has an retader or intarder

roadLicence

Boolean

Road licence

rollOverBar

Boolean

Roll over bar

roofRails

Boolean

Roofrails

secondaryAirConditioning

Boolean

Secondary air conditioning - (Standklimaanlage)

sepShower

Boolean

Seperate Shower

shippingVolume

Int

The loading space volume. Notation in cubic meter

sideSeatingArrangement

Boolean

Side seating arrangement

skiBag

Boolean

Ski bag

sleepSeats

Boolean

Sleep seats

solarEnergySystem

Boolean

Solar energy system

sportPackage

Boolean

Sport package

sportSeats

Boolean

Sport seats

sunroof

Boolean

Sunroof

superSingleWheels

Boolean

Super single wheels

tailLift

Boolean

Tail lift

tractionControlSystem

Boolean

Traction control system

tv

Boolean

Tv

ureaTankAdBlue

Boolean

Urea tank ad blue

wc

Boolean

Toilet

windshield

Boolean

Windshield

alarmSystem

Boolean

The vehicle makes itself heard / seen, if someone tries to break into the car

armRest

Boolean

Arm rest between driver and front passenger seat

heatedWindshield

Boolean

Windshield has heating elements integrated (dedicated blowers to heat windshield are not to be considered as heated windshield)

heatedSteeringWheel

Boolean

Steering wheel can be heated

hillStartAssist

Boolean

Could be Hill Holder, Hill Hold Control or Hill Start Assist as well. A system to automatically support the driver when starting up from a stop on an up or down gradient

electricTailgate

Boolean

tailgate is able to be operated electrically, either from the driver position, with a button on the tailgate or from a key fob as some examples

leatherSteeringWheel

Boolean

Steering wheel is covered with leather

lumbarSupport

Boolean

Mechanism within at least the drivers seat which supports the back of a person during longer drives

massageSeats

Boolean

At least driver seat has an active massage functionality

fatigueWarningSystem

Boolean

Vehicle warns driver if they get tired

nightVisionAssist

Boolean

The vehicle supports the driver while driving at night. It might show heat signatures of larger living things and might warn the driver if there could be a collision possibility

emergencyCallSystem

Boolean

Vehicle is able to initiate (automatically) an emergency call if in an accident

tirePressureMonitoring

Boolean

Tire pressure is (constantly) measured and reported by the vehicle

paddleShifters

Boolean

It is possible to change gears with paddles at the steering wheel

electricHeatedRearSeats

Boolean

Rear passenger seats can be heated

soundSystem

Boolean

Vehicle has a better sound system compared to the standard audio system of this model

voiceControl

Boolean

Certain aspects of a car (usually hands free phone system) can be controlled by voice

touchscreen

Boolean

Certain aspects of the car, usually the entertainment system, have a touch screen interface

usb

Boolean

The vehicle has a USB port in the passenger area, usually for connecting a media player or smart phone to the entertainment system or for charging devices

trafficSignRecognition

Boolean

Vehicle is able to recognize traffic signs and show the recognized signs to the driver

highBeamAssist

Boolean

Vehicle recognizes oncoming traffic and switches between high and low beam

summerTires

Boolean

Vehicle does include summer tires. This does not have to include rims

winterTires

Boolean

Vehicle does include winter tires. This does not have to include rims

allSeasonTires

Boolean

Vehicle does include all season tires. This does not have to include rims

steelWheels

Boolean

Vehicle does include steel rims. The vehicle might include steel and alloy rims, together with summer and winter tires, this would be a complete 8 tire set

glareFreeHighBeam

Boolean

High beam is able to mask oncoming traffic automatically. This is not to be mistaken for high beam assist.

headlightWasherSystem

Boolean

system to clean main front headlights

winterPackage

Boolean

Package usually named with any manufacturer winter package

smokersPackage

Boolean

Package usually named with any manufacturer smoker´s package. Might include things like ashtrays or cigarette lighters

distanceWarningSystem

Boolean

Vehicle tries to prevent a collision with other vehicles or objects by warning the driver

electricBackseatAdjustment

Boolean

Back Passanger Seats are electrically adjustable

ambientLighting

Boolean

(various) parts of the vehicle interior can be lighted with soft lights during driving. Color of those lights might be able to be changed

wifiHotspot

Boolean

Vehicle has an integrated WiFi Hotspot and probable Internet connection to allow passengers to use WiFi devices

carplay

Boolean

Vehicles entertainment system supports Apples CarPlay system. This allows an iPhone to take over the user interface of the entertainment systems (in part)

androidAuto

Boolean

Vehicles entertainment system supports Android Auto system. This allows an Android Phone to take over the user interface of the entertainment systems (in part)

digitalCockpit

Boolean

There are no dedicated, single purpose instruments behind the steering wheel. The whole area is a screen and can be adjusted to the drivers requirements.

passengerSeatIsofixPoint

Boolean

Front passager seat has Isofix connection points for anchoring a child seat

wirelessCharging

Boolean

Vehicle has the capability to inductively charge a smartphone for example via the Qi standard

integratedMusicStreaming

Boolean

Vehicle has a streaming service client (e.g. Spotify client) integrated to play music via this streaming service without a smart phone being present

dimmingInteriorMirror

Boolean

Interior monitor dims automatically if it senses to much light coming from following vehicles

foldFlatPassengerSeat

Boolean

Front passager seat is completely foldable allowing for transporting longer items

cargoBarrier

Boolean

It is possible to have a stable barrier between the cargo area / trunk and passenger area, e.g. with a net

speedLimiter

Boolean

The vehicle provides the possibility to set a speed limit, the driver usually is able to override this speed limit for example by pressing the gas pedal harder

rangeExtender

Boolean

Electric vehicle has a petrol support motor charging the battery if it is empty. Main engine(s) are driven with electrical power

collisionAvoidance

Boolean

Vehicle tries to prevent a collision with other vehicles or objects by warning the driver and enforcing an emergency break or supporting the breaking effort of the driver

keylessEntry

Boolean

Vehicle doors can be opened without a key. This could be done with pressing a button on a key fob or automatically by proximity

ventilatedSeats

Boolean

At least driver seat is ventilated

laneDepartureWarning

Boolean

Vehicle tries to either actively (vehicle steers itself) or passively (warns driver if lane is left) to keep itself in a lane

blindSpotMonitor

Boolean

Vehicle warns the driver, if there are objects in the blind spots of the car

Description / Images / Video

description

String

Free text description of the vehicle. Please be aware of special characters when sending formatted texts. More details via https://services.mobile.de/docs/seller-api.html#_special_characters_in_payload.

images

Collection of Image

List of images

videoUrl

String

Youtube url in youtube.com/xxx format

highlights

Collection of String

Short notes highlighting key features of the vehicle The number of allowed highlights could be inspected via https://services.mobile.de/docs/seller-api.html#_retrieve_a_single_seller. This field is restricted to a subset of UTF-8 characters and has a max length of 22 characters.

Catalog Data

kba

Kba

Germany only, Classification of makes and models, given by Kraftfahrtbundesamt (KBA)

schwackeCode

Int

Classification of makes and models given by Eurotax/Schwacke

OFFER

deliveryDate

String

Date when the vehicle is ready to be delivered to the customer, e.g. 2015-06-12. See Date Time Representation for details.

deliveryPeriod

Int

Time-span in days until the vehicle is ready to be delivered. Allowed Values: 1, 2, 3, 4, 5, 6, 7, 14, 42, 60, 90, 120, 150, 180, 270 and 360

usedCarSeal

String

Information and restrictions about Used-Car-Seals can be found here. Not visible to all users. See used car seals for possible values.

dealerHomepage

Boolean

Visible as featured item on the dealers homepage ("Unsere Empfehlung")

closedDomain

Boolean

Visible only in closed domain not in public domain

export

Boolean

No private Selling offer, only for commercial or export

warranty

Boolean

Vehicle is sold including additional warranty on top of the statutory warranty that is mandatory when selling to private persons.

rentingPossible

Boolean

Renting possible

price

Price

Price information. Check details of the Price type for more information.

financing

Financing

Financing offer information. Check details of the Financing type for more information.

SELLER-API FIELDS

renewalDate

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

adQuality

AdQuality

When an Ad is blocked or deleted due to the terms violations, this element provides more details about the reason

reserved

Boolean

Visible only for owner

uploadSticky

Boolean

Indicates that an ad can only be changed within dealer area. Modifications via Seller-API will be rejected.

bookedAdFeatures

Collection of AdFeature

DEPRECATED - please use bookableFeatures

bookableFeatures

BookableFeatures

information about booked features - e.g. top of page or page one ad

individualContactId

String

The id of a individual contact. If the related contact doesn’t exists for this seller it will be ignored.

nationalDelivery

DeliveryOption

National Delivery is a feature that allows dealers to show a listing up to Germany wide if they are able to deliver it in a certain radius - see https://promo.mobile.de/b2b/en/product/national-delivery/

multiLocations

Collection of MultiLocation

Set of multi-locations

Ads

Container type for providing a list of ads.

Field Name Type Description

ads

Collection of Ad

List of ads

AdQuality

Field Name Type Description

status

AdQualityStatus

Results of the quality checks - see AdQualityStatus type for more details

reason

String

Explanation why the ad has been blocked or removed by quality team.

secondReason

String

More details.

BookableFeatures

Represents a set of bookable features for given ad.

Field Name Type Description

pageOneAd

BookableFeature

With the Page-1-Ad, your ad will be listed on the first page of search results when your vehicle matches a potential buyer’s search criteria (flagged as a ‘sponsored ad’). If there are more than three Page-1-Ads that fit the search, the ads presented are selected at random from all the ads ordered.

eyeCatcher

BookableFeature

With the Eyecatcher, the search results show your ads enlarged and with colour highlighting and a clearer structure that helps them to stand out.

financing

BookableFeature

You can add Financing proposals to your ads (commercial vehicles excluded). When you order a Financing proposal, your ad appears in detail on the Detailed Item Page and is flagged on the search results pages.

topOfPage

BookableFeature

The Top Ad places your vehicle in the top slot of the search results pages, under the condition that your vehicle matches the potential buyer’s search criteria. If more than three Top Ads match a search query, the top displayed ad is selected at random from all the matching booked Top Ads.

redPencil

BookableFeature

Bookable feature indicating that the price of a vehicle was reduced, showing the old price and the new price.

ebaykExport

BookableFeature

DEPRECATED - Please use "kleinanzeigenExport".

kleinanzeigenExport

BookableFeature

Bookable feature indicating that this ad should be exported to Kleinanzeigen. Vehicle must be a car and must have a milage above 1500km.

adTurbo

BookableFeature

See changelog for more details https://services.mobile.de/manual/changelog.html#2018-01-19

BookableFeature

Represents a bookable feature such as top of page

Field Name Type Description

active

Boolean

indicates whether given feature is currently booked (read calls) or should be booked (write calls)

blocked

Boolean

when true the feature status cannot be changed in the write calls - see the reason field for more details

reason

FeatureBlockReason

explanation why the status of the feature cannot be changed at the moment

Statistic

Demand statistics for an Ad.

Field Name Type Description

impressions

Long

The number of page views for this ad.

parkings

Long

How often this ad was parked on the mobile.de site.

emails

Long

The number of emails sent to the seller of the ad.

prints

Long

How often this ad was printed.

calls

Long

How often the seller of the ad was called by phone for this ad.

DeliveryOption

Indicates that the dealer can deliver the vehicle to a customer. It’s not available for all dealers. Information about permission is available in seller resource

Field Name Type Description

radius

Long

the maximum delivery distance in km. If it is not set, the delivery is throughout Germany.

period

Int

the estimated time of the delivery in days (required).

fee

Int

the fee of the delivery in € (without cents)

additionalInformation

String

additional details of the delivery can be added here (max. 250 characters)

MultiLocation

Details about the multi-location

Field Name Type Description

id

String

id of a multi-location

name

String

name of multi-location

deliveryOption

DeliveryOption

delivery option of multi-location

location

Location

location of multi-location

WarningResponse

Provides feedback for calls that were partially successful.

Field Name Type Description

warnings

Collection of Warning

List of warnings. For example a list of rejected changes.

Warning

Describes an api warning.

Field Name Type Description

key

String

Indicates a type of problem - e.g. missing required field or invalid field value

message

String

Human readable error description

args

Collection of Arg

List of key-value pairs detailing the failure

Seller

Field Name Type Description

mobileSellerId

String

mobile-platform Seller ID

customerNumber

String

Seller / customer number that is publically exposed - appears e.g. on the customer invoice

type

SellerType

Commercial or private seller

siteId

String

Identifier of international marketplace - e.g. GERMANY for mobile.de

nameInvisible

Boolean

When set to 'true' the customers name won’t be displayed in its ads.

phoneNumberInvisible

Boolean

When set to 'true' the customers phone number won’t be shown in its ads.

commercial

Boolean

Commercial or non-profit seller

readonly

Boolean

Indicates the user can change ads for given seller or has readonly access

settings

SellerSettings

More settings - check the SellerSettings for more details

companyName

String

Legal name for commercial sellers

salutation

Salutation

Contact details

firstName

String

First name of a private seller

lastName

String

Last name of a private seller

email

String

Contact email

homepage

String

Url to the seller home page

street

String

Address

houseNumber

String

Address

zipcode

String

Address

city

String

Address

countryCode

String

Address - notation http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

coordinates

Coordinates

Geolocation of the seller

phones

Phones

Contact phone numbers

mobileSellerSince

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

billingForecast

BillingForecast

The billing forecast for recent month.

pictureProvider

PictureProvider

Indicates if seller has a picture provider.

Sellers

Container type for providing a list of sellers.

Field Name Type Description

sellers

Collection of Seller

List of sellers

FeatureSettings

Field Name Type Description

bookingAssistant

BookingAssistantFeatures

A list of features, which are booked by Booking Buddy.

costControl

CostControlFeatures

A list of features, which are blocked by Cost Control.

BookingAssistantFeatures

Container type for providing information about Booking Buddy feature settings.

Field Name Type Description

topOfPage

BookingAssistantFeature

Indicates that some ads has Top of Page booked by Booking Buddy.

pageOneAd

BookingAssistantFeature

Indicates that some ads has Page One Ad booked by Booking Buddy.

eyeCatcher

BookingAssistantFeature

Indicates that some ads has Eye Catcher booked by Booking Buddy.

BookingAssistantFeature

Field Name Type Description

mobileAdIds

Collection of String

Provides a list with ad ids where the feature is active.

CostControlFeature

Empty object.

Field Name Type Description

CostControlFeatures

Container type for providing information about Cost Control feature settings.

Field Name Type Description

topOfPage

CostControlFeature

pageOneAd

CostControlFeature

eyeCatcher

CostControlFeature

IndividualContact

Individual contact data that can be assigned to an ad. Contacts can be managed by the dealer in dealer area

Field Name Type Description

individualContactId

String

The reference you need to assign a contact to an ad

firstName

String

First name of the contact

lastName

String

Last name of the contact

email

String

Contact email

jobTitle

String

job title of the contact person

imageUrl

String

URL of an image of the contactPerson

phone

Phone

phone number of the contact

Location

Details about the location

Field Name Type Description

street

String

street of location

houseNumber

String

houseNumber of location

zip

String

zip code of location

city

String

city of location

country

String

country of location

SellerSettings

Field Name Type Description

maxImages

Int

The maximum number of images the seller is allowed to upload for an ad.

maxHighlights

Int

The maximum number of highlights the seller is allowed to upload for an ad.

usedCarSeals

Collection of String

The used car seals the seller can use.

automatedExports

Collection of AutomatedExport

The settings for automated exports of advertisements to other marketplaces.

videoUrl

Boolean

The permission to upload a video url.

maxIndividualContacts

Int

The maximum number of individual contacts that the seller can have.

maxMultiLocations

Int

The maximum number of multi-locations that the seller can have.

nationalDelivery

Boolean

The permission to upload a delivery option.

dealerRating

DealerRatingSettings

Settings for dealer rating API

directOffer

DirectOfferSettings

Settings for Direct Offers

DealerRatingSettings

Field Name Type Description

eligible

Boolean

Dealer has the correct account type and is eligible for dealer rating management via rating API

active

Boolean

Dealer has activated dealer rating management via TSP.

personalizedInviteText

Boolean

Personalized invite Text can be set for dealer rating invitation emails.

DirectOfferSettings

Field Name Type Description

eligible

Boolean

Is Account Type eligible for Direct Offers

blocked

Boolean

Is the Account blocked from creating Direct Offers by Customer Support

Phones

Field Name Type Description

fixed

Phone

Primary landline number

fixed2

Phone

Secondary landline number

fax

Phone

Fax number

cell

Phone

Mobile phone number

Phone

Represents a sellers settings corresponding to their account type.

Field Name Type Description

countryCallingCode

String

County code

areaCode

String

Area code

number

String

Phone number

Coordinates

Field Name Type Description

lat

Float

Latitude - decimal representation

lon

Float

Longitude - decimal representation

AutomatedExport

Field Name Type Description

marketplace

String

Name of the marketplace

eligible

Boolean

Is the seller eligible to export to this parket place?

active

Boolean

Is the seller currently configured to export to this parket place?

PictureProvider

Field Name Type Description

autopanorama

Boolean

Indicates that the seller has a picture provider for autopanorama.

images

Boolean

Indicates that the seller has a picture provider for vehicle images.

BillingForecast

Field Name Type Description

billingPeriod

String

The billing period of the following items. e.g. 2016-12. In most cases this is the actual month but on the first day of a month it is the month before.

calculationDate

String

Calculation date of the values. Always EOD. In most cases it is the day before the actual date. e.g. 2016-12-23 EOD, when the request was on 2016-12-24.

invoiceLanguage

String

The language of the invoice the customer gets.

currency

String

Currency of the invoice.

invoiceItems

Collection of InvoiceItem

A collection of items that will be on the customer invoice. Limited to items with the following descriptors: VEHICLE_COUNT, VEHICLE_INSERTION, TOP_IN_CATEGORY, TOP_OF_PAGE, KLEINANZEIGEN, EYECATCHER

freeContingents

Collection of FreeContingent

A collection of free contigents summed by descriptor. Limited to items with the following descriptors: VEHICLE_COUNT, VEHICLE_INSERTION, TOP_IN_CATEGORY, TOP_OF_PAGE, KLEINANZEIGEN, EYECATCHER

specialConditions

Collection of SpecialCondition

A collection of special conditions. Limited to items with the following descriptors: VEHICLE_COUNT, VEHICLE_INSERTION, TOP_IN_CATEGORY, TOP_OF_PAGE, KLEINANZEIGEN, EYECATCHER

InvoiceItem

Field Name Type Description

descriptor

String

Unique Descriptor of an invoice item.

accountType

String

Account type of the invoice item (STANDARD, COMFORT. PREMIUM)

fromDate

String

Start date of the invoice item, e.g. 2017-03-01.

toDate

String

End date of the invoice item, e.g. 2017-03-01.

unitPrice

String

Price of one unit of an invoice item.

totalPrice

String

Total price over all units of an invoice item (netto),

articleCount

String

For VEHICLE_COUNT this is the average number of ads. For other items this is a number of counted active items.

quantityAmount

String

For VEHICLE_COUNT this is the number of days used to calculate the average. For other items please use field articleCount.

quantityUnit

String

Unit is DAY for VEHICLE_COUNT or ITEM for other entries.

FreeContingent

Field Name Type Description

descriptor

String

Unique Descriptor of an contingent item.

description

String

A more detailed description of the item.

available

String

Free contingent left summed up by descriptor and counted EOD of calculationDate.

contingentUnlimited

Boolean

Indicates if this is an unlimited contingent. In most cases it is not.

SpecialCondition

Field Name Type Description

descriptor

String

Unique Descriptor of a special condition item.

accountType

String

Account type of the SpecialCondition item (STANDARD, COMFORT. PREMIUM)

description

String

A more detailed description of the item.

freeLeft

String

How much free contigent is left of the specific item. -1 means unlimited.

freePerMonth

String

How much free contigent is left within this month of the specific item. -1 means unlimited.

fromDate

String

Start date of the special condition.

toDate

String

How long the special condition is active/available.

totalUsed

String

Indicates the total usage over the complete period.

unlimited

Boolean

Indicates if this special condition is unlimited.

usedWithinMonth

String

Indicates the usage within the actual billing period.

Financing

Field Name Type Description

annualPercentageRate

String

Percentage. AKA rate-per-cent (seller-ad-1.1.xsd), effektiver Jahreszins (German). Must be between 0 and 19.99 and can only have two digits after comma.

nominalInterestRate

String

Percentage. AKA nominal-interest-rate (seller-ad-1.1.xsd), Sollzinssatz (German).

typeOfNominalInterestRate

String

AKA type-of-nominal-interest-rate (seller-ad-1.1.xsd), Art des Sollzinssatzes (German). nominal interest rate types

firstInstallment

Int

A nonrecurring payment at the beginning of the payback period. Currency is the same as the vehicle price. AKA Anzahlung (German).

monthlyInstallment

Int

The monthly recurring payment. Currency is the same as the vehicle price. AKA monthly-rate (seller-ad-1.1.xsd), monatliche Rate (German).

finalInstallment

Int

A nonrecurring payment at the end of the payback period. Currency is the same as the vehicle price. AKA ending-rate (seller-ad-1.1.xsd), Schlussrate (German).

paybackPeriod

String

Duration in months. AKA period (seller-ad-1.1.xsd), Laufzeit in Monaten (German). payback periods

netLoanAmount

String

Currency is the same as the vehicle price. AKA net-credit-amount (seller-ad-1.1.xsd), Nettokreditbetrag (German).

grossLoanAmount

String

Currency is the same as the vehicle price. AKA gross-credit-amount (seller-ad-1.1.xsd), Bruttokreditbetrag (German).

closingCosts

String

A fee for placing the loan contract. Currency is the same as the vehicle price. AKA Abschlussgebühren (German).

paymentProtectionInsurance

String

Costs of such insurance. Currency is the same as the vehicle price. AKA rate-insurance (seller-ad-1.1.xsd), Ratenabsicherung (EUR) (German).

bank

String

Description of the bank. AKA Anbieterbank (German) max. 150 characters.

conditions

String

Description of further conditions. max. 60 characters.

Price

The currency fields are represented as String using the . as decimal separator with two digits precision. The fields should be parsed using arbitrary rounding strategy.

Field Name Type Description

dealerPriceGross

String

Price of the vehicle for other dealers including VAT if reclaimable. Only visible in dealer area.

consumerPriceGross

String

Price of the vehicle for private buyers including VAT if reclaimable. This is the main price shown.

dealerPriceNet

String

Net price of the vehicle for other dealers. Can only be used when providing a VAT rate as gross price is calculated then. Only visible in dealer area.

consumerPriceNet

String

Net price of the vehicle for private buyers. Can only be used when providing a VAT rate as gross price is calculated then. price type explanation of values price types

vatRate

String

The VAT rate as percent number (a number between 0 and 100). For example 19. When you add this attribute then your vehicle is displayed as VAT deductible. See vat rates

type

String

For AgricultureVehicle, Bus, ConstructionMachine, ForkliftTruck, SemiTrailer, SemiTrailerTruck, Trailer, TruckOver7500, VanUpTo7500 it is possible to set price type ON_REQUEST. In that case price element must only contain the price type. The following price types are possible price types. FIXED is the default value.

currency

String

Information in which currency the price is stated. During upload this field is ignored and the currency taken from the sellers site-ID instead.

Image

Field Name Type Description

ref

String

hash

String

MD5 checksum of the original uploaded customer image

Images

Field Name Type Description

images

Collection of Image

List of images

Dimension

Field Name Type Description

length

Int

Length. Notation in mm

width

Int

Width. Notation in mm

height

Int

Height. Notation in mm

Kba

Field Name Type Description

hsn

String

Germany only, Herstellerschlüsselnummer

tsn

String

Germany only, Typschlüsselnummer

WltpValues

AVAILABLE AS OF 2022/01/05 Emission, range and consumption values according to WLTP (Worldwide harmonized Light Duty Test Procedure).

Field Name Type Description

consumptionFuelCombined

Float

Combined fuel consumption for all nonelectric vehicles, optional for plugin hybrids, number in l/100km (natural gas (CNG) in kg/100km)

co2EmissionCombined

Float

Amount of carbon dioxide emissions in g/km for all vehicles, optional for plugin hybrids.

consumptionPowerCombined

Float

Combined power consumption for electric vehicles in in kWh/100km

electricRange

Int

Electric Range for plugin hybrids and electric vehicles in km

consumptionFuelCombinedWeighted

Float

Weighted combined fuel consumption for plugin hybrids

consumptionPowerCombinedWeighted

Float

Weighted combined power consumption for plugin hybrids in kWh/100km

co2EmissionCombinedWeighted

Float

Weighted amount of carbon dioxide emissions in g/km for plugin hybrids

EBikeLeasing

Indicates if the E-Bike is suitable for leasing.

Field Name Type Description

active

Boolean

Indicates that the E-Bike is suitable for leasing when set to 'true'

AutoPanoramaImage

Uploaded image that will be used to create an exterior or interior Auto-Panorama.

Field Name Type Description

ref

String

reference of the image

AutoPanoramaInterior

Request to create an interior Auto-Panorama.

Field Name Type Description

image

AutoPanoramaImage

AutoPanoramaExterior

Request to create an exterior Auto-Panorama.

Field Name Type Description

images

Collection of AutoPanoramaImage

List of images in correct order to create the exterior Auto-Panorama.

PriceRating

Price rating information for an Ad.

Field Name Type Description

label

String

Price rating label for this ad. See https://services.mobile.de/docs/seller-api.html#priceRating_refdata for possible values.
Labels have following meanings:
VERY_GOOD_PRICE: Price is significantly below the price of similar vehicles. mobile.de recommends checking the ad description for additional notes or defects.
GOOD_PRICE: Price is below the current market price.
REASONABLE_PRICE: Price approximately corresponds to the current market price.
INCREASED_PRICE: Price is above the current market price.
HIGH_PRICE: Price is significantly above the price of similar vehicles. The vehicle likely has special features.
NO_RATING: A realistic rating for the ad is not possible.

labelRanges

Collection of PriceRatingLabelRange

reasons

Collection of String

PriceRatingLabelRange

Price range for a given price rating label.

Field Name Type Description

label

String

from

String

to

String

RatingOverview

Type for representing a summarized information about dealer rating.

Field Name Type Description

score

Float

Total rating score. Number of stars (5.0 is the best).

totalActiveRatings

Int

Total number of ratings in the last 24 months.

advice

Float

How good was the dealer advice (consulting). Number of stars (5.0 is the best).

friendliness

Float

How friendly was the dealer. Number of stars (5.0 is the best).

responseTime

Float

How quickly the dealer responded with an answer. Number of stars (5.0 is the best).

recommendation

Int

What percentage of the users would recommend the dealer.

vehicleAsDescribed

Int

What percentage of the users found the vehicle as described in the listing.

Ratings

Field Name Type Description

ratings

Collection of Rating

List of ratings for a given dealer.

Rating

Describes the experience of contacting the dealer. Collected by completing a rating survey by the potential buyer.

Field Name Type Description

ratingId

String

Identifies a single rating.

completionTime

String

When the rating was completed by a user. See Date Time Representation for details about date representation.

advice

Float

How good was the dealer advice (consulting).

friendliness

Float

How friendly was the dealer.

responseTime

Float

How quickly the dealer responded with an answer.

recommendation

RatingYesNoAnswer

This user recommends the dealer.

vehicleAsDescribed

RatingYesNoAnswer

Was the vehicle as described.

boughtTheCar

BoughtTheCarAnswer

Did the user buy the car.

dealerContactedBy

RatingDealerContactedBy

How this user contacted the dealer.

likeAboutDealer

String

Summary what the user liked about the dealer

notLikeAboutDealer

String

Summary what the user did not like about the dealer

ratingWasHelpfulResponses

Int

How many other users liked this rating or found it helpful.

ratingAuthor

RatingPerson

Who submitted this rating.

dealerContactPerson

RatingPerson

Dealer representative who was contacted.

ad

RatingAd

Summary of the vehicle the dealer was contacted about.

reply

RatingReply

Dealer reply on rating.

RatingPerson

Field Name Type Description

salutation

String

Name of the person.

name

String

Name of the person.

RatingDealerContactedBy

Field Name Type Description

phone

Boolean

Dealer was contacted by phone.

email

Boolean

Dealer was contacted by e-mail.

personally

Boolean

Dealer was contacted by personally in their shop.

RatingAd

Field Name Type Description

title

String

Headline of the ad - make, model etc.

price

String

Consumer price

firstRegistration

String

yyyyMM. See Date Time Representation for details.

mileage

Int

Mileage in km

power

String

Power of the vehicle in KW

gearbox

String

See gear boxes for possible values.

exteriorColor

String

The mobile.de color name. This is a fixed set of colors. colors for possible values.

internalNumber

String

A reference key used by the dealer.

RatingReply

Field Name Type Description

comment

String

Reply on a rating with a maximum of 1000 characters. New lines can be defined with '\n'.

EmailInvites

Container type for providing a list of invites.

Field Name Type Description

invites

Collection of EmailInvite

List of invites.

EmailInvite

Field Name Type Description

mobileAdId

String

mobile-platform Ad ID.

title

String

Headline of the ad - make, model etc.

internalNumber

String

A reference key used by the dealer.

price

String

Consumer price

firstRegistration

String

yyyyMM. See Date Time Representation for details.

mileage

Int

Mileage in km

deletionTime

String

When the mobile ad was deleted. See Date Time Representation for details about date representation.

buyerEmail

String

Email address of the buyer, who is requested for rating.

personalizedInviteText

String

Personalized email invite text. The maximum length is 3000 characters. New lines can be defined with '\n'.

invitationTime

String

When the rating invitation was sent to the buyer. See Date Time Representation for details about date representation.

reinviteable

Boolean

Indicates whether the invitation could be resent.

state

InviteState

State of the pending email invitation.

Leasing

Field Name Type Description

grossListPrice

Int

This is the gross price (German Listenpreis) of the vehicle including VAT.

vatRate

String

The VAT rate as percent number. Only the current German VAT rate is supported. See https://services.mobile.de/refdata/sites/GERMANY/vatrates for valid VAT rate. (Required)

lender

String

Name of the lender / leasing bank. (Required)

rates

Collection of LeasingRate

List of leasing rates. At least one rate is required, either commercial or private.

comment

String

Leasing comment, will show up in leasing description for the potential buyer.

LeasingRate

Currency and percentage values are represented as String using the . as decimal separator with two digits precision. The fields should be parsed using arbitrary rounding strategy.

Field Name Type Description

type

LeasingType

Target group of this leasing rate. (Required)

downPayment

Int

This is the amount the buyer needs to pay at the beginning of the leasing contract. For now, this must be 0. (Required)

termOfContract

String

This is the length of the leasing contract in months. We allow the following contract durations: '12'/'18'/'24'/'30'/'36'/'42'/'48'/'54'/'60'. (Required)

annualMileage

String

Annual mileage in KM, possible values: '10000'/'15000'/'20000'/'25000'/'30000'/'40000'. (Required)

totalAmount

String

This is the total amount the buyer needs to pay over the length of the contract. Usually this is the rate times the number of months in the contract duration. (Required)

grossRate

String

The rate the buyer needs to pay in a given month during the contract period. It includes the German VAT rate, as these offers are currently only for customers in Germany. (Required for type PRIVATE)

netRate

String

Net leasing rate, see above (not including VAT for commercial leasing). (Required for type COMMERCIAL)

netLoanAmount

String

Net loan amount (in German Nettodarlehnbetrag). (Required for type PRIVATE)

annualPercentageRate

String

Annual percentage rate, (in German Effektiver Jahreszins). (Required for type PRIVATE)

nominalInterestRate

String

Nominal interest rate (in German Sollzins p.a.) (Required for type PRIVATE)

destinationCharges

String

Destination charges / freight costs. These are the costs the buyer needs to pay for freight costs (in German Überführungskosten). If it is "0.00", we will display charges, including to the buyer. This field is optional (we will show, “no information available” to the buyer by default).

registrationFees

String

Registration fees (in German Zulassungskosten). Same rules as for Destination Charges.

extraMileageCosts

String

Extra mileage costs, (in German Mehrkilometer Kosten). The costs a buyer needs to pay at the end of the contract if they have incurred a higher mileage than allowed for in the leasing contract.

lowMileageCompensation

String

Low mileage compensation, (in German Minderkilometer Erstattung). The amount a buyer gets returned at the end of the contract if they have incurred a lower mileage than agreed for in the leasing contract.

maintenanceMonthlyCost

String

Maintenance cost per month.

wearMonthlyCost

String

Cost of vehicle wear per month.

maintenanceAndWearCombinedMonthlyCost

String

Combined monthly cost of maintenance and vehicle wear.

liabilityInsuranceMonthlyCost

String

Monthly cost of liability insurance.

liabilityInsuranceDeductible

String

Amount of money that the customer needs to pay by themselves in an insurance case.

fullyComprehensiveInsuranceMonthlyCost

String

Monthly cost of full cover insurance.

fullyComprehensiveInsuranceDeductible

String

Amount of money that the customer needs to pay by themselves in an insurance case.

vehicleTaxMonthlyCost

String

Monthly cost of vehicle tax.

summerAndWinterTiresMonthlyCost

String

Monthly cost of a full set of summer and winter tires.

tuevMonthlyCost

String

Proportionate monthly tuev cost.

returnInsuranceMonthlyCost

String

Monthly cost of return insurance.

ObsAttributes

Field Name Type Description

optOutOfSellingThroughMobileDe

Boolean

Opt out from selling the vehicle via Online-Kauf with mobile.de as the contracting party to the end customer. Setting this attribute to TRUE disables the listing for OBS, given that the partner dealer operates under the current model where mobile.de is the seller of the vehicle. The classifieds ad continues to exist after the Online-Kauf ad has been disabled.

noDamagesOrExcessiveTracesOfUse

Boolean

Dealers can confirm that a vehicle does not have any damages or excessive traces of use by setting this flag to TRUE.

vehicleCondition

String

Description of the general vehicle condition, especially taking into account potential flaws that are not visible from the outside (e.g., a rattle noise when driving). Max 500 characters.

rentalOrCarSharing

Boolean

Information whether the car has been previously used as a rental car or for car sharing.

warrantyExpirationDate

String

End date of any warranty that is given by the dealer and is valid for the vehicle. Format: YYYYMM

pickupEarliestDate

String

Providing the date when the vehicle can be picked up at its location by mobile.de’s fulfilment partner. If the time slot is not predictable, choose any time within opening hours. Format: YYYY-MM-DDThh:mmTZD (ISO-8601).

pickupAddress

PickupAddress

Address where the vehicle can be picked by mobile.de’s fulfilment partner.

pickupContact

PickupContact

Contact person(s) for the handover and pick up of the vehicle on the side of the dealer.

pickupTires

PickupTires

The set of tires that are actually on the vehicle. Needed for the communication with mobile.de’s fulfilment partner, since the delivery to the end customer happens on the vehicle’s own axis.

PickupAddress

Address where the vehicle can be picked by mobile.de’s fulfilment partner.

Field Name Type Description

companyName

String

The name of the dealership / company. Max 100 characters.

street

String

The street name. Max 100 characters.

houseNumber

String

The house number. Can be a number or a combination of numbers and letters. Max 10 characters.

zipCode

String

The postcode. Numbers only, e.g., 14532. Max 10 characters.

city

String

The city name. Max 100 characters.

note

String

Additional pickup note for mobile.de’s fulfilment partner (e.g., “car is parked on the street”). Max 100 characters.

PickupContact

Contact person(s) for the handover and pick up of the vehicle on the side of the dealer.

Field Name Type Description

firstName

String

The first name of the contact person(s). Max 50 characters.

lastName

String

The second name of the contact person(s). Max 50 characters.

role

String

The role or title of the pickup contact person(s) (e.g., Operations, Sales or similar). Max 50 characters.

phoneNumber

String

The phone number (landline) of the contact person(s). Max 50 characters.

mobileNumber

String

The mobile number of the contact person(s). Max 50 characters.

email

String

The email address of the contact person(s). Max 100 characters.

ObsDocuments

Container type for the request and response of OBS document endpoints.

Field Name Type Description

obsDocuments

Collection of ObsDocument

ObsDocument

Field Name Type Description

imageUrl

String

Reference URL for OBS documents. These URLs need to be stored on the side of the transfer service provider or dealer to be able to reference documents for future requests.

description

String

Informative description to the image.

SelfUploadAccount

Field Name Type Description

accountName

String

System generated account name

password

String

System generated password

creationTime

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

ErrorResponse

Top level type that describes api call failure

Field Name Type Description

errors

Collection of Error

List of errors. For example a list of missing fields that are required for given operation.

Error

Describes an api error.

Field Name Type Description

key

String

Indicates a type of problem - e.g. missing required field or invalid field value

message

String

Human readable error description

args

Collection of Arg

List of key-value pairs detailing the failure

Arg

Field Name Type Description

key

String

Key of detailed error

value

String

Description of detailed error

DirectOffer

Top level type for representing Direct Offer.

Field Name Type Description

offerText

String

This is the direct offer text that will be displayed to consumers.

validForDays

Int

The validity of direct offer in days, This value can be at maximum 14 and at minimum 1 .

DirectOfferResponse

Top level type for representing Direct Offer Response.

Field Name Type Description

offerText

String

This is the direct offer text that will be displayed to consumers.

validUntil

String

The is the date until when the direct offer is valid.

createdAt

String

This is date on which the direct offer was created. e.g. 2023-06-16T11:12:37.098+02:00. See Date Time Representation for details.

mobileAdId

Long

The Id of the ad, not required for creating direct offer.

blocked

Boolean

This represents if the direct offer is blocked.

FeatureBlockReason

Possible Value Description

BOOKING_ASSISTANCE

The feature is booked automatically by the booking assistance and cannot be unbooked at this time

COST_CONTROL

The feature cannot be booked because of not enough free contingents or budget

AUTOMATIC_KLEINANZEIGEN_EXPORT

Relevant only to the kleinanzeigenExport feature. The feature cannot be booked because the automatic export is enabled.

DEALER_RATING_INSUFFICIENT

The feature can’t be booked because the dealer rating is below 3.5 points.

DEALER_ACCOUNT_TYPE_TOO_LOW

The feature can’t be booked because the dealer account type is compact.

MOBILE_DE_REQUIREMENTS

Requirements: SiteId is GERMANY and the ad must not have closed domain visibility.

NO_CONTINGENT_LEFT

No contingent left for this feature.

NOT_BOOKABLE

Feature is not bookable.

KLEINANZEIGEN_EXPORT_NOT_POSSIBLE

The feature can’t be booked because it doesn’t match kleinazeigenkExport requirements.

AD_TURBO

The feature can’t be booked because Ad Turbo is active.

AdFeature

Possible Value Description

PAGE_ONE_AD

With the Page-1-Ad, your ad will be listed on the first page of search results when your vehicle matches a potential buyer’s search criteria (flagged as a ‘sponsored ad’). If there are more than three Page-1-Ads that fit the search, the ads presented are selected at random from all the ads ordered.

EYE_CATCHER

With the Eyecatcher, the search results show your ads enlarged and with colour highlighting and a clearer structure that helps them to stand out.

FINANCING_FEATURE

You can add Financing proposals to your ads (commercial vehicles excluded). When you order a Financing proposal, your ad appears in detail on the Detailed Item Page and is flagged on the search results pages.

TOP_OF_PAGE

The Top Ad places your vehicle in the top slot of the search results pages, under the condition that your vehicle matches the potential buyer’s search criteria. If more than three Top Ads match a search query, the top displayed ad is selected at random from all the matching booked Top Ads.

RED_PENCIL

Bookable feature indicating that the price of a vehicle was reduced, showing the old price and the new price.

EBAYK_EXPORT

DEPRECATED - Please use "KLEINANZEIGEN_EXPORT".

KLEINANZEIGEN_EXPORT

Bookable feature indicating that this ad should be exported to Kleinanzeigen. Vehicle must be a car and must have a milage above 1500km.

AD_TURBO

See changelog for more details https://services.mobile.de/manual/changelog.html#2018-01-19

AdQualityStatus

Possible Value Description

BLOCKED

Ad blocked by the quality team. The ad is currenlty under investigation and therefore it’s visible on the platform. During that period changes to the ad are still posible.

DELETED

The ad has been removed from the platform due to the violations of the terms and conditions. No further changes to the ad will be accepted and it must be manually removed by the customer.

SellerType

Possible Value Description

DEALER

FOR_SALE_BY_OWNER

Salutation

Possible Value Description

FEMALE

MALE

RatingYesNoAnswer

Captures Yes/No answer or that the answer was not given.

Possible Value Description

YES

The user gave a positive answer.

NO

The user gave a negative answer.

UNDEFINED

The user did not give any answer.

BoughtTheCarAnswer

Possible Value Description

YES

The user bought the car.

OTHER

The user bought other car from the dealer - not the one the user was originally interessted in.

NO

The user did not buy any car from the dealer.

InviteState

Possible Value Description

ELIGIBLE

There is an eligible ad for which the dealer can request the rating.

PENDING

The email address is submitted and the invitation email is scheduled for sending.

SENT

The invitation is sent to the user. The user can start completing the survey.

STARTED

The user has already started the survey. Once the survey is completed a new dealer rating will be created.

LeasingType

Possible Value Description

PRIVATE

Leasing rate is offered to private persons.

COMMERCIAL

Leasing rate is offered to commercial entities, could be a single person or a company.

PickupTires

Possible Value Description

SUMMER

WINTER

ALL_SEASON

Role

Possible Value Description

VehicleRegistration

Vehicle registration document ("Zulassungsbescheinigung Teil 1”). JPG, JPEG, PNG, PDF (max. 10 MB)

ServiceHistory

Service history document (“Scheckheft”). JPG, JPEG, PNG, PDF (max. 10 MB)

CheckList

Checklist of used car inspection. JPG, JPEG, PNG, PDF (max. 10 MB)

TuevReport

TÜV protocol of last car inspection (“TÜV DEKRA Prüfbericht”). PG, JPEG, PNG, PDF (max. 10 MB)

Other

Can be used to submit other documents about the vehicle’s condition and service history (e.g., if all vehicle related documents are stored as one file instead of separate ones). JPG, JPEG, PNG, PDF (max. 10 MB)

Mileage

A photo of the odometer, with the engine running. JPG, JPEG, PNG (max. 10 MB)

DamageImages

Array of photos of damages and excessive traces of use (e.g., scratches, dents), along with descriptions of each photo. Array of images [ JPG, JPEG, PNG (max. 10 MB) ]

Fields for Vehicle Classes

When a new Ad is created one of the most important information is the vehicle class (vehicleClass field).

{
  "vehicleClass": "Car", (1)
  "category": "EstateCar",
  "make": "AUDI",
  "model": "A4",
  "modelDescription": "A4 Avant 2.0 TFSI multitronic Attraction",
  ...
}
1 vehicle class in this case is Car

The vehicleClass field indicates what kind of vehicle that is and most importantly specifies which fields must be specified for a given ad. Various vehicle categories have different set of supported and required fields. Please refer to the sections below for more details about each vehicle class.

List of all supported classes is specified in the class reference data.
Legend: Required = Optional = Not available =
Field name

category

make

price

firstRegistration

mileage

modelDescription

damageUnrepaired

model

vehicleClass

abs

accidentDamaged

airSuspension

airbag

alarmSystem

allSeasonTires

alloyWheels

ambientLighting

androidAuto

armRest

automaticRainSensor

auxiliaryHeating

battery

batteryCapacity

bendingLightsType

biodieselSuitable

blindSpotMonitor

bluetooth

breakdownService

cargoBarrier

carplay

cdMultichanger

cdPlayer

centralLocking

climatisation

closedDomain

co2

collisionAvoidance

condition

constructionDate

constructionYear

consumptionCombined

consumptionInner

consumptionOuter

consumptionPowerCombined

consumptionUnit

countryVersion

cubicCapacity

daytimeRunningLamps

dealerHomepage

deliveryDate

deliveryPeriod

description

detailPageUrl

digitalCockpit

dimmingInteriorMirror

disabledAccessible

distanceWarningSystem

doors

e10Enabled

electricAdjustableSeats

electricBackseatAdjustment

electricExteriorMirrors

electricHeatedRearSeats

electricHeatedSeats

electricTailgate

electricWindows

emergencyCallSystem

emissionClass

emissionSticker

energyEfficiencyClass

envkvCompliant

envkvPetrolType

esp

export

exteriorColor

fatigueWarningSystem

financing

firstModelsProductionDate

foldFlatPassengerSeat

fourWheelDrive

frontFogLights

fuel

fullServiceHistory

gearbox

generalInspection

glareFreeHighBeam

handsFreePhoneSystem

headUpDisplay

headlightType

headlightWasherSystem

heatedSteeringWheel

heatedWindshield

highBeamAssist

highlights

hillStartAssist

hybridPlugin

immobilizer

integratedMusicStreaming

interiorColor

interiorType

internalNumber

isofix

kba

keylessEntry

laneDepartureWarning

leatherSteeringWheel

lightSensor

lumbarSupport

manufacturerColorName

massageSeats

metallic

modelRange

multifunctionalWheel

navigationSystem

newHuAu

nightVisionAssist

nonSmokerVehicle

numberOfPreviousOwners

onBoardComputer

paddleShifters

panoramicGlassRoof

parkingAssistants

particulateFilterDiesel

passengerSeatIsofixPoint

performanceHandlingSystem

power

powerAssistedSteering

radio

rangeExtender

renewalDate

reserved

roadworthy

roofRails

schwackeCode

seats

skiBag

slidingDoorType

smokersPackage

soundSystem

speedControl

speedLimiter

sportPackage

sportSeats

startStopSystem

steelWheels

summerTires

sunroof

taxi

tirePressureMonitoring

touchscreen

tractionControlSystem

trafficSignRecognition

trailerCouplingType

trimLine

tv

uploadSticky

usageType

usb

usedCarSeal

vegetableoilfuelSuitable

ventilatedSeats

videoUrl

vin

voiceControl

warranty

wifiHotspot

winterPackage

winterTires

wirelessCharging

awning

axles

bed

biodieselConversion

bunkBed

circularSeatingArrangement

damageByHail

dimension

licensedWeight

middleSeatingArrangement

numberOfBunks

rearGarage

rentingPossible

secondaryAirConditioning

sepShower

sideSeatingArrangement

solarenergySystem

wc

box

catalyticConverter

disabledConversion

drivingMode

electricStarter

kickstarter

rollOverBar

windshield

crane

divider

drivingCab

europalletStorageSpaces

loadingSpace

municipal

shippingVolume

tailLift

compressor

ebs

hydraulicInstallation

retarder

wheelFormula

fullFairing

superSingleWheels

ureaTankAdBlue

vegetableoilfuelConversion

discBrake

loadCapacity

bss

centralLubricantApplication

operatingHours

quickChangeAttachment

roadLicence

coldstore

driversSleepingCompartment

kitchen

sleepSeats

cabin

frontHydraulics

frontJack

installationHeight

liftingCapacity

liftingHeight

protectionRoof

Error Handling and Data Validation

In case the submitted data or call syntax in general is incorrect the api call results in 400 status response. Additionally it may contain a message body (error response) that provides more details about the error. The api tries to provide as much feedback as possible so the error response may contain more than one error.

Example
{
  "errors": [ (1)
    {
      "key": "category-empty" (2)
    },
    {
      "key": "make-empty" (2)
    }
    {
      "key": "mileage-empty" (2)
    }
  ]
}
1 List of errors.
2 The key element indicates what kind of error that is. Please refer to the next paragraphs for full reference of the error keys.

Sometimes the errors contains more details for individual error keys.

Sample Request
POST /seller-api/sellers/28480/ads HTTP/1.1
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Carx"
}
Sample Error Response
{
  "errors": [
    {
      "key": "invalid-value", (1)
      "args": [ (2)
        {
          "key": "path",
          "value": "vehicleClass"
        },
        {
          "key": "invalid-value",
          "value": "Carx"
        }
      ]
    }
  ]
}
1 Error key.
2 Additional details about the error. In this case Carx is not a valid value for field vehicleClass.

Generic Error Keys

Error Key Description

invalid-path-parameter

The path parameter contains invalid value. E.g. expected value is a number but received a string.

Input Data Validation

For the write api calls (PUT, POST) the incoming data is validated on a multiple levels.

Syntax Validation

The first level of validation is to check whether the data is syntactically correct according to the specified media type.

json-parse-error

This error key indicates that the submitted json is not syntactically valid.

Request
POST /seller-api/sellers/28480/ads HTTP/1.1
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Car,
  "make": "AUDI'
}
Response
{
  "errors": [
    {
      "key": "json-parse-error",
      "args": [
        {
          "key": "parser-message",
          "value": "Unterminated object at line 3 column 5 path $.vehicleClass"
        }
      ]
    }
  ]
}

Another case when this error happens is an incorrect type of value. For example. The expected value of the mileage field is a number but the json contains text.

POST /seller-api/sellers/28480/ads HTTP/1.1
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Car",
  "category": "EstateCar",
  "make": "AUDI",
  "model": "A4",
  "modelDescription": "A3 sline",
  "firstRegistration": "201012",
  "damageUnrepaired": false,
  "mileage": "low",
  "price": {
    "consumerPriceGross": "8000"
  }
}
{
  "errors": [
    {
      "key": "json-parse-error",
      "args": [
        {
          "key": "parser-message",
          "value": "Number format error: For input string: \"low\""
        }
      ]
    }
  ]
}
xml-parse-error

When invalid xml data is submitted it produces the following error.

Request
POST /seller-api/sellers/28480/ads HTTP/1.1
Content-Type: application/vnd.de.mobile.api+xml

<ad>
  <vehicleClass>Car</vehicleClass>
  <make>AUDI</make>
</aaad>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorResponse>
    <errors>
        <error>
            <key>xml-parse-error</key>
            <args>
                <arg>
                    <key>parser-message</key>
                    <value>The element type "ad" must be terminated by the matching end-tag "&lt;/ad&gt;".</value>
                </arg>
            </args>
        </error>
    </errors>
</errorResponse>
Additional syntax validation error keys
Error Key Description

decoding-error

Character encoding/decoding error. Please use UTF-8.

wrong-root-type

Root xml element doesn’t match the data type specified for a given call. For example, the call expects Ad data but the submitted xml contains root element <seller>…​</seller>.

Semantic Validation

Once the data is syntactically correct the next step is to validate the data from the business perspective. This involves:

  • ensuring that mandatory fields are present. The actual set of mandatory fields depends on the vehicle class.

  • checking that specified values are correct, e.g. mileage can’t be negative or first registration date can’t be in the future

  • applying more complex rules to cross-check various fields, e.g. mileage can’t be higher than certain level for new cars

If inconsistent data is found, an error key is generated and sent to you in the response. The vehicle in question will not be uploaded. The significance behind these error key is that it is in both your and our interest to have as much data as possible in the database which is free of errors. A user will not appreciate receiving an offer of a vehicle that is only two years old when he/she is looking for a classic vehicle.

invalid-value

This error key is reported when the provided value doesn’t satisfy the field specification.

Sample Request
POST /seller-api/sellers/28480/ads HTTP/1.1
Content-Type: application/vnd.de.mobile.api+json

{
  "vehicleClass": "Vehicle",
  "category": "EstateCar",
  "make": "audi",
  "model": "A4",
  "modelDescription": "A3 sLine",
  "firstRegistration": 201012,
  "damageUnrepaired": false,
  "mileage": 12000,
  "price": {
    "consumerPriceGross": "8000"
  }
}
Sample Error Response
{
  "errors": [
    {
      "key": "invalid-value",
      "args": [
        {
          "key": "path",
          "value": "vehicleClass"
        },
        {
          "key": "invalid-value",
          "value": "Vehicle"
        }
      ]
    }
  ]
}

In this case the value Vehicle is incorrect for the field vehicleClass. Please check the vehicleClass field specification for more details.

Used Car Seals

All vehicles possessing a Used Car Seal will be subject to further checks. For rules on assigning used car seals see used-car-seals.

Error Keys

The table below contains a list of other possible error keys that are reported during the semantic validation.

Error Key Description

envkv-values-required

The marker "envkv" requires all consumption and emission values and the fuel type being set. EnVKV values are required for new cars, single day registration and demonstration vehicles.

constructionyear-registrationyear-pluasibility

The year of construction cannot lie behind the first registration date. Please correct either the first registration date or the construction year

closingcosts-invalid

Closing Costs Invalid

make-model-mismatch

The selected model dooesn’t match the select make

envkv-carbon-dioxyd-emission-invalid

Please enter a positive carbon dioxyd emission value or leave the field empty

financing-conditions-too-long

The financing conditions you entered are too long. The maximum number of characters is 60.

usedcarseal-criteria-not-matched

The vehicle does not match the necessary criteria for the Used Car Seal you selected

envkv-consumption-combined-invalid

Please enter a positive fuel consumption combined value or leave the field empty

endingrate-invalid

Ending Rate Invalid

make-empty

Please select a Make.

rateinsurance-invalid

Rate Insurance Invalid

netprice-without-vat

You must enter a valid VAT rate when using a net price

liftingheight-invalid

The lifting height you entered is invalid

mileage-empty

You must enter a mileage

vehicleIdentificationNumber-invalid

The vehicle identification number (VIN) you entered is invalid

loadingspaceheight-invalid

The loading space height is invalid

usedcarseal-on-new-car-warning

The Used Car Seal can not be assigned to new cars

firstinstallment-invalid

First Installment Invalid

highlights-2-invalid-chars

The 2nd highlight contains invalid chars

dealerpriceamount-invalid

The amount of the dealer price is invalid

price-type-price type invalid

You must select a price type

description-contains-phone

The description text is not allowed to contain a phone number

envkv-consumption-outer-invalid

Please enter a positive fuel consumption (extra-urban) value or leave the field empty

highlights-1-too-long

The 1st highlight is too long (max. 22 chars)

power-invalid-range

Power must be in a range from 0 to 999.

envkv-consumption-outer-is-empty

Please enter the fuel consumption (extra-urban)

operatinghours-invalid

The operating hours you entered are invalid

nominalinterestrate-invalid

Nominal Interest Rate Invalid

envkv-combined-power-consumption-invalid

combined power consumption invalid

category-invalid

The Category you entered is invalid

price-type-empty

You must select a price type

invalid-video-url

Invalid YouTube Link

ratepercent-invalid

Rate Per Cent Invalid

price-empty

A price must be provided.

period-invalid

Duration Invalid

cubiccapacity-invalid

The cubic capacity you entered is invalid

manufacturercolorname-too-long

The manufacturer colour name you entered is too long. The maximum number of characters is 32.

financing-mandatory-fields-new

When booking the financing feature, all mandatory financing-values must be present (ratePerCent, monthlyRate, period, grossCreditAmount, closingCosts, rateInsurance, netCreditAmount, bank, nominalInterestRate, typeOfNominalInterestRate).

deliveryperiod-only-for-new-cars

You can only enter a delivery period for new vehicles

model-empty

For the vehicle-class Car a model is required. See Reference Data.

fuel-empty

You must select a fuel type.

modeldescription-contains-phone

The model description may not contain a phone number.

loadingspacelength-invalid

The load capacity you entered is invalid

model-without-make

Please select both Make and Model

envkv-and-electricity-failure

Less Envkv Fields When Fuel Type Electro

manufacturercolorname-invalid-chars

The manufacturer colour name contains invalid characters

deliverycost-invalid

Delivery costs invalid

constructionyear-invalid

The construction year you entered is invalid

usedcarseal-not-permitted

You are not authorized to use the Used Car Seal you selected

countryversion-missing

Countryversion necessary for new cars.

numberofbunks-invalid

The number of bunks is invalid

highlights-3-too-long

The 3rd highlight is too long (max. 22 chars)

highlights-2-too-long

The 2nd highlight is too long (max. 22 chars)

select-country-version

The country version is missing

highlights-3-invalid-chars

The 3rd highlight contains invalid chars

vehiclelength-invalid

The vehicle length is invalid

highlights-1-invalid-chars

The 1st highlight contains invalid chars

first-registration

A first registration date is required for all used vehicles.

numberOfPreviousOwners-invalid

Number Of Previous Owners Invalid

deliverydate-year-too-low

The delivery year is too low

dealer-price-not-supported

For FSBO Ads there cannot be a dealer price.

installationheight-invalid

The installation height you entered is invalid

loadcapacity-invalid

The load capacity you entered is invalid

usagetype-demonstration-not-for-fsbo

No Demonstration Vehicles

envkv-combined-power-consumption-is-empty

combined power consumption is empty

modeldescription-too-long

The model/variant you entered is too long (the model description may not be longer than 48 characters).

modeldescription-contains-url

The model description may not contain a URL.

vat-rate-not-allowed-for-on-request

VAT rate not allowed for on request

usagetype-unsupported-for-new-vehicles

A new vehicle cannot be a vehicle with pre-registration, employees-one-year-car, classic car or demonstration-vehicle.

au-year-too-high

Invalid year for AU (ASU - exhaust-inspection). The value must not be more than 6 years in future.

firstregistration-classiccar-conflict

For classic cars the first registration must date back at least 20 years

shippingvolume-invalid

The shipping volume is invalid

currency-invalid-for-site

Currency invalid for site

grosscreditamount-invalid

Gross Credit Amount Invalid

vehiclewidth-invalid

The vehicle width is invalid

europalletstoragespaces-invalid

The number of europallet storage spaces is invalid

constructiondate-invalid

Date Of Manufacture Invalid

firstregistration-invalid

The First Registration Date you entered is invalid

manufacturercolorname-contains-url

The manufacturer colour name contains an URL

condition-classiccar-conflict

The condition of a classic car must be set to 'used'

modeldescription-empty

Please enter the model or respectively the variant for cars

category-empty

Please select a category.

usedcarseal-on-damaged-car-warning

The Used Car Seal can not be assigned to damaged cars

loadingspacewidth-invalid

The load capacity you entered is invalid

envkv-carbon-dioxyd-emission-is-empty

Please enter the carbon dioxyd emission value

firstregistration-employeescar-conflict

First registration must not be more than 23 months in the past.

envkv-consumption-inner-invalid

Please enter a positive fuel consumption (urban) value or leave the field empty

delivery-period-xor-delivery-date

For new Cars either delivery date or delivery period must be provided, but not both at the same time.

envkv energy efficiency class is empty

Enter Efficiency Class

average-price-not-for-damaged-vehicles

Average price cannot be calculated for cars with unrepaired damage

mileage-used-invalid

The mileage you entered is invalid for a used car

modeldescription-invalid-chars

The model/variant you entered contains invalid characters

deliveryperiod-invalid

Delivery period invalid

vat-rate-invalid

The VAT rate is invalid

price-type-bidding-inconsistent

You must select a price type

financing-bad-integrity

The aggregated value of the financing model may not be less than the consumer price

numberOfPreviousOwners-unsupported

You are not able to specify previous owners for this vehicle because it is a new vehicle

damageunrepaired-empty

You must select whether the vehicle has a unrepaired damage

internalnumber-invalid-chars

The entered internal number contains invalid characters

constructionyear-empty

Please enter the construction year

bank-too-long

The Bank you entered is too long. The maximum number of characters is 150.

firstregistration-newcar-conflict

The first registration date must be empty for new vehicles

features-contains-invalid-value

Features contain invalid value

internalnumber-too-long

The internal number you entered is too long (max. 40 characters)

description-too-long

The description you entered is too long

firstregistration-empty

Please fill in the First Registration Date

consumerpriceamount-invalid

The price amount is invalid. Please use only digits (no full stops or commas) when entering the price

liftingcapacity-invalid

The lifting capacity you entered is invalid

modeldescription-contains-email

The model description may not contain an e-mail address.

envkv-consumption-inner-is-empty

Please enter the fuel consumption (urban)

axles-invalid

The number of axles is invalid

numseats-invalid

The number of seats you entered is invalid

dealer-price-to-high

The dealer’s price cannot be higher than the retail price.

currency-empty

Currency is empty

monthlyrate-invalid

Rate Invalid

deliverydate-year-too-high

The delivery year is too high

vehicleheight-invalid

The vehicle height is invalid

envkv-consumption-combined-is-empty

Please enter the fuel consumption combined

netcreditamount-invalid

Net Credit Amount Invalid

description-contains-email

The description text is not allowed to contain an email address

description-empty

Please enter a description

duplicate-seller-inventory-key

The internalNumber (AKA seller inventory key) must be unique for given seller

ad-only-modifiable-in-dealer-area

The dealer blocked changes to this ad (uploadSticky=true) and it can’t be changed via seller-api any more. The uploadSticky flag can be reset in the dealer area.

licensedweight-invalid

The licensed weight you entered is invalid

au-year-too-low

Invalid year for AU (ASU - exhaust-inspection). The value must not be before the year 1000.

mileage-new-invalid

The mileage is invalid for a new car

hu-year-too-low

Invalid year for HU (TUEV / general-inspection / technical inspection / hu-date). The value must not be before the year 1000.

internalnumber-contains-email

The entered internal number contains an email address

hu-year-too-high

Invalid year for HU (TUEV / general-inspection / technical inspection / hu-date). The value must not be more than 6 years in future.

renewal-for-site-id-other-than-germany-not-allowed

Renewal is only allowed for Germany Site Id

manufacturercolorname-contains-email

The manufacturer colour name contains an email address

average-price-only-for-cars

Average price can only be calculated for cars

power-empty

You must enter a power

consumer-price-not-in-range

The price amount is not in a valid range

make-invalid-category

The selected category is invalid for the selected make

batterycapacity-invalid

The entered battery capacity is not in the range between 1 and 999 kWh

modelrange-too-long

The model range contains too many characters. The maximum number of characters is 255.

parkassists-cam-360-degrees-and-rear-view-cam-selected

Rear view camera and 360° camera can’t be selected together

trimline-too-long

The trim line contains too many characters. The maximum number of characters is 255.

ad-deleted-by-mobile-quality

The ad has been removed by the mobile.de quality team. Please see the adQuality for more details.

request-id-too-long

The value submitted in the X-Mobile-Insertion-Request-Id is too long. Max length is 100 characters.

request-id-invalid-characters

The value submitted int he X-Mobile-Insertion-Request-Id contains invalid characters. Only alphanumeric characters are allowed.

buyer_email_not_allowed

There are certain rules to prevent cheating.

invite_for_ad_already_exists

An invite for the mobileAdId already exists.

rating_for_ad_already_exists

A rating for the mobileAdId already exists.

ad_not_eligible

Only eligible mobileAdIds can be used to sent invitations.

personalized_invite_text_not_supported

Dealer needs to be at least in package Premium for this feature.

not_reinviteable

This mobileAdId is not reinviteable.

invite_email_invalid

Email address needs to be valid.

invite_email_empty

Email addrerss can not be empty.

invite_text_empty

When no personalized invite text is required, it should not be send or set to null, but can not be blank.

invite_text_too_long

The personalized invite text can be maximum 3000 characters long.

rating_not_supported_for_dealer

The Dealer needs to have at least account type Comfort for rating management via API.

rating_reply_too_long

A rating reply can be maximum 1000 characters.

rating_reply_is_empty

A rating reply can not be empty.

charging-time-invalid

Charging time must be in a range from 1 to 1439

charging-time-fast-invalid

Fast charging time must be in a range from 1 to 1439

content-too-large

File size exceeds max allowed size of 10MB

invalid-seller

Given mobileSellerId is not prepared for OBS

leasing-only-price-type-cannot-be-changed

The price type of a leasing-only ad cannot be changed, i.e., from LEASING_ONLY to FIXED

leasing-only-ad-cannot-be-activated-without-leasing-rates

To activate a leasing-only ad, one must set the leasing rates for the ad

frame-height-invalid

The frame height is not in valid range. The value must be between (and including) 30 and 80.

frame-number-too-long

The frame number is too long. The maximum number of characters is 25.

battery-capacity-wh-invalid

The battery capacity is not in valid range. The value must be between (and including) 250 and 1500.

weight-e-bike-invalid

The weight of an E-Bike is not in valid range. The value must be between (and including) 8 and 90.

number-of-gears-invalid

The number of gears is not in valid range. The value must be between (and including) 1 and 24.

condition-of-e-bike-must-be-new

The condition for E-Bike must be new

e-bike-cannot-be-changed-to-other-vehicle-class

E-Bike cannot be changed to other vehicle classes, i.e., from EBike to Car

classic-leasing-not-allowed-for-e-bike

E-Bike cannot have classic leasing

Fuel And Energy Consumption Validation Rules

The table below summarizes the rules how to enter compliant fuel and energy consumption values.

Field Name Explanation

Fuel Type

Dictated by the fuel, hybridPlugin and rangeExtender fields

Inner Consumption

Rules for the consumptionInner field

Outer Consumption

Rules for the consumptionOuter field

Combined Consumption

Rules for the consumptionCombined field

Consumption Unit

The consumptionUnit is read only and the value is derived from the Fuel Type by Seller-API

Combined Power Consumption

The consumptionPowerCombined is meant only for vehicles that use combustion type engine and electricity for charging the battery

CO2 Emission

Rules for the co2 field
Fuel Type Inner Consumption Outer Consumption Combined Consumption Consumption Unit Combined Power Consumption CO2 Emission

Petrol, Diesel, Hybrid (Petrol, Diesel), LPG, Hydrogen, Ethanol

fuel=
 - PETROL
 - DIESEL
 - HYBRID
 - HYBRID_DIESEL
 - LPG
 - HYDROGENIUM
 - ETHANOL

required

required

required

l/100km

optional

required

CNG

fuel=CNG

required

required

required

kg/100km

optional

required

Hybrid (Petrol, Diesel) Plugin Hybrid

hybridPlugin=true
fuel=
 - HYBRID
 - HYBRID_DIESEL

optional

optional

required

l/100km

required

required

Electric with Range Extender

rangeExtender=true
fuel=ELECTRICITY

ignored

ignored

required

l/100km

required

required

Electric without Range Extender

rangeExtender=false
fuel=ELECTRICITY

ignored

ignored

required

kWh/100km

ignored

set by Seller-API to 0

HYDROGENIUM

fuel=HYDROGENIUM

required

required

required

kg/100km

optional

required and >= 0

Reference Data

Reference data is a set of tables that define valid values for a number of fields such as colors, makes, models and others.

Base url

The base url for the reference data endpoints is:

https://services.mobile.de

Authentication is not required for reference data endpoints.

Media Type

The reference data is exposed using json and xml representation. Please refer to Media Types section for more details.

Json request

GET /refdata/petroltypes HTTP/1.1
Accept: application/vnd.de.mobile.api+json

Json response

{
  "values": [
    {
      "name": "SUPER_PLUS",
      "description": "Super Plus"
    },
    {
      "name": "SUPER",
      "description": "Super"
    },
    {
      "name": "NORMAL",
      "description": "Normal"
    }
  ]
}

Internationalization Support

The reference data is localized. Specifying the Accept-Language header controls the language of the output.

Localized request

GET /refdata/gearboxes HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Accept-Language: de

Localized response

{
  "values": [
    {
      "name": "MANUAL_GEAR",
      "description": "Schaltgetriebe"
    },
    {
      "name": "SEMIAUTOMATIC_GEAR",
      "description": "Halbautomatik"
    },
    {
      "name": "AUTOMATIC_GEAR",
      "description": "Automatik"
    }
  ]
}

Reference Data Types

Site Id

List of supported Site Ids

Type Endpoint

site

/refdata/sites

Site Dependent Types

Some reference data may depend on the Site Id or could be based on some other types e.g. list of models depends on selected make. The endpoints are parametrized using path parameters. Furthermore, there is a site independent resource which contains all summarized site specific values and resources.

Type Endpoint (site independent and site specific)

class

/refdata/classes
/refdata/sites/:siteId/classes Example

category

/refdata/classes/:class/categories Example
/refdata/sites/:siteId/classes/:class/categories Example

make

/refdata/classes/:class/makes Example
/refdata/sites/:siteId/classes/:class/makes Example

model

/refdata/classes/:class/makes/:make/models Example
/refdata/:siteId/classes/:class/makes/:make/models Example

model group

/refdata/classes/:class/makes/:make/modelgroups Example
/refdata/sites/:siteId/classes/:class/makes/:make/modelgroups Example

model of a model group

/refdata/classes/:class/makes/:make/modelgroups/:modelgroup/models Example
/refdata/sites/:siteId/classes/:class/makes/:make/modelgroups/:modelgroup/models
Example

usedcarseal

/refdata/sites/:siteId/classes/:class/usedcarseals Example

vatrate

/refdata/sites/:siteId/vatrates Example

modelrange

/refdata/sites/:siteId/classes/:class/makes/:make/models/:model/modelranges?firstregistration=YYYYMM Example
query parameters
- firstregistration= YYYYMM (required)
- category= one of categories
- fuel= one of fuel
- doorcount= one of door counts
- trimline= one of trimlines

trimline

/refdata/sites/:siteId/classes/:class/makes/:make/models/:model/trimlines?firstregistration=YYYYMM Example
query parameters
- firstregistration= YYYYMM (required)
- category= one of categories
- fuel= one of fuel
- doorcount= one of door counts
- modelrange= one of modelranges

Site Independent Reference Data

Table Endpoint

airbag

/refdata/airbags

batteryManufacturer

/refdata/batterymanufacturers

battery

/refdata/batteries

batteryPosition

/refdata/batterypositions

bendingLightsType

/refdata/bendinglightstypes

bikeGearType

/refdata/bikegeartypes

bikeSuitableFor

/refdata/bikesuitablefor

breakdownService

/refdata/breakdownservices

climatisation

/refdata/climatisations

color

/refdata/colors

condition

/refdata/conditions

countryVersion

/refdata/countryversion

daytimeRunningLamps

/refdata/daytimerunninglamps

doorCount

/refdata/doorcounts

drivingCab

/refdata/drivingcabs

drivingModes

/refdata/drivingmodes

emissionClass

/refdata/emissionclasses

emissionSticker

/refdata/emissionstickers

frameMaterial

/refdata/framematerials

frameShape

/refdata/frameshapes

fuelConsumptionUnit

/refdata/fuelconsumptionunits

fuel

/refdata/fuels

gearbox

/refdata/gearboxes

headlightType

/refdata/headlighttypes

hydraulicInstallation

/refdata/hydraulicinstallations

interiorColor

/refdata/interiorcolors

interiorType

/refdata/interiortypes

motorPosition

/refdata/motorpositions

nominalInterestRateType

/refdata/nominalinterestratetypes

parkingAssistant

/refdata/parkingassistants

paybackPeriod

/refdata/paybackperiods

petrolType

/refdata/petroltypes

plugType

/refdata/plugtypes

priceRating

/refdata/pricerating

priceType

/refdata/pricetypes

radio

/refdata/radiotypes

slidingDoorType

/refdata/slidingdoortypes

speedControl

/refdata/speedcontrols

trailerCouplingType

/refdata/trailercouplingtypes

usageType

/refdata/usagetypes

wheelFormula

/refdata/wheelformulas

Reference Data for ad quality error keys

This reference data endpoint provides details about different error keys, why an ad is blocked or deleted due to term violations.

Table Endpoint

ad quality reasons

/refdata/ad-quality-reasons

Support

Customer Support Contact

Please contact the Customer Support team if you need further assistance.

Country Contact Details

Germany

Phone: +49 (0) 30 81097500 or Contact Form

Italy

Phone: +39 02 30410311 or Contact Form

France

Phone: +33 (0) 810 000 220 or Contact Form

FAQ

How to report an error, downtime or a bug?

Please send us a detailed description to service@team.mobile.de containing your Method, URL, Header, Content and Error- Code/Message

Where to find the internal number?

The internal number is a reference key used by the seller. Also known as internalNumber or internal-ID. If it is present, then it must be unique per seller. An empty string is treated same as if the element was not present. This field is restricted to a subset of UTF-8 characters. The option can be switched on/off by the dealer in his mobile.de account.

Difference between mobileSellerId / customerNumber?

All dealer accounts on mobile.de can be identified with their Seller-ID or their Customer Number. For all applicable requests (GET, POST, DELETE) please only use the Seller-ID.

How to prevent new ad placements?

New ad placements can be obtained by

  • deleting and replacing the same ad

  • renew an existing ad with the feature renewalDate

How to renew an ad?

An ad can be renewed by using the feature renewalDate – this feature can also be used to request the information when an ad was formerly renewed. (Renewed ads will be displayed as New for three days on mobile.de. This feature comes with costs if the amount of free feature contingents has been already exceeded. Explanation how to here.

Reference data explanation

The reference data helps you to find feasible values for our enumerated fields, like colors, makes, models and others.

Numerous reference data items provide a translated description. Default language is English, yet sending a HTTP header field Accept-Language enriched by the appropriate value enables the requester to get a translated description in all supported languages at mobile.de.

Semantic Validation

Semantic validations are used to check for various business rules, e.g. a new-car ad can’t be delivered if the mileage is over 500 km.

You can learn more about it here.

Table of Mandatory fields

Fields for Vehicle Classes

HTTP status and error codes

For a specific list of status or error codes please check our documentation. In case of not listed status codes please contact customer service via service@team.mobile.de

Seller-API and the costs

The mobile.de Seller-API comes without any costs. If all contractual requirements are set the Seller-API can be used within the limits of our Terms of Use.

Suggestions / recommendations on our Seller-API and/or the documentation

Please feel free to send us all of your suggestions to service@team.mobile.de