Retrieve auto-suggest results by encoding options in the query string. Ideal for lightweight integrations where a request body is not convenient.
Optional customer group identifier for segment-specific responses.
E-commerce provider for contextualizing the API call (e.g., shopify, magento, etc.).
Comma-separated list of fields to include in the response
Specifies the language or region for the response data
Identifier of the store within the e-commerce platform.
Sales or distribution channel identifier.
Currency code for price displays.
Whether to include metadata about the fields in the response. If true, returns metadata for each filterable field.
Identifier for the regional location from the BigCommerce admin panel.
Unique identifier for the user. Id or user email.
Identifier for the user's session id
Whether to show the auto-suggester term.
Limit for the number of auto-suggester terms to return.
Whether to show product category name suggestions.
Whether to include the number of products per category
Max number of categories to return.
Whether to Include popular search phrases.
Max number of popular searches to return.
Whether to show user’s recent search history.
Max number of recent searches to return.
Whether to show matching content pages in the result
Max number of content pages to return.
Comma-separated list of fields to include for content pages
Whether to show products in the result
Max number of product suggestions to return.
Logical filter expression to narrow results
The search term for generating suggestions or results
Whether to auto-correct misspellings in the search term.
Whether to include/ exclude/ bury out-of-stock items (INCLUDE / EXCLUDE / BURY)
INCLUDE
, EXCLUDE
, BURRY
Whether this is a preview mode request. If true, the suggestions returns in preview mode.
Auto-suggest results via query parameters.
The response is of type object
.