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:
- Add part exchange (Essential)
- Update part exchange (Essential)
-
- Update condition (Essential)
- Update outstanding finance (Essential)
- Update offer (Essential)
-
For each check, there will be three ways that we will validate the check is passed:
- 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
Add part exchange (Essential)
To add a part exchange to a deal, send a POST request to the Part Exchange API with:
- The advertiser ID of the advertiser the deal is associated with
- Initial details of the part-exchange vehicle the consumer would like to add
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Baseline deals functionality in the Deal Sync capability Go Live checks |
|
| Able to add a part-exchange vehicle to a deal by including a registration and mileage | Demonstration and call log validation |
| Where relevant, able to add outstanding finance remaining on the vehicle. Including calling settlement lenders endpoint to get valid finance lenders. | Demonstration and call log validation |
| Optional checks | |
| Able to add in the advertiser offer | Demonstration and call log validation |
| Able to add in the advertiser condition rating | Demonstration and call log validation |
Update part exchange (Essential)
To update details on the part-exchange vehicle, you must send a PATCH request to the Part Exchange API, with the part exchange component ID and advertiser ID in the URL.
Update condition (Essential)
To update a vehicle's assessed condition, you should include the conditionRating attribute in your PATCH with a valid condition rating value. You can use the following condition ratings:
- Excellent
- Great
- Good
- Fair
- Poor
| Test | How we'll check it |
| Able to update the advertiser condition of the part exchange | Demonstration and call log validation |
Update outstanding finance (Essential)
To update a vehicle's assessed condition, you should include the outstandingFinance object in your PATCH with the value of the outstanding finance and the lender the finance agreement is with.
| Test | How we'll check it |
| Call settlement lenders endpoint for all valid finance lender values | Demonstration and call log validation |
| Able to update the outstanding finance of the part exchange, including a valid lender value | Demonstration and call log validation |
Update offer (Essential)
To update a vehicle's assessed condition, you should include the offer object in your PATCH with the value of the offer the advertiser has made for the vehicle.
| Test | How we'll check it |
| Able to update the advertiser offer of the part exchange | Demonstration and call log validation |