API Documentation

Vehicles

A controller for getting vehicles.

APIDescription
GET vehicles/{id}/similar/count/secondary?path={path}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns the number of vehicles similar to vehicle identified by . Calling this method will cause a preparation for the /vehicles method for which the optional , and parameters should be provided.
GET vehicles/{id}/similar/count?path={path}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns the number of vehicles similar to vehicle identified by . Calling this method will cause a preparation for the /vehicles method for which the optional , and parameters should be provided.
GET vehicles/{id}/similar?path={path}&skip={skip}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns a list of vehicles similar to vehicle identified by . The vehicle may be deleted.
GET vehicles/{id}?b2b={b2b} Returns a single vehicle.
GET vehicles/{vehicleId}/similar-search-link Returns a browse-similar börse deep-link for a (typically sold) reference vehicle (AM-7040). AM calls this with the group apikey + the sold vehicle id when a lead has no alternative attached; PixelGPT renders in the reply. Never returns a filter deep-link unless the dealer's börse is genuinely query-deep-linkable — hashbang / unknown-style dealers, no domain, or zero matches yield deepLinkSupported:false and/or url:null so the caller omits.
GET vehicles/byids?ids[0]={ids[0]}&ids[1]={ids[1]} Returns a list of vehicles filtered by the provided selection model.
GET vehicles/byvin/{vin}?b2b={b2b} Returns a single vehicle.
GET vehicles/count/bymodelgroups?modelgroups[0]={modelgroups[0]}&modelgroups[1]={modelgroups[1]}&template={template}&path={path} Returns the number of vehicles which match the provided array of s. The model groups must be passed as an array using the json property named modelgroups.
GET vehicles/count/byseries?series[0]={series[0]}&series[1]={series[1]}&template={template}&path={path} Returns the number of vehicles which match the provided array of s. The models must be passed as an array using the json property named series.
GET vehicles/count/byvariants?variants[0]={variants[0]}&variants[1]={variants[1]}&template={template}&path={path} Returns the number of vehicles which match the provided array of s. The variants must be passed as an array using the json property named variants.
GET vehicles/count/secondary?path={path}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns the number of vehicles which match the provided . Calling this method will cause a preparation for the /vehicles method for which the optional , and parameters should be provided.
GET vehicles/count?path={path}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns the number of vehicles which match the provided . Calling this method will cause a preparation for the /vehicles method for which the optional , and parameters should be provided.
GET vehicles/counts?selections={selections}&template={template}&path={path} Returns the number of vehicles which match the provided array of s. The models must be passed as an array using the json property named selections.
GET vehicles/ids?path={path}&skip={skip}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns a list of vehicle ids filtered by the provided selection model.
GET vehicles/promotions/{promotionType}?skip={skip}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns a list of vehicles filtered by the provided selection model.
GET vehicles?path={path}&skip={skip}&take={take}&orderBy={orderBy}&orderDir={orderDir} Returns a list of vehicles filtered by the provided selection model.