Home > widget-integration > FilterAPIAdditionParams

FilterAPIAdditionParams type

Additional options for customizing filter API requests.

Provides hooks for Technical Support teams to modify request parameters, control response format, and specify pagination behavior.

Signature:

export type FilterAPIAdditionParams = {
	responseType?: "json" | "html";
	modifyParams?: ((params: FilterAPIParams) => FilterAPIParams) | null;
	additionParams?: Record<string, unknown>;
	behavior?: "more" | "previous" | "replace";
	inCollectionSearchFocusing?: boolean;
	widgetId?: string;
};

References: FilterAPIParams

Remarks

The modifyParams callback is particularly useful for adding shop-specific parameters or transforming filters before sending to the API.

Example

Add custom parameters to every filter request:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class extends FilterAPI {
    async getProductByFilter(params, additions) {
      const customAdditions = {
        ...additions,
        modifyParams: (params) => ({
          ...params,
          shop_id: this.getShopId(),
          customer_tag: this.getCustomerTag()
        })
      };
      return super.getProductByFilter(params, customAdditions);
    }
  };
});