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

The Inventory Search Service API (ISS) is a RESTful service that provides inventory listings to the consumer. The ISS will take an input SearchCriteriaBO XML request object and return listings within a SearchResultBO XML response object. The returned result will have the listings.

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/inventory/search
production https://api.cars.com/InventorySearchService/1.0/rest/inventory/search

Request

Request Data Formats
Request type Header value
xml Content-type: text/xml
Request XML Elements
Element Type Description
zc Integer The zip code used for searching
rd Integer The radius for searching
searchSource String Type of search being performed
stkTypId Integer Id for stock type(new, used, cpo)
mkId Integer Make Id
mdId Integer Model Id
Request XML Example
<?xml version="1.0" encoding="UTF-8"?>
<searchCriteriaBO>
  <zc>60525</zc>
  <rd>100</rd>
  <searchSource>ADVANCED_SEARCH</searchSource>
  <stkTypId>28880</stkTypId>
  <mkId>20017</mkId>
  <mdId>20823</mdId>
  <rpp>500</rpp>
  <requestorTrackingInfo>myRrequesterAppCode</requestorTrackingInfo>
</searchCriteriaBO>

Response

Response Data Formats
Response type Header value
xml Accept: text/xml
Response Elements
SearchResultBO
Element Type Description
resultCount Integer Result count
totalDealerCount long Total number of dealers
listings List: ListingSummaryBO See class description below
breadCrumbs List: BreadCrumbBO See class description below
refinements List: RefinementBO See class description below
returnCode ReturnCode See class description below
ListingSummaryBO
Element Type Description
id Long Listing ID
makeName String Vehicle Make Name
makeId Long Vehicle Make ID
modelName String Vehicle Model Name
modelId Long Vehicle Model ID
modelYear Integer Vehicle Model Year
modelYearId Long Vehicle Model Year ID
trimName String Vehicle Trim Name
trimId Long Vehicle Trim ID
price Integer Vehicle Price
miles Integer Vehicle Mileage
exteriorColor String Vehicle Exterior color
actualPhotoImageLocation String Photo image location
actualPhotoCount Integer Photo count
phoneNumber String Phone number
phoneNumberExt String Phone extension
ringToPhoneNumber String Ring to phone number
ringToPhoneNumberExt String Ring to phone number ext
city String City
cpoVehicle Boolean CPO vehicle boolean
sellerId Long Seller ID
sellerHasUsedDealerSpecialsEnabled Boolean Seller has used dealer specials enabled boolean
bodystyleName String Body style
dealerName String Dealer name
distanceFromBuyerZip Double Distance from the Buyer's Zip code area
doorCount Integer Number of Doors
engineDescription String Engine Description
privatePartyContactName String Private Party Contact Name
sellerHasCpoShowroomEnabled Boolean Seller has CPO Showroom indicator
privatePartyListing Boolean Private Party Listing indicator
listingDateSeconds Long Listing Dat
truncatedDescription String Short Description
listingTypeId Integer Listing Type ID
sellerHasNewDealerSpecialsEnabled Boolean Seller has New Dealer Specials indicator
emailLeadEnabled Boolean Email Lead Enabled indicator
newCarStockType Boolean New Car indicator
state String State
stockNumber String Stock Number
stockPhotoImageLocation String Stock Photo Image Location
transmission String Transmission Type
sellerVideoLocation String Seller Video Location
vin String Vehicle Identification Number
drivetrain String Drive Train Type
affiliateAgentId Long Affiliate Agent ID
primaryFeedSourceId Long Primary Feed Source ID
sellerName String Seller's Name
sellerEmailAddress String Seller's Email Address
sellerDisplayLabel String Seller's Display Label
newlyListed Boolean Newly Listed indicator
vehicleHistoryReportIsFree Boolean Vehicle History Report Is Free indicator
certifiedPlus Boolean Certified Plus indicator
ncSpotLight String NC Spot Light
dealerWebsiteUrl String Dealer Website URL
features String Features
localOfferTypeCode String Local Offer Type Code
localOfferId String Local Offer Id
localOfferExpireDate String Local Offer Expirey Date
powerdriveEnabled Boolean Powerdrive Enabled indicator
dlrRating Float Dealer Rating
dealerReviewCount String Dealer Review Count
location String Dealer Location
streetAddress String Dealer Street Address
customerId Long Customer ID
BreadCrumbBO
Element Type Description
name String Name
displayName String Display Name
id long Bread Crumb ID
isMultiCriteriaPseudoBc boolean Multi Criteria Pseudo Bread Crumb Indicator
values List: BreadCrumbValueBO See class description below
BreadCrumbValueBO
Element Type Description
name String Bread Crumb Name
value String Bread Crumb Value
RefinementBO
Element Type Description
name String Name
displayName String Display Name
id long Refinement ID
isMultiSelect boolean Multi Select Indicator
showAllRefValues boolean Show All Reference Values Indicator
values List: RefinementValueBO List of RefinementValueBO objects
RefinementValueBO
Element Type Description
name String Name
id long Refinement Value ID
count Integer Refinement Count
properties String (Key Value Pairs) Refinement Properties
ReturnCode
Element Type Description
code String Return Code
message String Return code message
Response XML Example
<searchResultBO>
   <resultCount>1318</resultCount>
   <totalDealerCount>0</totalDealerCount>
   <listings>
      <id>79660597</id>
      <makeName>Honda</makeName>
      <makeId>20017</makeId>
      <modelName>Civic</modelName>
      <modelId>20823</modelId>
      <modelYear>2012</modelYear>
      <modelYearId>39723</modelYearId>
      <trimName>LX</trimName>
      <trimId>24369</trimId>
      <price>19425</price>
      <miles>10</miles>
      <exteriorColor>Crystal Black</exteriorColor>
      <actualPhotoCount>0</actualPhotoCount>
      <phoneNumber>8667720248</phoneNumber>
      <ringToPhoneNumber>8886542179</ringToPhoneNumber>
      <city>Oak Lawn</city>
      <cpoVehicle>false</cpoVehicle>
      <sellerId>424546</sellerId>
      <sellerHasUsedDealerSpecialsEnabled>false</sellerHasUsedDealerSpecialsEnabled>
      <bodystyleName>Sedan</bodystyleName>
      <dealerName>Ed Napleton Honda</dealerName>
      <distanceFromBuyerZip>6.698559</distanceFromBuyerZip>
      <doorCount>4</doorCount>
      <engineDescription>1.8L I4 16V MPFI SOHC</engineDescription>
      <privatePartyContactName>Ed Napleton Honda</privatePartyContactName>
      <sellerHasCpoShowroomEnabled>true</sellerHasCpoShowroomEnabled>
      <privatePartyListing>false</privatePartyListing>
      <listingDateSeconds>1323302400</listingDateSeconds>
      <listingTypeId>1</listingTypeId>
      <sellerHasNewDealerSpecialsEnabled>false</sellerHasNewDealerSpecialsEnabled>
      <emailLeadEnabled>true</emailLeadEnabled>
      <newCarStockType>true</newCarStockType>
      <state>IL</state>
      <stockNumber>H21223</stockNumber>
      <stockPhotoImageLocation>|B|263775.jpg</stockPhotoImageLocation>
      <transmission>5-Speed Automatic</transmission>
      <vin>19XFB2F57CE027923</vin>
      <drivetrain>FWD</drivetrain>
      <affiliateAgentId>0</affiliateAgentId>
      <primaryFeedSourceId>277</primaryFeedSourceId>
      <sellerName>Ed Napleton Honda</sellerName>
      <sellerEmailAddress>internetleads0620@car-crm.com</sellerEmailAddress>
      <sellerDisplayLabel>Dealer</sellerDisplayLabel>
      <newlyListed>false</newlyListed>
      <vehicleHistoryReportIsFree>false</vehicleHistoryReportIsFree>
      <certifiedPlus>false</certifiedPlus>
      <ncSpotLight>N</ncSpotLight>
      <dealerWebsiteUrl>http://www.ednapletonhonda.com</dealerWebsiteUrl>
      <features>15"" Wheels W/Full Covers, Reclining Front Bucket Seats, Cloth Seat Trim, 160-Watt Am/Fm/Cd Audio System, 4 Speakers, Electronic Stability Control, Front Bucket Seats, Front Center Armrest, ABS Brakes, AM/FM Radio, Air Conditioning, Brake Assist, Bumpers: Body-Color, CD Player, Delay-Off Headlights, Driver Door Bin, Driver Vanity Mirror, Dual Front Impact Airbags, Dual Front Side Impact Airbags, Four Wheel Independent Suspension, Front Anti-Roll Bar, Illuminated Entry, Low Tire Pressure Warning, Mp3 Decoder, Occupant Sensing Airbag, Overhead Airbag, Panic Alarm, Passenger Door Bin, Passenger Vanity Mirror, Power Door Mirrors, Power Steering, Rear Anti-Roll Bar, Rear Window Defroster, Remote Keyless Entry, Security System, Speed Control, Speed-Sensing Steering, Steering Wheel Mounted Audio Controls, Telescoping Steering Wheel, Tilt Steering Wheel, Traction Control, 5-Speed Automatic Transmission, Cylinder Configuration: I-4, Number Of Valves: 16, Rear Hiproom: 1, 306mm (51.4""), Sequential Multi-Point Fuel Injection, Engine Displacement: 1.8 L"</features>
      <dlrRating>5.0</dlrRating>
      <dealerReviewCount>1</dealerReviewCount>
      <location>41.719719,-87.765388</location>
      <streetAddress>5800 W 95th St</streetAddress>
      <customerId>173</customerId>
   </listings>
   <listings>
   ......
    </listings>
   <breadCrumbs>
      <name>mkId</name>
      <displayName>Make</displayName>
      <id>28425</id>
      <isMultiCriteriaPseudoBc>false</isMultiCriteriaPseudoBc>
      <values>
         <name>Honda</name>
         <value>20017</value>
      </values>
   </breadCrumbs>
   <breadCrumbs>
   .....
   </breadCrumbs>
   <refinements>
      <name>lrgPriceId</name>
      <id>28437</id>
      <isMultiSelect>true</isMultiSelect>
      <showAllRefValues>false</showAllRefValues>
      <values>
         <name>$15,001-$20,000</name>
         <id>28644</id>
         <count>577</count>
         <properties>
            <entry>
               <key>DGraph.Bins</key>
               <value>577</value>
            </entry>
            <entry>
               <key>lbound</key>
               <value>15001</value>
            </entry>
            <entry>
               <key>ubound</key>
               <value>20000</value>
            </entry>
         </properties>
      </values>
      <values>
         <name>$20,001-$30,000</name>
         <id>28643</id>
         <count>658</count>
         <properties>
            <entry>
               <key>DGraph.Bins</key>
               <value>658</value>
            </entry>
            <entry>
               <key>lbound</key>
               <value>20001</value>
            </entry>
            <entry>
               <key>ubound</key>
               <value>30000</value>
            </entry>
         </properties>
      </values>
      <values>
         <name>$30,001-$40,000</name>
         <id>28642</id>
         <count>1</count>
         <properties>
            <entry>
               <key>DGraph.Bins</key>
               <value>1</value>
            </entry>
            <entry>
               <key>lbound</key>
               <value>30001</value>
            </entry>
            <entry>
               <key>ubound</key>
               <value>40000</value>
            </entry>
         </properties>
      </values>
      <values>
         <name>Not Priced</name>
         <id>28874</id>
         <count>82</count>
         <properties>
            <entry>
               <key>DGraph.Bins</key>
               <value>82</value>
            </entry>
            <entry>
               <key>ubound</key>
               <value>-999</value>
            </entry>
         </properties>
      </values>
   </refinements>
   <refinements>
   .....
   </refinements>
   <returnCode>
      <code>SUCCESS</code>
      <message>Inventory Search Successfully Executed</message>
   </returnCode>
</searchResultBO>
Test
Method Type: 
POST
Endpoint URI: 
https://api.cars.com/InventorySearchService/1.0/rest/partner/inventory/search