get
/
Resource Details
|
Security |
|
|---|---|
|
Category |
Merchandisable vehicle |
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| page | number | A non-zero integer representing the page of the results | No |
| pageSize | number | A non-negative, non-zero integer indicating the maximum number of results to return at one time | No |
| sort | string | Sort the results into a particular order. Takes the form sort=key1:asc. Keys are make, model, modelYear, price, mileage. E.g. sort=price:desc | No |
| latitude | number | Current location latitude as defined by ISO 6709 standard. E.g. latitude=36.131128 | No |
| longitude | number | Current location longitude as defined by ISO 6709 standard. E.g. longitude=-115.151119 | No |
| radius | integer | The radius from the current location. E.g. radius=10 | No |
| radiusUnits | string | The radius from the current location. E.g. radiusUnits=MILES | No |
| type | string | The type of vehicle (new, used or certified). E.g. type=USED | No |
| make | string | The make, franchise or brand description of the vehicle. E.g. make=Ford | No |
| model | string | The model description of the vehicle. E.g. model=Explorer | No |
| variant | string | The description of the variant, sub-model, trim or style of the vehicle | No |
| makeCode | string | The make, franchise or brand code of the vehicle. E.g. makeCode=FORD | No |
| modelCode | string | The model code of the vehicle. E.g. modelCode=EXPLORER | No |
| variantCode | string | The variant, sub-model, trim or style code of the vehicle | No |
| modelYear | string | The model year assigned to this vehicle. This is assigned by the manufacturer and it not necessarily the year of build, but the year of model release | No |
| exteriorColor | string | Description of the color of the vehicle's exterior. This may include the finish (e.g. Metallic) | No |
| interiorColor | string | Description of the color of the vehicle's interior. This may include the fabric (e.g. Leather) | No |
| feature | string | Description of the feature of the vehicle e.g. Heated Front Seats | No |
| minPrice | integer | The minimum price of the vehicle. E.g. minPrice=10000 | No |
| maxPrice | integer | The maximum price of the vehicle. E.g. maxPrice=20000 | No |
| minPayment | integer | The minimum monthly payment of the vehicle. E.g. minPayment=400 | No |
| maxPayment | integer | The maximum monthly payment of the vehicle. E.g. maxPayment=500 | No |
| minMileage | integer | The minimum mileage of the vehicle. E.g. minMileage=5000 | No |
| maxMileage | integer | The maximum mileage of the vehicle. E.g. maxMileage=25000 | No |
| mileageUnits | string | The units for the mileage of the vehicle. E.g. mileageUnits=MILES | No |
| minEconomy | integer | The minimum economy figure for the vehicle E.g. minEconomy=25 | No |
| maxEconomy | integer | The maximum economy figure for the vehicle E.g. minEconomy=35 | No |
| fuelType | string | The fuel type of the vehicle. E.g. fuelType=GASOLINE | No |
| bodyType | string | The body type of the vehicle. E.g. bodyType=SUV | No |
| transmissionType | string | The transmission type of the vehicle. E.g. transmissionType=AUTO | No |
| drivetrainType | string | The drivetrain of the vehicle. E.g. drivetrainType=AWD | No |
| cylinders | string | The number of cylinders used by the engine | No |
| vehicleUse | string | The vehicle usage (Unknown, RENTAL). E.g. vehicleUse=UNKNOWN | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Accept | string | n/a | No |
| Accept-Charset | string | n/a | No |
| Accept-Language | string | n/a | No |
| Prefer | string | n/a | No |
| Request-Id | string | n/a | No |
| If-Match | string | n/a | No |
| If-None-Match | string | n/a | No |
| Subscription-Id | string | The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. | Yes |
| Authorization | string | Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. | Yes |
Request Body Structure
Request Body Example
Response
Response Body Structure
Response Body Example
Response Error Details
| HTTP Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Not Found |
| 404 | Not Found |
Try It Out
-
page
(number) A non-zero integer representing the page of the results
-
pageSize
(number) A non-negative, non-zero integer indicating the maximum number of results to return at one time
-
sort
(string) Sort the results into a particular order. Takes the form sort=key1:asc. Keys are make, model, modelYear, price, mileage. E.g. sort=price:desc
-
latitude
(number) Current location latitude as defined by ISO 6709 standard. E.g. latitude=36.131128
-
longitude
(number) Current location longitude as defined by ISO 6709 standard. E.g. longitude=-115.151119
-
radius
(integer) The radius from the current location. E.g. radius=10
-
radiusUnits
(string) The radius from the current location. E.g. radiusUnits=MILES
-
type
(string) The type of vehicle (new, used or certified). E.g. type=USED
-
make
(string) The make, franchise or brand description of the vehicle. E.g. make=Ford
-
model
(string) The model description of the vehicle. E.g. model=Explorer
-
variant
(string) The description of the variant, sub-model, trim or style of the vehicle
-
makeCode
(string) The make, franchise or brand code of the vehicle. E.g. makeCode=FORD
-
modelCode
(string) The model code of the vehicle. E.g. modelCode=EXPLORER
-
variantCode
(string) The variant, sub-model, trim or style code of the vehicle
-
modelYear
(string) The model year assigned to this vehicle. This is assigned by the manufacturer and it not necessarily the year of build, but the year of model release
-
exteriorColor
(string) Description of the color of the vehicle's exterior. This may include the finish (e.g. Metallic)
-
interiorColor
(string) Description of the color of the vehicle's interior. This may include the fabric (e.g. Leather)
-
feature
(string) Description of the feature of the vehicle e.g. Heated Front Seats
-
minPrice
(integer) The minimum price of the vehicle. E.g. minPrice=10000
-
maxPrice
(integer) The maximum price of the vehicle. E.g. maxPrice=20000
-
minPayment
(integer) The minimum monthly payment of the vehicle. E.g. minPayment=400
-
maxPayment
(integer) The maximum monthly payment of the vehicle. E.g. maxPayment=500
-
minMileage
(integer) The minimum mileage of the vehicle. E.g. minMileage=5000
-
maxMileage
(integer) The maximum mileage of the vehicle. E.g. maxMileage=25000
-
mileageUnits
(string) The units for the mileage of the vehicle. E.g. mileageUnits=MILES
-
minEconomy
(integer) The minimum economy figure for the vehicle E.g. minEconomy=25
-
maxEconomy
(integer) The maximum economy figure for the vehicle E.g. minEconomy=35
-
fuelType
(string) The fuel type of the vehicle. E.g. fuelType=GASOLINE
-
bodyType
(string) The body type of the vehicle. E.g. bodyType=SUV
-
transmissionType
(string) The transmission type of the vehicle. E.g. transmissionType=AUTO
-
drivetrainType
(string) The drivetrain of the vehicle. E.g. drivetrainType=AWD
-
cylinders
(string) The number of cylinders used by the engine
-
vehicleUse
(string) The vehicle usage (Unknown, RENTAL). E.g. vehicleUse=UNKNOWN
-
Accept
(string)
-
Accept-Charset
(string)
-
Accept-Language
(string)
-
Prefer
(string)
-
Request-Id
(string)
-
If-Match
(string)
-
If-None-Match
(string)
-
Subscription-Id
(required)(string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.
-
Authorization
(required)(string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.
Working...