API: 
Inventory Search API
API Class: 
Inventory Search API
Description: 

The Inventory Search Service API (ISS) project is a RESTful service that provides inventory listings to the consumer. The ISS will take an input SearchCriteriaBO Object and return listings within a SearchResultBO Object. The returned result will include the partner search result.

URL

Note: Ensure all testing is done in development environment prior to moving to production.

Environment URL
development https://api.cars.com/InventorySearchService/1.0/rest/partner/inventory/search
production https://api.cars.com/InventorySearchService/1.0/rest/partner/inventory/search

Request

Request Data Formats
Request type Header value
xml Content-type: text/xml
Request XML Elements
Element Type Description
zc String Zip Code
rd String Radius
apn String Affiliate Profile Name
rpp Integer Results Per Page
Request XML Example
<?xml version="1.0" encoding="UTF-8"?gt;<?xml version="1.0" encoding="UTF-8"?>
<partnerCriteriaBO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <zc>60604</zc>
  <rd>30</rd>
<apn>ccn</apn>
<rpp>3</rpp>
</partnerCriteriaBO>
		

 

Response

Response Data Formats
Response type Header value
xml Accept: text/xml
Response Elements
PartnerResultsBO
Element Type Description
resultCount Integer Result Count
listings List: InventorySummaryBO See class description below
returnCode ReturnCode See class description below
InventorySummaryBO
Element Type Description
id Long ID
makeName String Make
modelName String Model
modelYear Integer Year
trimName String Trim
price Integer Price
miles Integer Mileage
exteriorColor String Exterior color
location String Latitude, Longitude location
bodystyleName String Body Style
engineDescription String Engine
transmission String Transmission type
drivetrain String Drive train type
actualPhotoImageLocation String Photo location
city String City
state String State
listingDateSeconds Long Listing Date
features String Vehicle features
sellerId Long Seller ID
dealerName String Dealer Name
stockNumber String Stock number
dealerWebsiteUrl String Dealer website URL
vin String Vin number
newCarStockType Boolean New car
actualPhotoCount Integer Photo count
cpoVehicle Boolean CPO vehicle boolean
cpoProgramName String CPO Program Name
vdpUrl String VDP URL
mobileVdpUrl String Mobile VDP URL
ReturnCode
Response Field Name Type Description
code String Return Code
message String Return code message
Response XML Example
<partnerResultsBO>
   <resultCount>94941</resultCount>
   <listings>
      <id>73790573</id>
      <makeName>Honda</makeName>
      <modelName>Accord</modelName>
      <modelYear>1998</modelYear>
      <trimName>EX</trimName>
      <price>5900</price>
      <miles>139552</miles>
      <exteriorColor>Flamenco Black Pearl</exteriorColor>
      <location>41.506020,-87.665330</location>
      <bodystyleName>Sedan</bodystyleName>
      <engineDescription>2.3L I4 16V MPFI SOHC</engineDescription>
      <transmission>4-Speed Automatic</transmission>
      <drivetrain>FWD</drivetrain>
      <actualPhotoImageLocation>DMI/202650/126646.jpg,DMI/202650/126646.02.jpg,DMI/202650/126646.03.jpg,DMI/202650/126646.04.jpg,DMI/202650/126646.05.jpg,DMI/202650/126646.06.jpg,DMI/202650/126646.07.jpg,DMI/202650/126646.08.jpg,DMI/202650/126646.09.jpg,DMI/202650/126646.10.jpg,DMI/202650/126646.11.jpg,DMI/202650/126646.12.jpg,DMI/202650/126646.13.jpg,DMI/202650/126646.14.jpg,DMI/202650/126646.15.jpg,DMI/202650/126646.16.jpg</actualPhotoImageLocation>
      <city>Chicago Heights</city>
      <state>IL</state>
      <listingDateSeconds>1298505600</listingDateSeconds>
      <features>Air Conditioning, Power Steering, Power Door Locks, Clock, Tilt Steering Wheel, Bucket Seats, Remote Trunk Release, Center Console, Power Mirrors, Power Moon Roof, Rear Window Defroster, Anti Theft/Security System, Dual Air Bags, Intermittent Wipers, Anti-Lock Braking System (Abs), AM/FM Stereo Radio, Alloy Wheels, Trip Odometer, Console, Front Bucket Seats, Cloth Upholstery, Keyless Entry</features>
      <sellerId>4312178</sellerId>
      <dealerName>OT Auto Sales</dealerName>
      <stockNumber>126646</stockNumber>
      <dealerWebsiteUrl>http://otautosales.com</dealerWebsiteUrl>
      <vin>1HGCG5650WA126646</vin>
      <newCarStockType>false</newCarStockType>
      <actualPhotoCount>16</actualPhotoCount>
      <cpoVehicle>false</cpoVehicle>
      <vdpUrl>http://www.cars.com/go/search/detail.jsp?listingId=73790573</vdpUrl>
      <mobileVdpUrl>http://m.cars.com/m/for-sale/index.html#vdp?paId=73790573</mobileVdpUrl>
   </listings>
   <listings>
      <id>78508400</id>
      <makeName>Volvo</makeName>
      <modelName>XC90</modelName>
      <modelYear>2008</modelYear>
      <trimName>V8</trimName>
      <price>32995</price>
      <miles>30861</miles>
      <exteriorColor>Black</exteriorColor>
      <location>42.112876,-87.775976</location>
      <bodystyleName>SUV</bodystyleName>
      <engineDescription>4.4L V8 32V MPFI DOHC</engineDescription>
      <transmission>6-Speed Automatic</transmission>
      <drivetrain>AWD</drivetrain>
      <actualPhotoImageLocation>DMI/96882/P2574.jpg,DMI/96882/P2574.02.jpg,DMI/96882/P2574.03.jpg,DMI/96882/P2574.04.jpg,DMI/96882/P2574.05.jpg,DMI/96882/P2574.06.jpg,DMI/96882/P2574.07.jpg,DMI/96882/P2574.08.jpg,DMI/96882/P2574.09.jpg,DMI/96882/P2574.10.jpg,DMI/96882/P2574.11.jpg,DMI/96882/P2574.12.jpg,DMI/96882/P2574.13.jpg,DMI/96882/P2574.14.jpg,DMI/96882/P2574.15.jpg</actualPhotoImageLocation>
      <city>Northfield</city>
      <state>IL</state>
      <listingDateSeconds>1321660800</listingDateSeconds>
      <features>3-Point Seat Belts W/Pretensioners For All Seating Positions, ABS (4-Wheel), AM/FM Stereo, Air Cond Rear, Air Conditioning, Alloy Wheels, Child Safety Rear Door Locks, Collapsible Steering Column, DVD System, Dual Air Bags, Dual Illuminated Visor Vanity Mirrors, Dual Power Seats, Dynamic Stability Control, Front Fog Lights, Front/Rear Stabilizer Bars, Head Curtain Air Bags, Keyless Entry, Leather, Mp3 (Multi Disc), Macpherson Strut Front Suspension, Moon Roof, Multi-Link Independent Rear Suspension, Power Door Locks, Power Steering, Premium Pkg, Privacy Glass, Rear Fog Light, Rear Window Defroster W/Timer, Side Air Bags, Speed-Sensitive Pwr Rack &amp; Pinion Steering, Third Row Seat, Tilt Wheel, Traction Control</features>
      <sellerId>439336</sellerId>
      <dealerName>Fields Volvo of Northfield</dealerName>
      <stockNumber>P2574</stockNumber>
      <dealerWebsiteUrl>http://www.volvonorthfield.com</dealerWebsiteUrl>
      <vin>YV4CZ852481480011</vin>
      <newCarStockType>false</newCarStockType>
      <actualPhotoCount>15</actualPhotoCount>
      <cpoVehicle>true</cpoVehicle>
      <cpoProgramName>Volvo Certified Program</cpoProgramName>
      <vdpUrl>http://www.cars.com/go/search/detail.jsp?listingId=78508400</vdpUrl>
      <mobileVdpUrl>http://m.cars.com/m/for-sale/index.html#vdp?paId=78508400</mobileVdpUrl>
   </listings>
   <listings>
      <id>79539340</id>
      <makeName>Lexus</makeName>
      <modelName>RX 350</modelName>
      <modelYear>2009</modelYear>
      <price>30744</price>
      <miles>44896</miles>
      <exteriorColor>Silver</exteriorColor>
      <location>42.139073,-88.011636</location>
      <bodystyleName>SUV</bodystyleName>
      <engineDescription>3.5L V6 24V MPFI DOHC</engineDescription>
      <transmission>5-Speed Automatic</transmission>
      <drivetrain>AWD</drivetrain>
      <actualPhotoImageLocation>DMI/22/4539P.jpg,DMI/22/4539P.02.jpg,DMI/22/4539P.03.jpg,DMI/22/4539P.04.jpg,DMI/22/4539P.05.jpg,DMI/22/4539P.06.jpg,DMI/22/4539P.07.jpg,DMI/22/4539P.08.jpg,DMI/22/4539P.09.jpg,DMI/22/4539P.10.jpg,DMI/22/4539P.11.jpg,DMI/22/4539P.12.jpg</actualPhotoImageLocation>
      <city>Palatine</city>
      <state>IL</state>
      <listingDateSeconds>1323216000</listingDateSeconds>
      <features>I STRONGLY RECOMMEND THAT YOU CALL FIRST TO CONFIRM THAT THIS CAR IS STILL AVAILABLE. CALL INTERNET SALES MANAGER JAMIE BROWN DIRECT AT 866-892-7513 TO CONFIRM. CALL FIRST.</features>
      <sellerId>424449</sellerId>
      <dealerName>Arlington Lexus in Palatine</dealerName>
      <stockNumber>4539P</stockNumber>
      <dealerWebsiteUrl>http://www.arlingtonlexus.com</dealerWebsiteUrl>
      <vin>2T2HK31U99C101682</vin>
      <newCarStockType>false</newCarStockType>
      <actualPhotoCount>12</actualPhotoCount>
      <cpoVehicle>false</cpoVehicle>
      <vdpUrl>http://www.cars.com/go/search/detail.jsp?listingId=79539340</vdpUrl>
      <mobileVdpUrl>http://m.cars.com/m/for-sale/index.html#vdp?paId=79539340</mobileVdpUrl>
   </listings>
   <returnCode>
      <code>SUCCESS</code>
      <message>Inventory Search Successfully Executed</message>
   </returnCode>
</partnerResultsBO>
		
Test
Method Type: 
POST
Endpoint URI: 
https://api.cars.com/InventorySearchService/1.0/partner/inventory/search