Returns search suggestions, category hints, popular/recent queries, content-page matches, and product previews based on a partially typed search term. Supports spell-correction and preview mode.
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.
Identifier for the regional location from the BigCommerce admin panel.
Currency code for price displays.
Whether to include metadata about the fields in the response. If true, returns metadata for each filterable field.
Comma-separated list of fields to include for content pages
Request body
The body is of type object
.
Auto-suggest payload containing terms, categories, products, pages, and more.
The response is of type object
.