Get Vehicles
This endpoint provides a practical set of parameters to tailor your query. You can filter vehicles based on various criteria such as vehicle id, customer id, vehicle year, vehicle make, vehicle model, vehicle vin number, and vehicle engine. Additionally, you can include related data such as customer information, vehicle notes, repair roders and vehicle labels. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the vehicle data.
query Parameters
with_detailsbooleanInclude extra details in the response. This will add customer, vehicle notes, repair orders and vehicle labels to every quotes.
Include extra details in the response. This will add customer, vehicle notes, repair orders and vehicle labels to every quotes.
Example: nullsortstringSort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -make. Sortable field: year, make, model.
Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -make. Sortable field: customer, year, make, vin and engine.
Example: nullvehicle_idintegerFilter by vehicle id.
Filter by vehicle id.
Example: nullfilter[customer_id]integerFilter by vehicle customer id.
Filter by vehicle customer id.
Example: 4filter[year]stringFilter by vehicle year.
Filter by vehicle year.
Example: nullfilter[make]stringFilter by vehicle make.
Filter by vehicle make.
Example: nullfilter[model]stringFilter by vehicle model.
Filter by vehicle model.
Example: nullfilter[vin]stringFilter by vehicle vin.
Filter by vehicle vin.
Example: nullpagestringPage number to return.
Page number to return.
Example: 1pageSizestringNumber of items to return in a page. Defaults to 10.
Number of items to return in a page. Defaults to 10.
Example: null
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
dataobject[] · requiredlinksobject · requiredmetaobject · required
Create Vehicle
You can create a new Vehicle from here.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
customer_idnumber · requiredyearinteger | string · requiredExample: 2023makestring · requiredExample: Volkswagenmodelstring · requiredExample: Jettatypestring · requiredExample: SE
vinstringExample: 123456789123456license_numberstringExample: 123ASDFlicense_statestringExample: Utahfleet_numberstringThis maps to Tire Guru's vehicle unit number
Example: 123colorstringExample: Whiteaces_idstring
Responses
vehicle_idnumber · requiredcustomer_idnumber · requiredyearinteger | string · requiredExample: 2023makestring · requiredExample: Volkswagenmodelstring · requiredExample: Jettatypestring · requiredExample: SE
vinstringExample: 123456789123456license_numberstringExample: 123ASDFlicense_statestringExample: Utahfleet_numberstringThis maps to Tire Guru's vehicle unit number
Example: 123colorstringExample: Whiteaces_idstring
Update Vehicle
Update an existing Vehicle from here.
path Parameters
VehIDstring · required
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
customer_idnumber · requiredyearinteger | string · requiredExample: 2023makestring · requiredExample: Volkswagenmodelstring · requiredExample: Jettatypestring · requiredExample: SE
vinstringExample: 123456789123456license_numberstringExample: 123ASDFlicense_statestringExample: Utahfleet_numberstringThis maps to Tire Guru's vehicle unit number
Example: 123colorstringExample: Whiteaces_idstring
Responses
vehicle_idnumber · requiredcustomer_idnumber · requiredyearinteger | string · requiredExample: 2023makestring · requiredExample: Volkswagenmodelstring · requiredExample: Jettatypestring · requiredExample: SE
vinstringExample: 123456789123456license_numberstringExample: 123ASDFlicense_statestringExample: Utahfleet_numberstringThis maps to Tire Guru's vehicle unit number
Example: 123colorstringExample: Whiteaces_idstring
