Go Live checks for Vehicle Metrics – Auto Trader UK

To get live API access, your integration must pass certain tests. This will make sure that it meets our technical standards and best practices.

For each capability, the tests cover Essential and Enhanced functionalities. Your integration must pass at least one of the Essential functionality tests to get live access.

We recommend using the Enhanced functionalities to allow dealers to get the full benefits of the service.

We'll cover the tests for the following functionalities:

Vehicle lookup vehicle metrics (Essential)
In-stock vehicle metrics (Essential)
Adjusted vehicle metrics (Enhanced)
- - Advertiser ID location-adjusted (Enhanced)
  - Latitude and longitude location-adjusted (Enhanced)
  - Price-adjusted days to sell (Enhanced)
  - Confidence of sale (Enhanced)

There are three ways we check that tests are successful:

Demonstration - We will expect you to show us your code or your UI
Call log validation - We will check your API calls to our service to make sure the call is made correctly
Database check - We will check our database to see whether the correct attribute has been updated

Vehicle lookup vehicle metrics (Essential)

When looking up vehicle metrics data for a vehicle via the Vehicles API, at a minimum, you will need to make sure that you are passing:

The advertiser ID that the lookup is on behalf of
The registration that you are doing a lookup on
The odometerReadingMiles parameter
The vehicleMetrics=true parameter

When testing registrations in sandbox, you should be able to use any registration that you would use in production. Most of our vehicle data that’s available in production will be available in sandbox. Newer vehicles, or vehicles that have had a plate change recently, may not be reflected in sandbox.

Test	How we'll check it
Able to fulfil mandatory checks in the Vehicle registration lookup functionality in the Vehicle Taxonomy capability Go Live checks
Able to get the vehicle metrics data for a vehicle via the Vehicles API for at least one of the following data points. This should only be used for vehicles not in your stock: Supply Demand Market condition Retail rating Days to sell	Demonstration and call log validation
Request is included within your initial Vehicle API request, do not repeat calls	Demonstration
Able to handle a 200 response with no metrics, and present a message back to the user	Demonstration
Calls should be completed once per day, as vehicle metrics are only updated daily	Demonstration and call log validation

In-stock vehicle metrics (Essential)

If you would like to get both national and local vehicle metrics data for a vehicle in your stock, include the vehicleMetrics=true parameter in the query string of your Stock API GET request.

Test	How we'll check it
Able to fulfil mandatory checks in the Baseline stock functionality in the Stock Sync capability Go Live checks
Able to get the vehicle metrics data for a vehicle via the Stock API for at least one of the following data points: National Supply Demand Market condition Retail rating Days to sell Local Retail rating Days to sell	Demonstration and call log validation
Request is included within your initial Stock API request, do not repeat calls	Demonstration
Able to handle a 200 response with null metrics, and present a message back to the user	Demonstration
Calls should be completed once per day, as vehicle metrics are only updated daily	Demonstration and call log validation

Adjusted vehicle metrics (Enhanced)

If you would like to get location-adjusted vehicle metrics, price-adjusted days to sell, or confidence of sale rating, use the Vehicle Metrics API.

As a minimum, you will need to include the following in the body of your POST request:

The derivative ID of the vehicle you are doing the request on behalf of
The first registration date
The odometer reading miles

Test	How we'll check it
Able to get the vehicle metrics for a vehicle via the Vehicle Metrics API	Demonstration and call log validation
Able to handle a 200 response with null metrics, and present a message back to the user	Demonstration
Calls should be completed once per day, as vehicle metrics are only updated daily	Demonstration and call log validation
Optional checks
Able to use the Vehicle Taxonomy capability to get a derivative ID - relevant mandatory checks should be fulfilled in the Vehicle Taxonomy Go Live checks	Demonstration
If you want to adjust for location or get price-adjusted days to sell, this is all done in one call to the Vehicle Metrics API, and not multiple calls, where possible	Demonstration

Advertiser ID location-adjusted (Enhanced)

You can get an advertiser ID location-adjusted vehicle metrics via the Vehicle Metrics API by including an array of advertiser IDs in the body of the Vehicle Metrics API POST request.

Test	How we'll check it
Able to get location-adjusted vehicle metrics, including up to a maximum of 20 advertiser IDs in the body of the request	Demonstration and call log validation
If requesting for more than 20 locations, these are done in multiple requests	Call log validation

Latitude and longitude location-adjusted (Enhanced)

You can get latitude and longitude location-adjusted vehicle metrics via the Vehicle Metrics API by including an array of latitude and longitude coordinates in the body of the Vehicle Metrics API POST request.

Test	How we'll check it
Able to get latitude and longitude location-adjusted Retail Rating, including up to a maximum of 20 locations in the body of the request	Demonstration and call log validation
If requesting for more than 20 locations, these are done in multiple requests	Call log validation

Price-adjusted days to sell (Enhanced)

You can get the price-adjusted days to sell via the Vehicle Metrics API by including a retail price in the body of the Vehicle Metrics API POST request.

Test	How we'll check it
Able to get price-adjusted days to sell via the Vehicle Metrics API	Demonstration and call log validation
Provide a retail price in the body of the request that is between or equal to 90%-110% of the retail valuation of the vehicle	Demonstration
Optional checks
Provide an array of all features for the vehicle in the body of the request to get the most accurate price-adjusted days to sell	Demonstration

Confidence of sale (Enhanced)

You can get the confidence of sale rating via the Vehicle Metrics API by including the number of days the vehicle has been in stock and an array of target days to sell for the vehicle.

This data should be included in the body of the Vehicle Metrics API POST request to get a successful request.

Test	How we'll check it
Able to get the confidence of sale rating via the Vehicle Metrics API	Demonstration and call log validation
Provide a saleTarget object in the request which should include the vehicle’s current days in stock and an array of target days to sell	Demonstration
Optional checks
Able to include a retail price in the request to retrieve a price-adjusted confidence of sale rating	Demonstration