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:
-
Update reservation status (Essential)
-
Manage lifecycle state (Essential)
-
Unpublishing advert locations (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
Update reservation status (Essential)
If you would like to update the reservation status of a stock record, send a PATCH request to the Stock API with the stock ID included in the request path and reservationStatus set to 'Reserved' in the request body.
| Test | How we'll check it |
| Able to update the reservationStatus to 'Reserved' via the Stock API | Demonstration and database check |
| Able to update the lifecycleState to SALE_IN_PROGRESS when reserving a stock item | Demonstration and database check |
| Able to update the reservationStatus to null when a reservation is cancelled via the Stock API | Demonstration and database check |
| Optional checks | |
|
Able to set any advertising locations you no longer want the stock record to appear on to NOT_PUBLISHED when a vehicle is reserved |
Demonstration and database check |
|
If you receive a 400 error response due to a present reservationDealId, do not retry the call |
Demonstration and call log validation |
Manage lifecycle state (Essential)
If you would like to update the lifecycle state of a stock record, send a PATCH request to the Stock API with the stock ID included in the request path and lifecycleState set in the request body.
| Test | How we'll check it |
| Able to update the lifecycleState of a stock record via the Stock API | Call log validation and database check |
| Optional checks | |
|
Able to unpublish all advert locations if lifecycleState is set to SOLD, DELETED, or WASTEBIN |
Database check |
Unpublishing advert locations (Enhanced)
If you would like to unpublish advert locations for a stock record, send a PATCH request to the Stock API with:
- The stock ID included in the request path
- The locations you would like to unpublish set to NOT_PUBLISHED in the request body
| Test | How we'll check it |
|
Able to manage all advertising destinations, setting to NOT_PUBLISHED where relevant
|
Demonstration and database check |