v1
latestOpenAPI 3.0.32026-07-173196215.4 KBSuggestions v2
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
Query parameters
The term parameter specifies the search term.
The with parameter can be applied to include related resources, for example, the attributes of a product can be attached using with=product.attributes. It is also possible to filter product attributes by key with=product.attributes:key(plusSize) or by type with=product.attributes:type(material_care). Nested includes can also be attached when available with=product.variants.attributes and multiple combinations are likewise accepted with=prodcut.siblings,product.variants,category.children. When using with=category.children, you can provide categoryDepth parameter to increase child depth. In the following table, there is more information about possible includes.
| Include | includes | Available Filters |
|---|---|---|
| product.attributes | key, type | |
| product.advancedAttributes | key, type | |
| product.variants | See available includes for variants at variants endpoint | |
| product.images (default) | images.attributes | |
| product.categories | hidden(true) | |
| product.definingAttributes | ||
| product.siblings | ||
| product.priceRange | ||
| product.reductionRange | ||
| product.lowestPriorPrice | ||
| product.searchCategoryIds | ||
| product.baseCategories | ||
| category.parents | ||
| category.children | ||
| category.properties:name(property_name) |
Defines the number of nested child categories to include in the response.
Include hidden categories in the result.
The categoryId parameter is used to filter the results and limit the returned data to items that belong to the specified category or its child categories.
Response
successful operation