Sign in

v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB
Autocomplete

Autocomplete

Deprecated. This endpoint has been replaced by Suggestions. For all new implementations we strongly recommend using the Suggestions endpoints to receive the latest updates, get category suggestions and more. Please review the Suggestions documentation at https://docs.tweakwise.com/reference/suggestions for integration details. 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.

get/autocomplete/{instancekey}

Path parameters

instancekeystring required

Instance specific key.

Query parameters

tn_qstring required

Search term entered by the user.

Maximum length: 100

tn_cidstring

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_itemsboolean

Display product suggestions.

Default value: true

tn_suggestionsboolean

Display keyword suggestions.

Default value: true

tn_instantboolean

Use instant search.

Default value: false

tn_maxresultsnumber

The number of results that will be returned per component.

Default value: 6

Maximum value: 20

tn_langstring

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_keyboardstring

Specify the keyboard to use for the search algorithms.

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

Example: ?tn_keyboard=azerty

tn_parametersstring

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.

Important: double URL-encoding is required.

  1. Build the parameter string — combining keys and values:

    • encode special characters inside values (spaces, +, &, =, etc.)
    • concatenate multiple values using a pipe (|) example: brand=Coca%20Cola%7CPepsi&volume=1L%7C1.5L

  2. URL-encode the entire filter string — because the whole string is passed as a single query parameter value, encode it a second time: brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

  3. Append to the URL: ?tn_parameters=brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

tn_parameters_exceptstring

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). The key is the facet URL-name. The value is the facet value that should be applied.

Important: double URL-encoding is required.

  1. Build the parameter string — combining keys and values:

    • encode special characters inside values (spaces, +, &, =, etc.)
    • concatenate multiple values using a pipe (|) example: brand=Coca%20Cola%7CPepsi&volume=1L%7C1.5L

  2. URL-encode the entire filter string — because the whole string is passed as a single query parameter value, encode it a second time: brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

  3. Append to the URL: ?tn_parameters_except=brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

tn_optionsstring[]

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

Headers

TWN-Sourcestring

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

Response

Collection of autocomplete results

All 182 operations