---
title: "Products"
method: GET
path: "/products/{instancekey}"
tags: ["Products"]
---

# Products

`GET /products/{instancekey}`

Service that returns all the required information for receiving products.

## Path parameters

- `instancekey` string, required

## Query parameters

- `tn_q` string
- `tn_cid` string
- `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_keyboard` string
- `tn_profilekey` string
- `tn_edc_parameters` string
- `tn_options` string[]

## Headers

- `TWN-Source` string

## Response `200`

Response with all the required information for navigating through products.

- ProductsResponse
  - `items` NavigationItem[]
    - `visualproperties` Visualproperties
      - `colspan` integer — The number of columns the item takes up.
      - `rowspan` integer — The number of rows the item takes up.
    - `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
  - `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

## 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)