Vehicle API

Overview

The Vehicle API provides access to the different types of vehicle information.

API Uses

  • Get a list of all vehicles
  • Get vehicle information by uuid (unique identifier)

Available Resources

Resource Name Description
Vehicle Information This is where you can get all the information for a vehicle.

Vehicle Information

This is where you can get Vehicle API information.

Endpoints

  • Get all vehicles
  • Get vehicle by uuid

URL

To make a call, make an HTTPS get request

https://api.dealer.com/vehicles/search?api_key={api_key}
https://api.dealer.com/vehicles/id/{uuid}?api_key={api_key}

Parameters

For /vehicles/search

Parameter Description Possible Values Default Value Type In Required
select Select the properties will get returned by the query actualCashValue ,askingPrice ,autodataCaId ,autodataUsId ,autonationMsrpAdv ,autonationMsrpBeforePkgDisc ,autonationPkgDisc ,bed ,bodyStyle ,cCode ,cab ,category ,certified ,chromeId ,cityFuelEconomy ,classification ,comments ,country ,dealerFee ,discount ,doors ,driveLine ,eleadPrice ,eleadPriceLessOEMCash ,emailPrice ,engine ,engineSize ,exportBottomLinePrice ,exteriorColor ,exteriorColorCode ,fuelType ,gvEngine ,highwayFuelEconomy ,interiorColor ,interiorColorCode ,internetPrice ,inventoryDate ,invoicePrice ,kbbValue ,make ,model ,modelCode ,msrp ,normalBodyStyle ,normalDriveLine ,normalExteriorColor ,normalFuelType ,normalInteriorColor ,normalInteriorMaterial ,normalTransmission ,odometer ,optionCodes ,retailValue ,salePrice ,salesCost ,sold ,status ,stockNumber ,transmission ,trim ,type ,webBottomLinePrice ,wholesalePrice ,year String array Query No
start Initial position where the pagination will start Integer Query No
size size of each page Integer Query No
category Filter the vehicles by category String Query No
removed Filter removed vehicles Boolean Query No
uuid Unique identifier of a vehicle, it will unique represent a combination of VIN and Account String Query No
vin Filter by the vehicle VIN String Query No
accountId Parent account ID own the vehicle String Query No
associatedAccountId ID of the associated account to be returned String Query No
stockNumber Stock Number String Query No
status Allow to search by the vehicle status String Query No
certified Filter by certified vehicles. Boolean Query No
chromeId Filter by chrome style id. String Query No
chromeId Filter by chrome style id. String Query No
make Filter by vehicle make. String Query No
For /vehicles/id/{uuid}

Parameter Description Possible Values Default Value Type In Required
select Select the properties will get returned by the query actualCashValue ,askingPrice ,autodataCaId ,autodataUsId ,autonationMsrpAdv ,autonationMsrpBeforePkgDisc ,autonationPkgDisc ,bed ,bodyStyle ,cCode ,cab ,category ,certified ,chromeId ,cityFuelEconomy ,classification ,comments ,country ,dealerFee ,discount ,doors ,driveLine ,eleadPrice ,eleadPriceLessOEMCash ,emailPrice ,engine ,engineSize ,exportBottomLinePrice ,exteriorColor ,exteriorColorCode ,fuelType ,gvEngine ,highwayFuelEconomy ,interiorColor ,interiorColorCode ,internetPrice ,inventoryDate ,invoicePrice ,kbbValue ,make ,model ,modelCode ,msrp ,normalBodyStyle ,normalDriveLine ,normalExteriorColor ,normalFuelType ,normalInteriorColor ,normalInteriorMaterial ,normalTransmission ,odometer ,optionCodes ,retailValue ,salePrice ,salesCost ,sold ,status ,stockNumber ,transmission ,trim ,type ,webBottomLinePrice ,wholesalePrice ,year String array Query No
uuid Unique identifier of a vehicle, it will unique represent a combination of VIN and Account String path Yes

Response Format

For /vehicles/search

[
  {
    "@type": "string",
    "account": {
      "@type": "string",
      "accountId": "string",
      "links": [
        {
          "deprecation": "string",
          "href": "string",
          "hreflang": "string",
          "media": "string",
          "rel": "string",
          "templated": true,
          "title": "string",
          "type": "string"
        }
      ]
    },
    "actualCashValue": 0,
    "askingPrice": 0,
    "autodataCaId": "string",
    "autodataUsId": "string",
    "autonationMsrpAdv": 0,
    "autonationMsrpBeforePkgDisc": 0,
    "autonationPkgDisc": 0,
    "bed": "string",
    "bodyStyle": {},
    "cab": "string",
    "category": "string",
    "ccode": "string",
    "certified": true,
    "chromeId": "string",
    "cityFuelEconomy": {},
    "classification": "string",
    "comments": "string",
    "country": "string",
    "dealerFee": 0,
    "discount": 0,
    "doors": {},
    "driveLine": {},
    "eleadPrice": 0,
    "eleadPriceLessOEMCash": 0,
    "emailPrice": 0,
    "engine": "string",
    "engineSize": "string",
    "exportBottomLinePrice": 0,
    "exteriorColor": {},
    "exteriorColorCode": {},
    "fuelType": {},
    "highwayFuelEconomy": {},
    "interiorColor": {},
    "interiorColorCode": {},
    "internetPrice": 0,
    "inventoryDate": "2018-07-03T16:02:58.462Z",
    "invoicePrice": 0,
    "kbbValue": 0,
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "rel": "string",
        "templated": true,
        "title": "string",
        "type": "string"
      }
    ],
    "make": "string",
    "model": {},
    "modelCode": {},
    "msrp": 0,
    "normalBodyStyle": {},
    "normalDriveLine": {},
    "normalExteriorColor": {},
    "normalFuelType": {},
    "normalInteriorColor": {},
    "normalInteriorMaterial": {},
    "normalTransmission": {},
    "odometer": 0,
    "optionCodes": [
      "string"
    ],
    "removed": true,
    "retailValue": 0,
    "salePrice": 0,
    "salesCost": 0,
    "sold": true,
    "status": "string",
    "stockNumber": "string",
    "transmission": {},
    "trim": {},
    "type": "string",
    "uuid": "string",
    "vin": "string",
    "webBottomLinePrice": 0,
    "wholesalePrice": 0,
    "year": 0
  }
]
For /vehicles/id/{uuid}
{
  "@type": "string",
  "account": {
    "@type": "string",
    "accountId": "string",
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "rel": "string",
        "templated": true,
        "title": "string",
        "type": "string"
      }
    ]
  },
  "actualCashValue": 0,
  "askingPrice": 0,
  "autodataCaId": "string",
  "autodataUsId": "string",
  "autonationMsrpAdv": 0,
  "autonationMsrpBeforePkgDisc": 0,
  "autonationPkgDisc": 0,
  "bed": "string",
  "bodyStyle": {},
  "cab": "string",
  "category": "string",
  "ccode": "string",
  "certified": true,
  "chromeId": "string",
  "cityFuelEconomy": {},
  "classification": "string",
  "comments": "string",
  "country": "string",
  "dealerFee": 0,
  "discount": 0,
  "doors": {},
  "driveLine": {},
  "eleadPrice": 0,
  "eleadPriceLessOEMCash": 0,
  "emailPrice": 0,
  "engine": "string",
  "engineSize": "string",
  "exportBottomLinePrice": 0,
  "exteriorColor": {},
  "exteriorColorCode": {},
  "fuelType": {},
  "highwayFuelEconomy": {},
  "interiorColor": {},
  "interiorColorCode": {},
  "internetPrice": 0,
  "inventoryDate": "2018-07-03T16:16:51.029Z",
  "invoicePrice": 0,
  "kbbValue": 0,
  "links": [
    {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "rel": "string",
      "templated": true,
      "title": "string",
      "type": "string"
    }
  ],
  "make": "string",
  "model": {},
  "modelCode": {},
  "msrp": 0,
  "normalBodyStyle": {},
  "normalDriveLine": {},
  "normalExteriorColor": {},
  "normalFuelType": {},
  "normalInteriorColor": {},
  "normalInteriorMaterial": {},
  "normalTransmission": {},
  "odometer": 0,
  "optionCodes": [
    "string"
  ],
  "removed": true,
  "retailValue": 0,
  "salePrice": 0,
  "salesCost": 0,
  "sold": true,
  "status": "string",
  "stockNumber": "string",
  "transmission": {},
  "trim": {},
  "type": "string",
  "uuid": "string",
  "vin": "string",
  "webBottomLinePrice": 0,
  "wholesalePrice": 0,
  "year": 0
}

Sample Request

https://api.dealer.com/vehicles/id/474ed97d0a0e0a176b998211899d5648?select=actualCashValue%20&select=askingPrice%20&select=autodataCaId%20&select=autodataUsId%20&select=autonationMsrpAdv%20&select=autonationMsrpBeforePkgDisc%20&select=autonationPkgDisc%20&select=bed%20&select=bodyStyle%20&select=cCode%20&select=cab%20&select=category%20&select=certified%20&select=chromeId%20&select=cityFuelEconomy%20&select=classification%20&select=comments%20&select=country%20&select=dealerFee%20&select=discount%20&select=doors%20&select=driveLine%20&select=eleadPrice%20&select=eleadPriceLessOEMCash%20&select=emailPrice%20&select=engine%20&select=engineSize%20&select=exportBottomLinePrice%20&select=exteriorColor%20&select=exteriorColorCode%20&select=fuelType%20&select=gvEngine%20&select=highwayFuelEconomy%20&select=interiorColor%20&select=interiorColorCode%20&select=internetPrice%20&select=inventoryDate%20&select=invoicePrice%20&select=kbbValue%20&select=make%20&select=model%20&select=modelCode%20&select=msrp%20&select=normalBodyStyle%20&select=normalDriveLine%20&select=normalExteriorColor%20&select=normalFuelType%20&select=normalInteriorColor%20&select=normalInteriorMaterial%20&select=normalTransmission%20&select=odometer%20&select=optionCodes%20&select=retailValue%20&select=salePrice%20&select=salesCost%20&select=sold%20&select=status%20&select=stockNumber%20&select=transmission%20&select=trim%20&select=type%20&select=webBottomLinePrice%20&select=wholesalePrice%20&select=year%20&api_key=abc123def
                
Response:
{
  "uuid": "474ed97d0a0e0a176b998211899d5648",
  "vin": "1FA6P8TH4J5144537",
  "removed": false,
  "stockNumber": "FC2006J",
  "inventoryDate": "2018-03-21T06:46:12.000+0000",
  "year": 2018,
  "make": "Ford",
  "type": "NEW",
  "status": "LIVE",
  "classification": "PRIMARY",
  "category": "AUTO",
  "sold": false,
  "certified": false,
  "chromeId": "395969",
  "transmission": {
    "_type": "s",
    "en_US": "Automatic"
  },
  "exteriorColor": {
    "_type": "s",
    "en_US": "Shadow Black"
  },
  "interiorColor": {
    "_type": "s",
    "en_US": "Ebony"
  },
  "modelCode": {
    "_type": "s",
    "en_US": "P8T"
  },
  "model": {
    "_type": "s",
    "en_US": "Mustang"
  },
  "normalFuelType": {
    "_type": "s",
    "en_US": "Other"
  },
  "normalInteriorColor": {
    "_type": "s",
    "en_US": "Black"
  },
  "normalTransmission": {
    "_type": "s",
    "en_US": "Automatic"
  },
  "trim": {
    "_type": "s",
    "en_US": "EcoBoost Premium Fastback"
  },
  "normalInteriorMaterial": {
    "_type": "s",
    "en_US": "Cloth"
  },
  "doors": {
    "_type": "s",
    "en_US": "2 door"
  },
  "bodyStyle": {
    "_type": "s",
    "en_US": "EcoBoost Premium Fastback"
  },
  "normalExteriorColor": {
    "_type": "s",
    "en_US": "Black"
  },
  "exteriorColorCode": {
    "_type": "s",
    "en_US": "Shadow"
  },
  "normalDriveLine": {
    "_type": "s",
    "en_US": "Other"
  },
  "interiorColorCode": {
    "_type": "s",
    "en_US": "Ebony"
  },
  "normalBodyStyle": {
    "_type": "s",
    "en_US": "Other"
  },
  "cityFuelEconomy": {
    "imperial": 21
  },
  "highwayFuelEconomy": {
    "imperial": 31
  },
  "invoicePrice": 0,
  "wholesalePrice": 0,
  "webBottomLinePrice": 36290,
  "salePrice": 0,
  "emailPrice": 0,
  "retailValue": 34790,
  "askingPrice": 34790,
  "exportBottomLinePrice": 36290,
  "msrp": 36290,
  "internetPrice": 36290,
  "engineSize": "2.3 L",
  "odometer": 12,
  "autodataUsId": "USC80FOC051A0",
  "autodataCaId": "CAC80FOC051A0",
  "engine": "4",
  "comments": "\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"The Klaben Auto Stores are home to your Best Bottom Line Deal. We keep it simple. No pressure, no gimmicks, no misleading claims. Choose from hundreds of cars, trucks, crossovers, SUVs and vans, each clearly marked with your Best Bottom Line Deal.\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"",
  "country": "US",
  "links": [
    {
      "rel": "self",
      "href": "https://vehicles.inv.dealer.com/vehicles/id/474ed97d0a0e0a176b998211899d5648",
      "hreflang": null,
      "media": null,
      "title": null,
      "type": null,
      "deprecation": null
    }
  ],
  "@type": "veh_res_v1"
}

Vehicle Model

Property Description Possible Values Type
@type string
account DDC Account ddcdemo string
actualCashValue integer
askingPrice integer
autodataCaId string
autodataUsId string
autonationMsrpAdv integer
autonationMsrpBeforePkgDisc integer
autonationPkgDisc integer
bed Truck bed style string
bodyStyle Body Style sedan string
cab Truck Cab Size SuperCrew string
category string
ccode string
certified Certification status True or False boolean
chromeId chrome data Id string
cityFuelEconomy FuelEconomy{ }
classification Identify vehicle classification string
comments vehicle comments come buy this car! string
country string
dealerFee integer
discount integer
doors Number of doors 4 string
driverLine integer
eleadPrice integer
eleadPriceLessOEMCash integer
emailPrice integer
engine Engine Type 1-4 cylinders string
engineSize Engine Size 1.8L string
exportBottomLinePrice integer
exteriorColor generic Exterior color Red, Black etc string
exteriorColorCode OEM Exterior Color Code 209 string
fuelType Fuel Type Regular, Unleaded string
highwayFuelEconomy FuelEconomy{}
interiorColor Generic Interior Color Beige, Gray etc stirng
interiorColorCode OEM interior color code sand beige, Unleaded string
internetPrice number
inventoryDate string
invociePrice integer
kbbValue integer
links Link{ deprecation(string), href(string), hreflang(string), media(string), rel(string), templated(boolean), title(string), type(string)}
make Make BMW string
model Model X5 string
modelCode Model Code assigned by OEM 1852, W1E string
msrp integer
normalBodyStyle string
normalDriveLine string
normalExteriorColor string
normalFuelType string
normalInteriorColor string
normalInteriorMaterial string
normalTransmission string
odometer integer
optionCodes string array
removed boolean
retailValue integer
salePrice integer
salesCost integer
sold boolean
status string
stockNumber string
transmission Transmission Type Automatic, Manual String
trim Trim EX-L string
type Type/condition of vehicle New, Used, or Certified String
uuid VIN plus accountId 474ed97d0a0e0a176b998211899d5648 string
vin VIN 1FBJS31H6THA68804 string
webBottomLinePrice integer
wholesalePrice integer
year Model year 2010 integer