Query Merchandisable Vehicles

get

/

Query merchandisable vehicles

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,key2:desc,key3:asc. Keys are make, model, modelYear, price, mileage. E.g. sort=price:desc,make:asc,model:asc 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 or used). 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
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
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
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

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
apikey string Sign up and create a solution to get an API key! To try sample requests, use your solutions's apikey and the Subscription-Id 'test'. No
Subscription-Id string The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test' and your solution's apikey. Yes
Authorization string Credentials to access live APIs using an OAuth 2.0 flow. Yes

Request Body Structure

Expand All
Collapse All

Request Body Example

Response

Response Body Structure

Expand All
Collapse All

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,key2:desc,key3:asc. Keys are make, model, modelYear, price, mileage. E.g. sort=price:desc,make:asc,model:asc

  • 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 or used). 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

  • 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

  • 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

  • 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

  • Accept

    (string)

  • Accept-Charset

    (string)

  • Accept-Language

    (string)

  • Prefer

    (string)

  • Request-Id

    (string)

  • If-Match

    (string)

  • If-None-Match

    (string)

  • apikey

    (string) Sign up and create a solution to get an API key! To try sample requests, use your solutions's apikey and the Subscription-Id 'test'.

  • Subscription-Id
    (required)

    (string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test' and your solution's apikey.

  • Authorization
    (required)

    (string) Credentials to access live APIs using an OAuth 2.0 flow.

Reset

Make a request and see the request.

Make a request and see the response.

Make a request and see the cURL.

Working...

x