Vehicles API

This page includes all endpoints available for the vehicles module.

The vehicle API offers the following endpoints:

Add Vehicle
Edit Vehicle
Fetch Vehicle

Add Vehicle

This endpoint allows you to add a vehicle to your inventory

Endpoint: /_admin/_api/lead/add-vehicle.php

Request type: POST

Request Data:

Item	Description	Type	Options
[‘key’]*	Your API Key	(string)
[‘vehicle’][‘year’]*	Vehicle Yeaar	(integer)
[‘vehicle’][‘make’]*	Vehicle Make	(string)
[‘vehicle’][‘model’]*	Vehicle Model	(string)
[‘vehicle’][‘vin’]	Vehicle VIN	(string)
[‘vehicle’][‘vehicle_type’]	Vehicle Type	(string)
[‘vehicle’][‘stock_number’]	Stock Number	(string)
[‘vehicle’][‘trim’]	Vehicle Trim	(string)
[‘vehicle’][‘series’]	Vehicle Series	(string)
[‘vehicle’][‘vehicle_condition’]	Vehicle Condition	(string)	[new,used]
[‘vehicle’][‘mileage’]	Mileage	(integer)
[‘vehicle’][‘mileage_unit’]	Mileage Unit	(string)	[Km/Mi/Hrs]
[‘vehicle’][‘transmission’]	Transmission	(string)	[automatic, manual]
[‘vehicle’][‘drivetrain’]	Drivetrain	(string)	[4×4,FWD,RWD,AWD]
[‘vehicle’][‘doors’]	Number of Doors	(integer)
[‘vehicle’][‘passengers’]	Number of Passengers	(integer)
[‘vehicle’][‘description’]	English Vehicle Description	(text)
[‘vehicle’][‘description_fr’]	French Vehicle Description	(text)
[‘vehicle’][‘body’]	Vehicle Body	(string)	[coupe,convertible,crossover,hatchback,other,pickup,sedan,suv,van,wagon]
[‘vehicle’][‘purchase_date’]	Purchase Date	(date)[yyyy-mm-dd]
[‘vehicle’][‘purchase_price’]	Purchase Price excluding taxes	(decimal)
[‘vehicle’][‘purchase_tax1’]	Purchase Tax 1 Amount	(decimal)
[‘vehicle’][‘purchase_tax2’]	Purchase Tax 2 Amount	(decimal)
[‘vehicle’][‘sticker_price’]	Vehicle Sticker Price	(decimal)
[‘vehicle’][‘sale_price’]	Discounted Vehicle Price	(decimal)
[‘vehicle’][‘minimum_price’]	Minimum Vehicle Sale Price (internal)	(decimal)
[‘vehicle’][‘fuel’]	Fuel Type	(string)	[Diesel,Electric,Gasoline,Hybrid]
[‘vehicle’][‘color’]	Exterior Vehicle Color	(string)
[‘vehicle’][‘interior_color’]	Interior Vehicle Color	(string)
[‘vehicle’][‘engine’]	Engine	(string)
[‘vehicle’][‘horsepower’]	Horsepower	(integer)
[‘vehicle’][‘floorplan’]	Floor Plan	(integer)	[0,1]

Response:

Item	Description	Type
success		boolean
errors	List of errors	array
data	Retruned Data	array
message	Message	string

Edit Vehicle

This endpoint allows you to modify an existing vehicle using the vehicle’s unique ID

Endpoint: /_admin/_api/lead/edit-vehicle.php

Request type: POST

Request Data:

Item	Description	Type	Options
[‘key’]*	Your API Key	(string)
[‘vehicle’][‘id’]*	Vehicle ID	(integer)
[‘vehicle’][‘year’]	Vehicle Year	(integer)
[‘vehicle’][‘make’]	Vehicle Make	(string)
[‘vehicle’][‘model’]	Vehicle Model	(string)
[‘vehicle’][‘vin’]	Vehicle VIN	(string)
[‘vehicle’][‘vehicle_type’]	Vehicle Type	(string)
[‘vehicle’][‘stock_number’]	Stock Number	(string)
[‘vehicle’][‘trim’]	Vehicle Trim	(string)
[‘vehicle’][‘series’]	Vehicle Series	(string)
[‘vehicle’][‘vehicle_condition’]	Vehicle Condition	(string)	[new,used]
[‘vehicle’][‘mileage’]	Mileage	(integer)
[‘vehicle’][‘mileage_unit’]	Mileage Unit	(string)	[Km/Mi/Hrs]
[‘vehicle’][‘transmission’]	Transmission	(string)	[automatic, manual]
[‘vehicle’][‘drivetrain’]	Drivetrain	(string)	[4×4,FWD,RWD,AWD]
[‘vehicle’][‘doors’]	Number of Doors	(integer)
[‘vehicle’][‘passengers’]	Number of Passengers	(integer)
[‘vehicle’][‘description’]	English Vehicle Description	(text)
[‘vehicle’][‘description_fr’]	French Vehicle Description	(text)
[‘vehicle’][‘body’]	Vehicle Body	(string)	[coupe,convertible,crossover,hatchback,other,pickup,sedan,suv,van,wagon]
[‘vehicle’][‘purchase_date’]	Purchase Date	(date)[yyyy-mm-dd]
[‘vehicle’][‘purchase_price’]	Purchase Price excluding taxes	(decimal)
[‘vehicle’][‘purchase_tax1’]	Purchase Tax 1 Amount	(decimal)
[‘vehicle’][‘purchase_tax2’]	Purchase Tax 2 Amount	(decimal)
[‘vehicle’][‘sticker_price’]	Vehicle Sticker Price	(decimal)
[‘vehicle’][‘sale_price’]	Discounted Vehicle Price	(decimal)
[‘vehicle’][‘minimum_price’]	Minimum Vehicle Sale Price (internal)	(decimal)
[‘vehicle’][‘fuel’]	Fuel Type	(string)	[Diesel,Electric,Gasoline,Hybrid]
[‘vehicle’][‘color’]	Exterior Vehicle Color	(string)
[‘vehicle’][‘interior_color’]	Interior Vehicle Color	(string)
[‘vehicle’][‘engine’]	Engine	(string)
[‘vehicle’][‘horsepower’]	Horsepower	(integer)
[‘vehicle’][‘floorplan’]	Floor Plan	(integer)	[0,1]

Response:

Item	Description	Type
success		boolean
errors	List of errors	array
data	Retruned Data	array
message	Message	string

Fetch Vehicle

This endpoint allows you to fetch the data for a given vehicle using the unique vehicle ID

Endpoint: /_admin/_api/lead/fetch-vehicle.php

Request type: POST

Request Data:

Item	Description	Type	Options
[‘key’]*	Your API Key	(string)
[‘id’]*	Vehicle ID	(integer)

Response:

Item	Description	Type
success		boolean
errors	List of errors	array
data	Retruned Data	array
message	Message	string