Category tree

Category tree

Service that provides a category tree.

get/categorytree/{instancekey}

Request

  • Base URL
    https://gateway.tweakwisenavigator.com
  • URL
    https://gateway.tweakwisenavigator.com/categorytree/{instancekey}
  • Auth
    none declared

Path parameters

instancekeystring required

Instance specific key.

Query parameters

catidnumber

The starting category for the resulting tree.

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

Headers

TWN-Sourcestring

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

Response

The response contains a collection of root categories. Typically only one root category or starting category exists so this array contains only one category.

Changes

No recorded changes to this operation across all 1 revision of this API.