Home > widget-integration > FilterAPI > buildSearchPageParams

FilterAPI.buildSearchPageParams() method

Builds parameters for the API request from store state and additional params. Uses a functional pipeline approach to transform parameters through multiple stages.

This method orchestrates the entire parameter building process by applying transformations for sorting, pagination, device detection, customer data, filters, and shop-specific settings. Override this method to customize the parameter building pipeline for shop-specific requirements.

Signature:

buildSearchPageParams(additionParams?: Record<string, unknown>, modifyParams?: ((params: FilterAPIParams) => FilterAPIParams) | null): FilterAPIParams;

Parameters

Returns:

FilterAPIParams

Built parameters object ready for API request

Example

Extend to add custom shop-specific parameters:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class CustomFilterAPI extends FilterAPI {
    protected buildParams(additionParams, modifyParams) {
      const params = super.buildParams(additionParams, modifyParams);
      // Add shop-specific discount parameters
      if (this.customerHasVIPStatus()) {
        params.vip_pricing = true;
        params.discount_tier = 'premium';
      }
      return params;
    }
  };
});