With the Retail Rating capability on Auto Trader Connect, you will have access to our retail rating via the Vehicles API or Vehicle Metrics API.
Here is a list of all the functionality you have access to as part of this capability:
- Vehicles lookup retail rating
- Vehicle metrics retail rating
- Location-adjusted retail rating
Retail Rating is our metric for measuring a vehicle’s desirability based national sale figures, supply, demand, the current market condition and several other factors.
Vehicle lookup retail rating
As part of this capability, you’ll be able to access our retail rating via the Vehicles API.
To do this, you need to make a GET request to the Vehicles API with:
- The Auto Trader advertiser ID of the customer the request is for
- The VRM in the registration query parameter
- The vehicle’s mileage in the query string parameter odometerReadingMiles
- The query string parameter vehicleMetrics=true
If successful, you’ll get a JSON object that contains the vehicle data and vehicle metrics object will include the retail rating. This rating will not be location-adjusted and is a national retail rating.
Check out an example of Vehicles API call for vehicle metrics
Vehicle metrics Retail Rating
Also, as part of this capability you’ll be able to access our retail rating via the Vehicle Metrics API.
To get this, you will need to make a POST request to the Vehicle Metrics API with:
- The Auto Trader advertiser ID of the customer the request is for
- The request body should include:
- The vehicle’s derivative ID
- The vehicle’s first registration date
- The vehicle’s current mileage
If successful, you’ll get a JSON object that contains the retail rating. This rating will not be location-adjusted and is a national retail rating.
If we are unable to provide vehicle metrics data or invalid data is supplied in the request body, you’ll get a 200 response code and the body of the response will contain an error message to say that we are unable to provide metrics.
Location-Adjusted Retail Rating
You can also get a location-adjusted retail rating from the Vehicle Metrics API. This will adjust the rating based on the desirability of the vehicle within a 50-mile radius of the location provided.
To do this, you need to provide the advertiser ID in the body of the POST request. You can provide up to 20 advertiser IDs in the request.
If successful, the JSON object returned by the API will include an array of the retail rating for each of the advertiser IDs provided in the request.
Check out examples of Vehicle Metrics API calls
Error handling
When using the APIs above, you may get error response codes that you need to handle. This makes sure you have a smooth service for both you, as a partner, and your end user.