Home > widget-integration > FilterAPI > handleVendorPage

FilterAPI.handleVendorPage() method

Adds vendor parameter when on a vendor-specific page.

Detects if the current page is a vendor page and extracts the vendor name from the URL query parameter 'q', then includes it in the API request. Override to customize vendor detection or add vendor-specific parameters.

Signature:

protected handleVendorPage(params: FilterAPIParams): FilterAPIParams;

Parameters

Returns:

FilterAPIParams

Enhanced parameters with vendor name if on vendor page, unchanged otherwise

Remarks

Vendor Page Detection: - Uses FilterHelper.isVendorPage() to detect vendor pages - Extracts vendor name from URL query parameter 'q' - Common URL format: /pages/vendors?q=vendor-name - Only adds vendor param if 'q' parameter exists

Example

Override to add vendor metadata:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class CustomFilterAPI extends FilterAPI {
    protected handleVendorPage(params) {
      const enhanced = super.handleVendorPage(params);
      // Add vendor ID and metadata
      if (enhanced.vendor) {
        const vendorData = this.getVendorMetadata(enhanced.vendor);
        enhanced.vendor_id = vendorData.id;
        enhanced.vendor_tier = vendorData.tier; // premium, standard, etc.
      }
      return enhanced;
    }
  };
});