Search module - Bloomreach Experience - Open Source CMS

Search module

The Search module exposes Bloomreach Commerce Search's core functionality, delivering the most relevant results from your product catalog to every visitor of your site. This module includes web services, a JavaScript API, and sample code.


Web services 

The core functionality of Bloomreach search is exposed through JSONP web services. While you can integrate directly with the web services, you might find it more convenient to work with a JavaScript API.


JavaScript API

By adding a Bloomreach-hosted JavaScript library to your site (br-mob.js), you have access to a jQuery plugin that takes care of the legwork to communicate with JSONP web services. There's no need to worry about constructing correctly-formatted requests, implementing padding functions, or parsing serialized data.

The API needs just these items:

  • Search parameters encoded in a URL
  • Callback function defined to provide a list of results and available filters


Sample code

Bloomreach provides sample code for the implementation of the JavaScript API. The sample code performs the following functions:

  • Changes the URL without having to load a new page by using the HTML5 History API to connect the Autosuggest Module with the Search Module.
  • Replaces the previous content with Bloomreach search results by rendering the results to a new element on the page with the callback function.

This configuration of the JavaScript API pulls data from one of Bloomreach's dedicated servers.


What are you interested in today?

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?