Newer Version Available

This content describes an older version of this product. View Latest

Commerce Webstore Product Search Suggestions

Get suggestions for product searches.
Resource
1/commerce/webstores/webstoreId/search/suggestions
Available version
52.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
effective​AccountId String ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. Optional 52.0
include​Suggested​Products Boolean Specifies whether a search term returns product suggestions (true) or not (false). If unspecified, defaults to false. If true, the service returns the suggested product IDs. Optional 58.0
maxResults Integer Maximum number of suggestions. Values are from 1 through 10. If unspecified, defaults to 10. Optional 52.0
maxSuggested​Products Integer Maximum number of product suggestions. Values are from 1 through 10. If unspecified, defaults to 4. Optional 58.0
searchTerm String Search term with up to 10 characters. If specified, the service returns autocomplete suggestions from the user’s recent searches. If unspecified, the service returns suggestions from the user’s recent searches. Optional 52.0
Response body for GET
Product Search Suggestions Results