v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB
Guided selling

Funnel

Service that makes it possible to filter the products questioningly and only the products that meet the filter values will be shown. The result contains the questions with their answers and products which are the result of the selected answers. Additionally a navigation url is provided to go to a navigation page with selected filters for the funnel with selected answers.

get/filterwizard/{instancekey}

Path parameters

instancekeystring required

Instance specific key.

Query parameters

codestring required

Funnel code.

catidnumber

The category which must contain the results found.

Example: ?catid=100

answersobject

Answer(s) to questions formatted as key-value pairs.

The key of the question being answered has format qs{n}, where n is the ID of the question being answered.

The value contains the ID(s) of the answer(s) to the question. When multiple answers are provided, they should be separated by a comma (,).

Example: ?qs1=1%2C2&qs2=3

{
  "qs1": "1,2",
  "qs2": "3"
}
skip_qsnumber[]

Collection of skipped questions.

Example: ?skip_qs=2%2C4%2C6 or ?skip_qs=2&skip_qs=4&skip_qs=6

takenumber

Maximum desired amount of products.

skipnumber

Amount of products to skip (useful for paging).

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

Headers

TWN-Sourcestring

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

Response

Response with questions, their answers and resulting products of selected answers. Additionally a navigation url is provided to go to a navigation page with selected filters for the funnel with selected answers.

codestring

Code of the filter wizard

namestring

Name of the filter wizard

countinteger

Count of items

navigationurlstring

Navigation URL

filtertemplateidinteger

ID of the filter template