Algolia

Last updated:
Edit on GitHub

algolia-hero

Spryker comes with Elasticsearch as the default search engine, but you can replace it with Algolia. Algolia stands out for its high performance. With the Algolia ACP app, your users can perform advanced searches for active concrete products or content in your store.

To use Algolia as your search engine, you need an Algolia account. For details about integrating Algolia, see Integrate Algolia.

Searchable attributes

Your users can search for active concrete products by the following attributes:

  • SKU
  • Name
  • Description
  • Keywords

Additionally, the Algolia ACP App supports searching content (CMS pages) and indexed documentation (PDFs). To index documentation (PDFs), you must use the Algolia Crawler. In the Algolia Dashboard, you can configure other attributes to be searchable.

In search results, Spryker groups all concrete products belonging to the same abstract product. Depending on your configuration, it can also display results for Pages and Documents.

Indexes

An index is where Algolia stores data.

For a Spryker store, the index contains all active concrete products that can appear in search results. If configured, a separate index is created for CMS pages. To create an index for Documents, you must use the Algolia Crawler.

There are separate indexes for each locale and sorting strategy. With the Algolia app, search results in your store can be sorted by:

  • Relevance (primary index)
  • Name (ascending and descending)
  • Rating (highest to lowest, products only)
  • Price (ascending and descending, products only)

For example, for products if you have two locales, there will be 12 indexes for your store in Algolia — one for each locale and sorting strategy:

algolia-indexes

The Algolia index is always kept up to date with products and CMS pages changes. If a Back Office user adds or changes a searchable product attribute, such as a description, the change is immediately reflected in Algolia search results.

How products are stored in Algolia

Here is an example of product data stored in Algolia:

{
  "sku": "017_21748906",
  "name": "Sony Cyber-shot DSC-W800",
  "abstract_name": "Sony Cyber-shot DSC-W800",
  "description": "Styled for your pocket Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There's a range of modes to choose from – you don't even have to download image-editing software.",
  "url": "/en/sony-cyber-shot-dsc-w800-17",
  "product_abstract_sku": "017",
  "rating": 4.5,
  "keywords": "Sony,Entertainment Electronics",
  "images": {
    "default": [
      {
        "small": "https://images.icecat.biz/img/norm/medium/21748906-Sony.jpg",
        "large": "https://images.icecat.biz/img/norm/high/21748906-Sony.jpg"
      }
    ]
  },
  "category": [
    "Demoshop",
    "Cameras & Camcorders",
    "Digital Cameras"
  ],
  "label": [],
  "hierarchical_categories": {
    "lvl0": "Demoshop",
    "lvl1": "Demoshop > Cameras & Camcorders",
    "lvl2": "Demoshop > Cameras & Camcorders > Digital Cameras"
  },
  "attributes": {
    "brand": "Sony",
    "color": "Silver",
    "digital_zoom": "40 x",
    "internal_memory": "29 MB",
    "optical_zoom": "5 x",
    "upcs": "0013803252897",
    "usb_version": "2"
  },
  "merchant_name": [ // Marketplace only
    "Video King",
    "Budget Cameras"
  ],
  "merchant_reference": [ // Marketplace only
    "MER000002",
    "MER000005"
  ],
  "search_metadata": [], // Field for project-specific attributes.
  "concrete_prices": {
    "eur": {
      "gross": 345699,
      "net": 311129
    },
    "chf": {
      "gross": 397554,
      "net": 357798
    }
  },
  "prices": {
    "eur": {
      "gross": 345699,
      "net": 311129
    },
    "chf": {
      "gross": 397554,
      "net": 357798
    }
  },
  "objectID": "017_21748906"
}

Next step