Home > widget-integration > InstantSearchAPI > buildWidgetRequestParams

InstantSearchAPI.buildWidgetRequestParams() method

Build the raw request parameters object for a suggestion API call.

Primary extension point for TS teams who need to inject custom search parameters, override default values, or add shop-specific query flags without re-implementing the full getSuggestions() method.

Called by getSuggestions() before buildQueryParams() serialises to URL.

Signature:

protected buildWidgetRequestParams(params: SuggestionRequestParams, settings: Partial<SearchSettings$1>, customParams?: Record<string, unknown>): Record<string, unknown>;

Parameters

Returns:

Record<string, unknown>

Plain object ready for buildQueryParams() serialisation

Example

window.boostWidgetIntegration.extend('InstantSearchAPI', (InstantSearchAPI) => {
  return class CustomAPI extends InstantSearchAPI {
    protected buildWidgetRequestParams(params, settings, customParams) {
      const base = super.buildWidgetRequestParams(params, settings, customParams);
      // Always include a custom collection filter for this shop
      return { ...base, collection: 'frontpage' };
    }
  };
});