---
title: "Suggestions v2"
method: GET
path: "/v2/search/suggestions"
tags: ["search-v2"]
---

# Suggestions v2

`GET /v2/search/suggestions`

The endpoint searches and returns:
- categories by their name
- products by their unique ids (reference keys, EANs or internal ids)

The purpose of this endpoint is to provide category suggestions based on the given search term.
Additionally this endpoint might provide product suggestions, but for this to happen there need to be
an exact match between the search term and one of the searchable ids.

The response of the suggestions endpoint can be tuned using the synonyms settings in the SCAYLE panel.

__Word Synonyms__ enable configuration of multiple words as a synonym of a particular word. For example, "babyleggings" can be set as a synonym for "baby leggings". This will ensure that a typeahead search with keyword "babyleggings" points to products that have "baby leggings" in the product specification.

__Category synonyms__ allow mapping of certain words to categories. Example the word "office" can be mapped to a category /women/clothing/blazers. Setting this configuration will ensure that a /typeahead search with the keyword "office" returns the category /women/clothing/blazers.

A detailed explanation of the functionality can be found in [SCAYLE Panel developer guide](/en/developer-guide/products/search#suggestions)

## Query parameters

- `term` string, required
- `with` string[]
- `category.depth` integer
- `category.showHidden` boolean
- `categoryId` integer

## Response `200`

successful operation

- SearchV2SuggestionsResponse
  - `suggestions` union[], required
    - union
      - SearchV2CategoryResponse
        - `type` string, required
        - `categorySuggestion` SearchV2CategorySuggestion, required
          - `category` Category, required
            - `id` integer, required — The unique identifier of the category.
            - `path` string, required — The slugs for all `rootlineIds` combined with `/` (e.g., `/women/fashion`).
            - `name` string, required — The name of the category
            - `slug` string, required — A short string to describe the current category (usable, for example, in URLs as).
            - `parentId` integer, required — The parent category ID (root-level categories have a parent ID of `0`)
            - `rootlineIds` integer[], required — The IDs for the path from the topmost root category to the current category, which is included as the last item.
            - `childrenIds` integer[], required — The child category IDs attached to the current category
            - `properties` CategoryProperty[], required — Properties attached to this category.
              - …
            - `isHidden` boolean, required — A flag that defines if a category should be displayed by the frontend
            - `depth` integer, required — The nesting level of the category (root-level depth = 1, child nodes = 2, child nodes' children = 3, etc.)
            - `supportedFilter` string[], required — A list of filters that can be used for filtering products in the category
            - `parent` Category — recursive
            - `shopLevelCustomData` object, required — Additional category data defined on the shop level
            - `countryLevelCustomData` object — Additional category data defined on the country level
            - `children` Category[] — An array of child category objects. Returned if requested as `tree format` or using `with`.
          - `filters` SearchV2AttributeFilter[], required
            - `type` string, required
            - `attributeFilter` object, required
              - …
      - SearchV2ProductResponse
        - `type` string, required
        - `productSuggestion` SearchV2ProductSuggestion, required
          - `product` Product, required
            - `id` integer, required
            - `advancedAttributes` object
            - `attributes` object
            - `baseCategories` BaseCategory[]
              - …
            - `categories` array[]
              - …
            - `definingAttributes` DefiningAttribute
              - …
            - `images` Image[], required
              - …
            - `customData` ResponseCustomData, required
            - `isActive` boolean, required — Identifies whether a product is active or not
            - `isNew` boolean, required — Identifies whether a product is new or not
            - `isSoldOut` boolean, required — Identifies if a product is still available to sell
            - `masterKey` string, required — Identifies the master product which this product belongs
            - `firstLiveAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
            - `priceRange` PriceRange
              - …
            - `reductionRange` ReductionRange
              - …
            - `lowestPriorPrice` LowestPriorPrice — Information about the lowest price in the past 30 days.
              - …
            - `referenceKey` string, required
            - `searchCategoryIds` integer[]
            - `siblings` Product[] — list of Products
            - `variants` Variant[]
              - …
            - `createdAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
            - `updatedAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
            - `indexedAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00

## Other responses

- `400` — required query parameter missing / query parameter invalid
- `401` — authentication failed

## Changes

- **2026-07-17** `8cfa924ae703` — 1 info
  - endpoint added
- **2023-08-06** `302b7c443b51` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/scayle/apis/storefront-api-documentation/changes/v2/search/suggestions/get.md)

---

[API](https://skmtc.dev/scayle/apis/storefront-api-documentation.md) · [All operations](https://skmtc.dev/scayle/apis/storefront-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scayle/storefront-api-documentation/revisions/8cfa924ae703/schema)