| effectiveAccountId |
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 |
| includeSuggestedProducts |
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 |
| includeSuggestedTerms |
Boolean |
Specifies whether a request returns search
term suggestions (true) or not (false). If unspecified, defaults to true. The value returned can include recent
or popular term suggestions. At least one of includeSuggestedTerms or includeSuggestedProducts must be set to true. |
Optional |
64.0 |
| maxResults |
Integer |
Maximum number of suggestions. Values are from 1
through 10. If unspecified, defaults to 10. |
Optional |
52.0 |
| maxSuggestedProducts |
Integer |
Maximum number of product suggestions.
Values are from 1 through 10. If unspecified, defaults to 6. |
Optional |
58.0 |
| popularProductsCategoryId |
String |
ID of the category that identifies a
store's popular products. This category can be configured on the search
input component. If popularProductsCategoryId is populated, the search term
for a request is empty, and includeSuggestedProducts is true, product suggestions are returned from the specified
category. If a search term is specified, popularProductsCategoryId is ignored and suggestions are
based on the search term instead. |
Optional |
64.0 |
| searchTerm |
String |
Search term with up to 100 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 |
j