Virtual Yard API
The Virtual Yard API is intended for web developers or system integrators to incorporate the functions of Virtual Yard into a standalone website.
The API is mainly used to provide stock feeds but can also be used for various other functions to help your business run smoother.
To use the API you must have an API Key which can be purchased in the shop section of the Virtual Yard Software
For testing purposes please contact us and we will provide you with a testing key.
There are many endpoints available to developers to help you integrate Virtual Yard with your project. This documentation should help you get started building something great that benefits your dealership and performs a meaningful task.
If you dont see the endpoints or paramaters you need to make Virtual Yard API work for your project, please contact us and we will find a solution to suit you.
Get vehicles for sale
Provides a JSON list of vehicles for sale by the dealer.
URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=vehicles&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| s | optional | Search term |
| m | optional | Make |
| o | optional | Order by field e.g. make or model or stockNo |
| b | optional | Begin at row e.g. 0 or 10 |
| l | optional | Limit rows e.g. 10 or 100 |
Get a vehicle for sale
Provides a JSON response of a single vehicle that is for sale by the dealer.
URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=vehicle&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| s | required | Stock Number |
Get dealers details
Provides a JSON with the dealers business details.
URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=dealer&key=[apikey]
Get vehicle inspection
Provides a JSON response with the vehicle inspection report.
URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=inspection&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| vehicleID | required | Vehicle ID |
Post vehicle enquiry
Records an enquiry on a vehicle.
URL: https://dealers.virtualyard.co.uk/api/v2/post.php?a=sendenquiry&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| vehicleId | required | Vehicle ID |
| fullname | required | Customers full name |
| required | Customers email address | |
| message | required | Customers message |
| phone | optional | Customers phone number |
Post customer deposit
Records the payment of a deposit on a vehicle.
URL: https://dealers.virtualyard.co.uk/api/v2/post.php?a=senddeposit&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| vehicleId | required | Vehicle ID |
| depositAmount | required | Deposit amount |
| fullname | required | Customers full name |
| required | Customers email address | |
| message | required | Customers message |
| phone | optional | Customers phone number |
Post sell my car
Records an enquiry with an attached vehicle.
URL: https://dealers.virtualyard.co.uk/api/v2/post.php?a=sendsellmycar&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| registrationNo | required | Registration Number |
| fullname | required | Customers full name |
| required | Customers email address | |
| message | required | Customers message |
| phone | optional | Customers phone number |
Post apply finance
Records an enquiry with a request for finance.
URL: https://dealers.virtualyard.co.uk/api/v2/post.php?a=sendapplyfinance&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| vehicleId | required | Vehicle ID |
| fullname | required | Customers full name |
| required | Customers email address | |
| message | required | Customers message |
| phone | optional | Customers phone number |
Post update vehicle
Records updates to an existing vehicle details.
URL: https://dealers.virtualyard.co.uk/api/v2/post.php?a=sendupdatevehicle&key=[apikey]
| Parameter | Required | Description |
|---|---|---|
| vehicleId | required | Vehicle ID |