--- title: "Grouped navigation" method: GET path: "/navigation/grouped/{instancekey}" tags: ["Navigation"] --- # Grouped navigation `GET /navigation/grouped/{instancekey}` Service that returns all the required grouped information for navigating through products. ## Path parameters - `instancekey` string, required ## Query parameters - `tn_cid` string - `tn_use_filters` boolean - `tn_filters` string - `tn_sort` string - `tn_p` number - `tn_ps` number - `tn_ft` number - `tn_st` number - `tn_b` number - `tn_lang` string - `tn_parameters` string - `tn_parameters_except` string - `tn_profilekey` string - `tn_edc_parameters` string - `tn_options` string[] ## Headers - `TWN-Source` string ## Response `200` Response with all the required grouped information for navigating through products. - NavigationGrouped - `facets` NavigationFacet[] - `hasmoreattributes` boolean, nullable - `facetsettings` NavigationFacetSettings - `facetid` integer — Facet id - `isvisible` boolean — true/false to indicate if facet is visible - `attributename` string — Name of the attribute corresponding to the facet - `urlkey` string — URL Key of facet - `title` string — Title of facet - `iscollapsible` boolean — true/false to indicate if facet is collapsible - `iscollapsed` boolean — true/false to indicate if facet is collapsed - `nrofshownattributes` integer — Number of shown attributes - `expandtext` string — Text for the button or link that expands the facet - `collapsetext` string — Text for the button or link that collapses the facet - `ismultiselect` boolean — true/false to indicate if facet is multiselectable - `showselectedfirst` boolean — true/false to indicate if selected values are at the top of the facet - `multiselectlogic` string — Indicates whether conjunction logic (and) or disjunction logic (or) is used when selecting multiple values in a multiselect facet - `selectiontype` string — Type of selection for this facet. This could be checkbox, slider, tree or link - `nrofcolumns` integer — This field is deprecated and only in the response for backwards compatibility - `isnrofresultsvisible` boolean — true/false to indicate if number of resulting items is visible - `isinfovisible` boolean — true/false to indicate if info text should be displayed - `containsclickpoints` boolean — true/false to indicate if slider is type clickpoint - `containsbuckets` boolean — true/false to indicate if slider is type bucket - `infotext` string — Facet information text - `source` string — Source of the attribute corresponding to the facet - `issearchable` boolean — true/false to indicate if search is available within the facet - `searchplaceholder` string — Placeholder text for the facet search - `searchnoresultstext` string — Text for when there are no results for the facet search - `prefix` string — Attributes prefix - `postfix` string — Attributes postfix - `cssclass` string — Attributes css class - `attributes` NavigationFacetAttribute[] - `title` string — Title of the attribute - `alternatesortorder` integer, nullable — Alternate sort order - `isselected` boolean — true/false to indicate if attribute is selected - `nrofresults` integer — Resulting number of items when attribute is selected - `attributeid` integer, nullable — Attribute id - `url` string — Complete navigation url after selecting or deselecting value - `link` string — Optional landingpage url to which the user will navigate after selecting this value, this takes precedence over the url property - `imagetag` string — Tag of the image - `children` object[] — Recursive list of child attributes - `clickpoints` Clickpoint[] - `value` string — Value of clickpoint - `buckets` NavigationFacetBucket[] - `rangemin` number, double, nullable — Minimum size of bucket - `rangemax` number, double, nullable — Maximum size of bucket - `relativeamount` number, double, nullable — Relative size of bucket - `groups` NavigationItemGroup[] - `code` string — Group code - `items` NavigationGroupItem[] - `type` string — Type of item - `itemno` string — Unique item number - `title` string — Title of item - `price` number, double — Price of item - `brand` string — Brand of item - `url` string — Url of item - `image` string — Image of item - `attributes` NavigationItemAttribute[] - `name` string — Name of an attribute - `values` string[] - `origin` NavigationItemOrigin - `type` string — Type of origin - `name` string — Display name of the origin - `itemreference` string — Item reference for the origin - `visualproperties` Visualproperties - `colspan` integer — The number of columns the item takes up. - `rowspan` integer — The number of rows the item takes up. - `properties` NavigationProperties - `nrofitems` integer — Total number of items - `pagesize` integer — Number of items per page - `nrofpages` integer — Total number of pages - `currentpage` integer — Current selected page - `selectedcategory` integer — Selected category - `selectedcategorykey` string — Selected category key. In case of alphanumeric category identifiers, this field will be populated with the category key. In case of numeric category id's, this field will be populated with the category id. - `searchterm` string — Current search term - `suggestedsearchterm` string — Suggested search term - `isdirectsearch` boolean — true/false to indicate if it's a direct search. It's true when: it's a search page, 1 category is selected and sort options isn't active. - `isrootcategory` boolean — true/false to indicate if the current category is the root category - `pageurl` string — Current page URL without pagination - `reseturl` string — URL to reset all filters - `sortfields` NavigationSortfield[] - `title` string — Internal name of the sort field - `displaytitle` string — Sort field display name - `order` string — Sort field order - `isselected` boolean — true/false to indicate if sort field is selected - `url` string — Navigation URL for selecting the sort field - `redirects` Redirect[] - `url` string — Redirection URL - `searchbanners` NavigationSearchBanner[] - `imageurl` string - `clickurl` string - `clicktarget` string - `type` string - `location` string - `categoryid` string ## Other responses - `401` — Invalid instancekey supplied --- [API](https://skmtc.net/tweakwise/apis/frontend-api.md) · [All operations](https://skmtc.net/tweakwise/apis/frontend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tweakwise/frontend-api/revisions/9bd1e2b3633f/schema)