Returns a paginated list of Vehicle objects associated with a dealership
| Time |
Status |
User Agent |
|
| Make a request to see history. |
|
|
|
URL Expired
The URL for this request expired after 30 days.
API Parameters
| Parameter |
Type |
Description |
| id |
integer |
The id of the dealership (required) |
| sort |
string |
The sort order for each sort field MUST be ascending unless prefixed with a minus (-), in which case it MUST be descending. |
| created_at |
string |
Creation timestamp |
| updated_at |
string |
Last updated timestamp |
| license |
string |
License plate of the vehicle |
| model |
string |
Vehicle model |
| odometer |
object |
Odometer details |
| physical_location |
string |
Physical location of the vehicle |
| status |
string |
Filter vehicles based on their current state |
| stock_number |
string |
Stock number of the vehicle |
| year |
integer |
Manufacturing year |
| vin |
string |
Vehicle Identification Number |
| maturity_date |
date |
Maturity date of the vehicle |
| in_service_date |
date |
In service date of the vehicle |
| rdr_date |
date |
Retail delivery report date |
| fleet_ids |
array of integers |
Filter vehicles results to those that belong to these fleet ids |
| active |
boolean |
Filter vehicles to either active or inactive |
| telematics_state |
string |
Filter vehicles based on their telematics source |
| maturity_date_from |
date |
Filter vehicles with maturity_date greater than or equal to this date (YYYY-MM-DD format) |
| maturity_date_to |
date |
Filter vehicles with maturity_date less than or equal to this date (YYYY-MM-DD format) |
| in_service_date_from |
date |
Filter vehicles with in_service_date greater than or equal to this date (YYYY-MM-DD format) |
| in_service_date_to |
date |
Filter vehicles with in_service_date less than or equal to this date (YYYY-MM-DD format) |
| rdr_date_from |
date |
Filter vehicles with parking lot rdr_date greater than or equal to this date (YYYY-MM-DD format) |
| rdr_date_to |
date |
Filter vehicles with parking lot rdr_date less than or equal to this date (YYYY-MM-DD format) |
| page |
number |
The page to be fetched, by default 1 |
| per_page |
number |
Number of items per page to be fetched, by default 30 |
| api-version |
integer |
Target API version (required) |
| accept |
string |
Set to the response content types (default application/json) |
Sample Response
HTTP Status Codes
200 - Success
401 - Unauthorized
403 - Forbidden
404 - Not found
406 - Not Acceptable
Example CURL Request
curl --request GET \
--url https://api.dealerware.com/admin/dealerships/id/vehicles \
--header 'accept: application/json'
Example JSON Response
[
{
"connected": true,
"connected_car_device_firmware": "281110619:159:11",
"connected_car_device_last_updated": "2020-06-11T15:08:53Z",
"device": "guidepoint",
"fuel": {
"unit": "L",
"capacity": 20,
"value": 10
},
"id": 23561,
"license": "DNL445",
"links": {
"fleet": {
"id": 2,
"href": "https://api.dw-tst.com/admin/some_resources/2"
},
"fleet_ids": [
123,
125
],
"fleets": [
{
"id": 2,
"href": "https://api.dw-tst.com/admin/some_resources/2"
}
]
},
"make": "Audi",
"model": "Q5",
"color": "Silver",
"odometer": {
"value": 3293.5,
"unit": "km"
},
"off_lot": true,
"physical_location": "Lot A",
"power_train": "mechanical",
"status": "rented",
"stock_number": "VV111",
"telematics_source": "guidepoint",
"telematics_enrolled": true,
"toll_tag_number": "HMSJNFDS",
"vin": "1FT7W2BT4DEB5192",
"year": 2020,
"acriss_code": "CFAR",
"acriss_model_description": "Compact SUV Automatic With AC",
"updated_at": "2025-03-20T17:42:42Z",
"created_at": "2025-03-20T17:42:42Z",
"days_off_contract": 7,
"rdr_date": "2024-03-15",
"maturity_date": "2024-06-15",
"disposed_at": "2024-06-15",
"in_service_date": "2026-07-28",
"currently_rented_to_customer_id": 1789
}
]