[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.

Request Information

URI Parameters

NameDescriptionType
vehicleId

The reference (sold) vehicle id.

integer

This value is required and must not be omitted.

Body Parameters

None.

Request Formats

None.

Response Information

Resource Description

The url, result count and deep-link support flag.

An instance of: SimilarSearchLinkResponse
NameDescriptionType
Url

Gets or sets the customer-facing börse url. Deep-linked (filtered) when is true; otherwise the bare börse base ("browse our stock"). null when no usable url could be produced (e.g. no domain).

string

ResultCount

Gets or sets the number of vehicles matching the chosen cascade rung.

integer

Strategy

Gets or sets the cascade rung that produced the result: similar | series+price | make+price | browse-all.

string

DeepLinkSupported

Gets or sets a value indicating whether carries the filter deep-link (true) or is only the bare börse base (false, e.g. Wix / unknown embed style).

boolean

Response Formats

application/json, text/json

Sample:
{
  "url": "sample string 1",
  "resultCount": 2,
  "strategy": "sample string 3",
  "deepLinkSupported": true
}