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 valuations (Essential)
- In-stock valuations (Essential)
- Adjusted valuations (Enhanced)
-
- Condition-adjusted valuation (Enhanced)
- Feature-adjusted valuation (Enhanced)
- Expected price indicator rating (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 valuations (Essential)
When looking up a vehicle’s valuation via the Vehicles API, you will need to make sure that your request includes:
- The advertiser ID that the lookup is for
- The registration that you are doing a lookup for
- The odometerReadingMiles parameter with the mileage of the vehicle
- The valuations=true parameter
Most of our vehicle data that’s available in production will be available in sandbox for you to test with. But, newer vehicles and recent plate changes may not be.
| 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 current valuation of a vehicle via the Vehicles API for at least one of the following markets. This should only be used for vehicles not in your stock:
|
Call log validation |
|
Request is included within your initial Vehicle API request. This should not be done in a second call. |
Demonstration |
|
Able to handle a 200 response with null valuations, and present a message back to the user |
Demonstration |
|
Calls should be completed once per day, as valuations are only updated daily |
Demonstration and call log validation |
| Optional checks | |
|
If you are getting a part-exchange valuation, you will need to provide basic vehicle information (e.g. make, model, and derivative) to the user to validate and confirm |
Demonstration |
|
If you are looking to store the valuation data you've got, this should be stored with a date and time attached |
Demonstration |
In-stock valuations (Essential)
If you would like to get both the market average and adjusted current valuation for a vehicle in your stock, include the valuations=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 current valuation of a vehicle via the Stock API for at least one of the following markets:
|
Call log validation |
|
Able to handle a 200 response with null valuations, and present a message back to the user |
Demonstration |
|
Calls should be completed once per day, as valuations are only updated daily |
Demonstration |
|
Only request for a new valuation for a stock record on the same day if the derivative ID or features of a stock record have been changed |
Demonstration and call log validation |
| Optional Checks | |
|
If you are looking to store the valuation data you've got, this should be stored with a date and time attached |
Demonstration |
Adjusted valuations (Enhanced)
If you would like to get adjusted valuations or a predicted price indicator rating for a vehicle and price point, use the Valuations API.
As a minimum, you will need to include:
- The derivative ID of the vehicle you are doing the request on behalf of
- The first registration date
- The odometer reading miles in the body of your POST request
| Test | How we'll check it |
|
Able to get the current valuation of a vehicle via the Valuations API for at least one of the following markets:
|
Call log validation |
|
All adjustments for the valuation you are requesting are done in one request and not multiple |
Call log validation |
|
Able to handle a 200 response with null valuations, and present a message back to the user |
Demonstration |
|
Calls should be completed once per day, as valuations 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 are looking to store the valuation data retrieved, this should be stored with a date and time attached |
Demonstration |
Condition-adjusted valuation (Enhanced)
You can get a condition-adjusted valuation via the Valuations API by including the condition rating in the body of the Valuations API POST request. You can use the following condition ratings:
- Excellent
- Great
- Good
- Fair
- Poor
| Test | How we'll check it |
| Able to get a condition-adjusted valuation via the Valuations API with a valid condition rating | Demonstration and call log validation |
| Optional checks | |
|
Able to dynamically change the condition rating and use all five condition ratings |
Demonstration and call log validation |
Feature-adjusted valuation (Enhanced)
You can get a feature-adjusted valuation via the Valuations API by including a full list of standard and optional features of the vehicle in the body of the Valuations API POST request.
| Test | How we'll check it |
| Able to get a feature-adjusted valuation via the Valuations API | Demonstration and call log validation |
| All features provided in the request, including both standard and optional | Demonstration |
Expected price indicator rating (Enhanced)
You can get a vehicle's expected price indicator rating via the Valuations API by including a retail price you want to list the vehicle at in the body of the Valuations API POST request.
| Test | How we'll check it |
| Able to get an expected price indicator rating via the Valuations API | Demonstration and call log validation |
| Optional checks | |
|
Include standard and optional features to get a more accurate expected price indicator rating |
Demonstration |
|
Able to dynamically change the retail price in the request and get a new expected price indicator rating |
Demonstration and call log validation |