logo

Main features

The Virtual Yard API is intended for web developers or system integrators to help automate regular tasks that a dealer using our system may need. To use the API you must have an API Key which the dealer you are building your integration for can provide you. A dealer must be on the Medium plan or above to use the API.

For testing purposes you can use this Demo API Key: yjuHKcKMN6BerjWtTCQsoGY93lJT0llauSWaRC5cuB0zooITdhiMp1Kf3XON841OAxFWblqWc9tMwPKzgkRNrTHyo

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 dealer and performs a meaningful task.

Get vehicles for sale

Provides a JSON list of vehicles for sale for the dealer.

Get a vehicle for sale

Provides a JSON response of a single vehicle that is for sale by the dealer.

Get the dealers details

Provides a JSON response witht the dealers details.

Get vehicle inspection

Provides a JSON list of a vehicles inspection report.

Post vehicle enquiry

Allows you to record an enquiry on a vehicle for the dealer to see in Virtual Yard.

Post customer deposit

Allows you to receive a deposit on a vehicle.

Post sell my car

Allows you to receive an enquiry with a vehicle attached.

Post apply finance

Allows you to receive an enquiry with a request for finance.

Post update vehicle

Allows you to update an existing vehicles details.

Website API

Allows you to build a website that the dealer can manage from within Virtual Yard.

Download some source code

We've built a few examples for you to use to help get you started integrating Virtual Yard with your project. All examples are PHP based and free to use for your own or commercial purposes.

Website API

Within Virtual Yard we have an area where a dealer can manage the pages and blocks on his website. If you use this Website API your dealer will be able to make changes to their website from within Virtual Yard and the changes will be relected automatically in the website you build using this Website API.

Download Website API

Get vehicles for sale

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

URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=vehicle&key=[apikey]

Parameter Required Description
s required Stock Number

Get dealers details

URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=dealer&key=[apikey]

Get vehicles inspection

URL: https://dealers.virtualyard.co.uk/api/v2/get.php?a=inspection&key=[apikey]

Parameter Required Description
s required Vehicle ID

Get vehicle enquiry

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
email required Customers email address
message required Customers message
phone optional Customers phone number