Autocomplete

get

https://gateway.tweakwisenavigator.com/autocomplete/{instancekey}

Service that returns product results and search suggestions based on a search term. This service can be called as soon as the user begins to type a search term.

Path Params

instancekey

string

required

Instance specific key.

Query Params

tn_q

string

required

Search term entered by the user.

Maximum length: 100

tn_cid

string

The category that should contain the filtered results. If you want to provide the entire path, you should include the categories divided by a hyphen (-).

Example: ?tn_cid=100-150

tn_items

boolean

Display product suggestions.

Default value: true

tn_suggestions

boolean

Display keyword suggestions.

Default value: true

tn_instant

boolean

Use instant search.

Default value: false

tn_maxresults

number

The number of results that will be returned per component.

Default value: 6

Maximum value: 20

tn_lang

string

Specify the language to use for the search algorithms.

All available languages can be retrieved with the catalog call: /catalog/languages/{instancekey}

Example: ?tn_lang=nl

tn_keyboard

string

Specify the keyboard to use for the search algorithms.

All available options are: 'qwerty', 'azerty' or 'qwertz'

Example: ?tn_keyboard=azerty

tn_parameters

string

Hidden parameters can be added to the URL by using the parameter 'tn_parameters'. The key is the facet URL-name. The value is the facet value that should be applied. When using multiple values they should be separated using a pipe (|).

When filtering drinks by property 'brand' with value 'Coca Cola' or 'Pepsi' and 'volume' 1L or 1.5L, the value of tn_parameters should be: brand=Coca Cola|Pepsi&volume=1L|1.5L

Example: ?tn_parameters=brand%3DCoca%20Cola%7CPepsi%26volume%3D1L%7C1.5L

tn_parameters_except

string

Hidden exclusion parameters can be added to the URL by using the parameter 'tn_parameters_except'.

This is used to exclude certain parameters from the results (show everything except specified parameters)

When filtering by property 'brand' with value 'Coca Cola' or with value 'Pepsi' the value of tn_parameters_except should be: brand=Coca Cola&brand=Pepsi

This value should then be URL encoded.

Example: ?tn_parameters_except=brand%3DCoca%20Cola%26brand%3DPepsi

tn_options

array of strings

A comma-separated list of toggles.

NoBuilder: Prevents the configured builder from being applied; handles the request as if no builder were configured.", "?tn_options=NoBuilder
NoEDC: Prevents calls to External Data Components configured in builders; handles the request as if no External Data Components were configured.", "?tn_options=NoEDC

tn_options

Headers

TWN-Source

string

Defaults to Tweakwise API docs

The source of the request. See the article on the request source for more information.

Responses

401

Invalid instancekey supplied

200Collection of autocomplete results