Sign in

v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB
Navigation

Grouped navigation

Service that returns all the required grouped information for navigating through products.

get/navigation/grouped/{instancekey}

Path parameters

instancekeystring required

Instance specific key.

Query parameters

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_use_filtersboolean

Whether or not navigation urls returned in the response use the tn_filters parameter (?tn_filters=brand%3DCoca%20Cola%26volume%3D1L, instead of ?tn_fk_brand=Coca%20Cola&tn_fk_volume=1L).

Example: ?tn_use_filters=true

tn_filtersstring

A list of key/value pairs of the filters that should be applied. 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_filters=brand%3DCoca%2520Cola%257CPepsi%26volume%3D1L%257C1.5L

tn_sortstring

Sorting the results. The XML returns the values which can be used for sorting. Descending sorting (DESC) is indicated with a - before the value.

Example: ?tn_sort=-name

tn_pnumber

The page number of the page that must be displayed.

Example: ?tn_p=14

tn_psnumber

The number of products that must be displayed per page. The standard value is configured at shop level. Only use this parameter to overrule this standard configured quantity.

Example: ?tn_ps=25

tn_ftnumber

Explicitly specify the ID of the filter template to use. This will overrule any filter template that would otherwise be applied.

Example: ?tn_ft=2

tn_stnumber

Explicitly specify the ID of the sorting template to use. This will overrule any sorting template that would otherwise be applied.

Example: ?tn_st=4

tn_bnumber

Explicitly specify the ID of the builder to use. This will overrule any builder that would otherwise be applied.

Example: &tn_b=8

tn_langstring

Specify the language to use for localized texts in the response and search algorithms.

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

Example: ?tn_lang=nl

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_profilekeystring

The profile key is an identifier for the person browsing your website who is initiating the navigation requests. This same identifier should also be used to identify the visitor when sending events to our Analytics API. Based on the sent events, the visitor can receive personalized results.

The profile key can be any string as long as it is unique to the visitor. Generate for example a Universally Unique Identifier (UUID), a new id per visitor or use an account id.

Example: ?tn_profilekey=ff106b0a-b5bf-43fc-945c-318f17cda425

tn_edc_parametersstring

Extra parameters for external data components can be added to the URL by using the parameter 'tn_edc_parameters'.

For example, to send 2 extra parameters: 'firstParameter' and 'secondParameter' to external data components, using the following string: firstParameter=firstValue&secondParameter=secondValue

This value should then be URL encoded.

Example: ?tn_edc_parameters=firstParameter%3DfirstValue%26secondParameter%3DsecondValue

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

Response with all the required grouped information for navigating through products.

Example response

{
  "facets": [
    {
      "facetsettings": {
        "facetid": 123
      }
    }
  ]
}