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:
- Deal updates (Essential)
-
- Mark a deal as complete (Essential)
- Mark a deal as cancelled (Essential)
- Reserve through a deal (Essential)
-
- Removing components (Essential)
-
- Removing part exchange (Essential)
- Removing finance (Essential)
-
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
Deal updates (Essential)
When updating a deal via the Deals API, at a minimum, you will need to make sure you are passing:
- The advertiser ID that the request is on behalf of
- The deal ID that you are updating.
You'll be able to update the advertiser deal status and the reservation status of a deal using a PATCH request.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the baseline deals functionality in the Deal Sync capability Go Live checks |
Mark a deal as complete (Essential)
You can mark a deal as complete via the Deals API by setting the advertiserDealStatus to 'complete' in the body of the Deals API PATCH request.
| Test | How we'll check it |
|
Able to update the advertiserDealStatus to Complete via the Deals API |
Demonstration and call log validation |
Mark a deal as cancelled (Essential)
You can mark a deal as cancelled via the Deals API by setting the advertiserDealStatus to 'cancelled' in the body of the Deals API PATCH request.
You will also need to include the advertiserCancellationReason and can optionally include advertiserCancellationNotes in the body of your request.
| Test | How we'll check it |
| Able to update the advertiserDealStatus to Complete via the Deals API | Demonstration, call log validation, and database check |
| Able to provide a valid advertiserCancellationReason in the body of the request - a full list of valid values can be found in our API Developer Documention | Demonstration and database check |
| Optional checks | |
| Able to provide advertiserCancellationNotes in the body of the request | Demonstration and database check |
Reserve through a deal (Essential)
You can reserve a vehicle for the specified deal ID via the Deals API by including the reservationStatus in the body of the Deals API PATCH request.
| Test | How we'll check it |
| Able to update the reservation status of a stock item via the Deals API | Demonstration, call log validation, and database check |
| When a 403 response is received due to a failed reservation, this needs to be raised to the user that they cannot reserve the vehicle | Demonstration |
Removing components (Essential)
You can remove part exchange and finance components of a Deal via the Deals API by using a PATCH request. As a minimum, you will need to make sure you are passing:
- The advertiser ID that the request is on behalf of
- The deal ID that you are updating
Removing part exchange (Essential)
You can remove the part exchange component of a deal via the Deals API. This can be done by setting the partExchange attribute to null in the body of the Deals API PATCH request.
| Test | How we'll check it |
|
Able to remove the part exchange component of a deal via the Deals API |
Demonstration, call log validation, and database check |
Removing finance (Essential)
You can remove the part exchange component of a deal via the Deals API. This can be done by setting the financeApplication attribute to null in the body of the Deals API PATCH request.
| Test | How we'll check it |
|
Able to remove the finance application component of a deal via the Deals API |
Demonstration, call log validation, and database check |