APIs
Payment
ePayments
Payment Settling
DevDay
Lead Disposition
Sales Leads API
ELead Service Appointment Schedule Availability
Vehicle Duty Cycle
CSI
Vehicle Sales
Deal Creation Quotes API
Deal Creation Quotes API v2
Calculate Payments API
CDKDrive Customer API
Merchandisable Vehicles API
Sales Vehicle Specifications API
Deals API
Vehicle Service
Appointment API
Service Pricing API
Scheduling API
Safety Recalls API
Service Vehicle Specifications API
Vehicles API
Customers API
Dealership Labor Pricing API
Dealership Customizations API
Parts Pricing API
Parts Groups API
Consumption Metrics API
CDKDrive OpCodes
CDKDrive Repair Orders
CDKDrive Service Vehicles
CRM
CDK CRM Lead Search API
Vehicle Media
Cartender Model Video API
Set Admin Credentials...
Merchandisable Vehicles Search

get

/v2/vehicles/search

Search and Sort Merchandisable Vehicles

Resource URL

cURL

Resource Details

Security

Category

Search - controller

Request

Path Parameters

Parameter Type Description Required

Query Parameters

Parameter Type Description Required
bodyColor string Vehicle exterior color. No
bodyStyle string n/a No
bodyStyleClassification string n/a No
bodyType string 'CAR', 'TRUCK', 'SUV', 'VAN', 'WAGON', 'CARGO VAN', 'COMMERCIAL VEHICLE'. No
coordinates string geo coordinates[lat,lon] parameter separated by ',' for eg. 48,-89 read as 'lat=48 and lon=-89'. No
csStoreId string required only if any of the above or below parameters are not specified No
cylinders string n/a No
dealerType string n/a No
displacement string n/a No
displayableInventoryStatus string 'In Stock' , 'In Transit' , 'Hold', 'On Order'. No
displayableStoreId string required only if any of the above or below parameters are not specified No
drivetrain string n/a No
engine string n/a No
fields string Partial response field filter. No
fuelType string 'Diesel', 'Electric', 'Ethanol', 'Flexible Fuel', 'Gas', 'Hybrid', 'Methanol', 'Compressed Natural Gas', 'Propane'. No
groups string This is a group identifier for aggregated inventory search. Groups are managed by Group Service, required only if any of the above or below parameters are not specified No
id string required only if any of the above or below parameters are not specified No
interiorColor string n/a No
limit string Optional number of search results to return. Default is 10. No
locale string should be combined with any of the other params above or below No
location string n/a No
lotAgeRange string range parameter separated by ':' for eg. 50:250 read as 'between 50 and 250'. No
make string n/a No
marketable string true or false No
maxLotAge string n/a No
maxMileage string n/a No
maxMpg string n/a No
maxPrice string n/a No
maxSavings string n/a No
maxYear string n/a No
merchandisablePaymentRange string range parameter seperated by : for payment range No
merchandisablePaymentType string FINANCE or LEASE, always used in combination with merchandisablePaymentRange No
mileageRange string range parameter separated by ':' for eg. 10000:50000 read as 'between 10000 and 50000'. No
minLotAge string n/a No
minMileage string n/a No
minMpg string n/a No
minPrice string n/a No
minSavings string n/a No
minYear string n/a No
model string n/a No
modelCode string n/a No
modelId string n/a No
mpgRange string range parameter separated by ':' for eg. 20:50 read as 'between 20 and 50'. No
noOfCylinders string n/a No
offset string Optional offset into all search results to be returned. Default is 0 offset. No
option string n/a No
priceRange string range parameter separated by ':' for eg. 20000:40000 read as 'between 20000 and 40000'. No
radius string distance measured in km/mi, based on locale and coordinates/zip code above. To be passed in conjunction with coordinates/zip/zipCode. for eg. 100. All other parameters mentioned below are optional No
region string required only if any of the above or below parameters are not specified No
savingsRange string range parameter separated by ':' for eg. 2000:5000 read as 'between 2000 and 5000'. No
search string 'new' , 'certified', 'used', 'demo'. No
searchQuery string n/a No
sort string Parameter to sort search results by. Only certain sort parameters are accepted. See MVS2 Spec. No
status string 'In-stock' , 'In-transit' , 'Hold', 'On-order'. No
stockNumber string n/a No
stockOrVIN string Allows comma-separated list of partial search string terms. Each individual term may match in either stockNumber or vin field, both, or none. Results are returned for combined matches of all terms. No
storeId string required only if any of the above or below parameters are not specified No
styleId string n/a No
transmission string n/a No
trim string n/a No
vehicleId string n/a No
vehicleOwner string n/a No
video string true or false No
vin string required only if any of the above or below parameters are not specified No
vsrPackageFilter string n/a No
webId string CDK Website Unique Identifier, required only if any of the below parameters are not specified No
year string n/a No
yearRange string range parameter separated by ':' for eg. 2015:2018 read as 'between 2015 and 2018'. No
zip string Zip or Postal Code, required only if any of the above or below parameters are not specified No
zipCode string same as zip No

Header Parameters

Parameter Type Description Required
Accept string n/a No
Accept-Charset string n/a No
Accept-Language string n/a No
If-Match string n/a No
If-None-Match string n/a No
Prefer string Mention required fields No
Request-Id string Unique tracking id 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

Expand All
Collapse All

Request Body Example

Response

Response Body Structure

Expand All
Collapse All

Response Body Example

Response Error Details

HTTP Code Description
401 Unauthorized
403 Forbidden
404 Not Found

Try It Out

  • bodyColor

    (string) Vehicle exterior color.

  • bodyStyle

    (string)

  • bodyStyleClassification

    (string)

  • bodyType

    (string) 'CAR', 'TRUCK', 'SUV', 'VAN', 'WAGON', 'CARGO VAN', 'COMMERCIAL VEHICLE'.

  • coordinates

    (string) geo coordinates[lat,lon] parameter separated by ',' for eg. 48,-89 read as 'lat=48 and lon=-89'.

  • csStoreId

    (string) required only if any of the above or below parameters are not specified

  • cylinders

    (string)

  • dealerType

    (string)

  • displacement

    (string)

  • displayableInventoryStatus

    (string) 'In Stock' , 'In Transit' , 'Hold', 'On Order'.

  • displayableStoreId

    (string) required only if any of the above or below parameters are not specified

  • drivetrain

    (string)

  • engine

    (string)

  • fields

    (string) Partial response field filter.

  • fuelType

    (string) 'Diesel', 'Electric', 'Ethanol', 'Flexible Fuel', 'Gas', 'Hybrid', 'Methanol', 'Compressed Natural Gas', 'Propane'.

  • groups

    (string) This is a group identifier for aggregated inventory search. Groups are managed by Group Service, required only if any of the above or below parameters are not specified

  • id

    (string) required only if any of the above or below parameters are not specified

  • interiorColor

    (string)

  • limit

    (string) Optional number of search results to return. Default is 10.

  • locale

    (string) should be combined with any of the other params above or below

  • location

    (string)

  • lotAgeRange

    (string) range parameter separated by ':' for eg. 50:250 read as 'between 50 and 250'.

  • make

    (string)

  • marketable

    (string) true or false

  • maxLotAge

    (string)

  • maxMileage

    (string)

  • maxMpg

    (string)

  • maxPrice

    (string)

  • maxSavings

    (string)

  • maxYear

    (string)

  • merchandisablePaymentRange

    (string) range parameter seperated by : for payment range

  • merchandisablePaymentType

    (string) FINANCE or LEASE, always used in combination with merchandisablePaymentRange

  • mileageRange

    (string) range parameter separated by ':' for eg. 10000:50000 read as 'between 10000 and 50000'.

  • minLotAge

    (string)

  • minMileage

    (string)

  • minMpg

    (string)

  • minPrice

    (string)

  • minSavings

    (string)

  • minYear

    (string)

  • model

    (string)

  • modelCode

    (string)

  • modelId

    (string)

  • mpgRange

    (string) range parameter separated by ':' for eg. 20:50 read as 'between 20 and 50'.

  • noOfCylinders

    (string)

  • offset

    (string) Optional offset into all search results to be returned. Default is 0 offset.

  • option

    (string)

  • priceRange

    (string) range parameter separated by ':' for eg. 20000:40000 read as 'between 20000 and 40000'.

  • radius

    (string) distance measured in km/mi, based on locale and coordinates/zip code above. To be passed in conjunction with coordinates/zip/zipCode. for eg. 100. All other parameters mentioned below are optional

  • region

    (string) required only if any of the above or below parameters are not specified

  • savingsRange

    (string) range parameter separated by ':' for eg. 2000:5000 read as 'between 2000 and 5000'.

  • search

    (string) 'new' , 'certified', 'used', 'demo'.

  • searchQuery

    (string)

  • sort

    (string) Parameter to sort search results by. Only certain sort parameters are accepted. See MVS2 Spec.

  • status

    (string) 'In-stock' , 'In-transit' , 'Hold', 'On-order'.

  • stockNumber

    (string)

  • stockOrVIN

    (string) Allows comma-separated list of partial search string terms. Each individual term may match in either stockNumber or vin field, both, or none. Results are returned for combined matches of all terms.

  • storeId

    (string) required only if any of the above or below parameters are not specified

  • styleId

    (string)

  • transmission

    (string)

  • trim

    (string)

  • vehicleId

    (string)

  • vehicleOwner

    (string)

  • video

    (string) true or false

  • vin

    (string) required only if any of the above or below parameters are not specified

  • vsrPackageFilter

    (string)

  • webId

    (string) CDK Website Unique Identifier, required only if any of the below parameters are not specified

  • year

    (string)

  • yearRange

    (string) range parameter separated by ':' for eg. 2015:2018 read as 'between 2015 and 2018'.

  • zip

    (string) Zip or Postal Code, required only if any of the above or below parameters are not specified

  • zipCode

    (string) same as zip

  • Accept

    (string)

  • Accept-Charset

    (string)

  • Accept-Language

    (string)

  • If-Match

    (string)

  • If-None-Match

    (string)

  • Prefer

    (string) Mention required fields

  • Request-Id

    (string) Unique tracking id

  • 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.

Reset

Request

Response

cURL

Make a request and see the request.

Make a request and see the response.

Make a request and see the cURL.

Working...

x