Get Dealerships Inventory

The "Get Dealerships Inventory" API endpoint allows you to retrieve comprehensive inventory data for a specific dealership within HeyAutos syndication network.

Endpoint

https://server.heyauto.com/outbound-syndication/{dealershipId}

A GET request to /outbound-syndication/{dealershipId} will retrieve active inventory for the dealership with the provided dealershipId.

Headers

Header	Description	Example
Authorization	API key for authentication purposes	Bearer <YOUR_API_KEY>

Path Parameters

Header	Description	Example	Request Example
dealershipId	A Dealership ID	9ef21ce4-3d25-42d9-b61c-8a7f302e8e07	https://server.heyauto.com/outbound-syndication/9ef21ce4-3d25-42d9-b61c-8a7f302e8e07

Query String

Header	Description	Example	Request Example
limit	Number of results to return	100	https://server.heyauto.com/outbound-syndication/{dealershipId}?limit=100
offset	Number of results to skip	100	https://server.heyauto.com/outbound-syndication/{dealershipId}?limit=100&offset=100

Responses

Header	Description	Type
vehicles	An array of vehicles	Array<Vehicle>
count	Total number of vehicles	Integer

Header	Description	Type
statusCode	Response Status Code	Integer
error	Error Message	String
message	Detailed Error Message	String

Vehicle Type

Attributes	Optional	Description
vin	Required	The vehicle identification number.
make	Required	The vehicles make, validated against acceptable vehicle makes.
model	Required	The vehicles model.
year	Required	The vehicles year.
condition	Required	The condition of the vehicle, "new" for new vehicles and "used" for used vehicles.
price	Optional	The vehicles price in CAD.
salePrice	Optional	The vehicles sale price in CAD. This is the full price of the vehicle on sale; if present, it will be used instead of the price.
msrp	Optional	The vehicles Manufacturer Suggested Retail Price (MSRP) in CAD.
dealershipId	Required	The vehicles Dealership ID.
stockNumber	Optional	The vehicles stock number, an internal identifier for the dealership.
trim	Optional	The vehicles trim, validated against acceptable trims. Values not recognized as trims will be removed from the vehicle in HeyAutos system.
description	Optional	The vehicles description, as provided by the dealership, subject to validation and moderation.
mileage	Optional	The vehicles mileage in kilometers.
body	Optional	The vehicles body type.
exteriorColor	Optional	The vehicles exterior color.
interiorColor	Optional	The vehicles interior color.
transmission	Optional	The vehicles transmission type.
engine	Optional	The vehicles engine details.
passengerLimit	Optional	The maximum number of passengers the vehicle can accommodate.
cylinder	Optional	The number of cylinders in the vehicles engine.
doorCount	Optional	The number of doors the vehicle has.
drivetrain	Optional	The vehicles drivetrain type.
fuelType	Optional	The vehicles fuel type.
cityFuelEconomy	Optional	The city fuel economy in Liters per 100km.
hwyFuelEconomy	Optional	The highway fuel economy in Liters per 100km.
options	Required	The options a vehicle has.
imgs	Required	The images a vehicle has.