Skip to content

Ecommerce Search Developer Overview

In this article we will look at Ecommerce Search from a developers perspective and provide you with the overview and references you need to get started.

Before getting started

In this concept article you can find a overview of Ecommerce Search, delving into its fundamental concepts and detailing its key features. If you haven't already, we highly recommend reading it to ensure you're well-equipped with the foundational knowledge needed to make the most out of this article.

Also, this article provides a comprehensive technical overview of the Bizzkit platform, including its Ecommerce Search functionality, which could be of interest to you.

Finally, it's crucial to understand our release policy. Kindly go through this article where you'll find detailed information about specific releases, modifications, instructions for upgrades, and more.

Creating a test environment in Docker

All Bizzkit applications can be run in docker which makes it easy to set up a local environment for test, demo and development. Please refer to this article for more information.


In the heart of Ecommerce Search lie three distinct APIs: Admin, Search, and Courier. Each API serves a unique purpose, forming an interconnected system that delivers robust functionality.

The Admin API is for managing various aspects of Ecommerce Search. From curating dictionaries and parameters to handling products and SKUs, the Admin API provides you with the tools you need to configure and maintain your search system, ensuring that it aligns perfectly with your specific needs and the needs of your customers.

Click here for the Admin API Swagger reference

The Search APIs primary role is to provide powerful search capabilities, offering suggestions and 'did-you-mean' features to enhance the user experience. A key recommendation for developers is to leverage the unified endpoint, a streamlined interface that allows you to access and manage all available search features effectively. Unique among all the APIs, the Search API also is accessible directly through a frontend client.

Click here for the Search API Swagger reference

The Courier API is offering a way for incorporating data from Bizzkit applications like the CMS, third-party sources like Google Analytics and Raptor Services into Ecommerce Search. By using the Courier API, developers can enhance the depth and breadth of their search data, enriching the user experience and providing more personalized, relevant search results.

Click here for the Courier API Swagger reference

Every API endpoint and schema is thoroughly documented within the code. This makes their usage in development environments or via Swagger highly intuitive and efficient.

REST clients

In order to facilitate seamless integration and application development, we provide pre-packaged solutions in the form of NuGet packages. These include auto-generated .NET clients designed to streamline your work process. One of the notable features of these packages is their inbuilt authentication mechanism, which significantly simplifies the process of securing your applications and data.

For developers working with JavaScript-based applications, we offer an auto-generated TypeScript client specifically tailored for the Search API. This allows you to harness the powerful features of our Search API directly within your TypeScript applications, reducing the need for manual API calls and enhancing your development efficiency. Contact your Bizzkit representative to get access to our NPM-feed.

Click here for more information about the packages and how to create a client, and contact your Bizzkit representative to get access to our package feed.

Nevertheless, our API conforms to the standard REST architectural style, enabling you to develop customized clients that can seamlessly integrate within your existing technology stack.

Job Runners

Complementing these APIs are two job runners powered by Hangfire. In Ecommerce Search, Hangfire is leveraged to manage tasks for both the Ecommerce Search Admin API and the Courier API, ensuring that your system runs smoothly and efficiently, even when handling complex tasks or dealing with large volumes of data.

Setting up

To get started with an Ecommerce Search installation you need to create segments, scopes, parameters, etc. In the menu you can find links to:

Ingesting data

When you ingest data to Ecommerce Search you need information about products, SKUs, etc:


When searching you need information about text analysis, sorting, etc:

Other resources

We highly recommend that you also take a close look at Tutorials section for practical guides and further insights.