Merchandisable Vehicles Suggest
get
/v2/vehicles/suggest
Vehicle suggestions based on search query
https://api.fortellis.io/sales/inventory/merchandisable-vehicles-composite
/v2/vehicles/suggest
Resource Details
|
Security |
|
|---|---|
|
Category |
Suggest - controller |
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| csStoreId | string | n/a | No |
| locale | string | n/a | No |
| ownerStoreId | string | n/a | No |
| region | string | n/a | No |
| searchQuery | string | free form text based on which api should vend out suggestions | Yes |
| webId | string | n/a | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Accept | string | n/a | No |
| Accept-Charset | string | n/a | No |
| Accept-Language | string | n/a | No |
| If-Match | string | n/a | No |
| If-None-Match | string | n/a | No |
| Prefer | string | Mention required fields | No |
| Request-Id | string | Unique tracking id | No |
| Subscription-Id | string | The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. | Yes |
| Authorization | string | Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. | Yes |
Request Body Structure
Request Body Example
Response
Response Body Structure
Response Body Example
Response Error Details
| HTTP Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Try It Out
-
csStoreId
(string)
-
locale
(string)
-
ownerStoreId
(string)
-
region
(string)
-
searchQuery
(required)(string) free form text based on which api should vend out suggestions
-
webId
(string)
-
Accept
(string)
-
Accept-Charset
(string)
-
Accept-Language
(string)
-
If-Match
(string)
-
If-None-Match
(string)
-
Prefer
(string) Mention required fields
-
Request-Id
(string) Unique tracking id
-
Subscription-Id
(required)(string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.
-
Authorization
(required)(string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.
Working...
x