With the Deal Sync capability on Auto Trader Connect, you will have access to view deals submitted by a consumer using Deal Builder on the Auto Trader website via the API.
Here's a full list of the functionality:
- Deal update notifications
- Baseline deals
- View deals list
- View individual deal
- View deal part exchange
- View deal delivery
- View deal finance application
Deal update notifications
As part of this capability, you will have access to our real-time deal update notifications. Whenever a consumer submits or updates a deal via Deal Builder on the Auto Trader website, you will receive a webhook that sends the updated information to you.
A webhook will be sent for all updates to deals in Auto Trader including:
- Deal creation
- Deal updates
- Updates to any deal components
- Deal cancellation
- Deal completion
When you get the notification and have checked the top-level deal details, you will need to make an API call for each component ID. Do this for each one to check whether there have been any updates to them.
Check out examples of these notifications
Baseline deals
With this capability, you will also be able to access all deals for a given advertiser ID. This will allow you to get a snapshot of a dealer’s deals when you call the Deals API and then be kept up to date with deal update notifications.
The call to the Deals API will need to include the advertiser ID of the dealer you want to baseline deals for, and relevant page and pageSize parameters. This is to make sure you get all the deals.
Deals list view
To see all deals for an dealer, you will need to make a GET request to the Deals API with the advertiser ID of that dealer, page and pageSize in the query string.
Individual deal view
You can also see details for a specific deal by making a GET request to the Deals API with the deal ID of the deal you want to view details for and the advertiser ID that the deal belongs to.
Check out examples of these requests
View deal part exchange
You will be able to view any part exchange details for a deal, if included by the consumer. To see these details, you will need to do a GET request to the Part Exchange API with the part exchange component ID that is in the deal JSON object.
Check out an example of the part exchange details call
View deal delivery
You will also be able to view any delivery details for a deal, if included by the consumer. To see these details, you will need to do a GET request to the Delivery API with the delivery component ID that is in the deal JSON object.
Check out an example of the delivery details call
View deal finance application
You will also be able to view any finance application details for a deal, if included by the consumer. To see these details, you will need to do a GET request to the Finance Application API with the finance application component ID that is in the deal JSON object.
Check out an example of the finance application details call
Error Handling
When using the APIs above, you may get error response codes that you need to handle. This makes sure you have a smooth service for both you, as a partner, and your end user.