Suggest API

get

https://{siteId}.a.athoscommerce.net/v1/suggest

If applicable, will return a suggestion and alternate suggestions to be displayed to the shopper as alternate search queries to pass to the Autocomplete API to source results.

Query Params

siteId

string

required

Unique identifier to associate the Athos account making the request to the database. This can be found on the My Account page in the Athos Search and Discovery Console under the Account details section.

string

Query value will search the index for terms that match the query.

language

string

Defaults to en

Determine the language model that is used for spell corrections.

suggestionCount

integer

Defaults to 4

Limits the number of possible suggestions that will be returned by our API. These values will be shown to the shopper on the frontend to select. If the shopper selects a suggestion it will be passed to the Autocomplete API request as the q parameter.

productCount

integer

Defaults to 20

Applying this parameter will limit the number of items the Suggest API will scan in order to find matches against the query parameter that is passed. During a scan the Suggest API will attempt to match the query parameter against the Name and SKU core fields.

Responses

400

Bad Request

404

404 Not Found

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK