Integrations Hub/
Elasticsearch Integration

Integrating with Elasticsearch

You can integrate Elastic Path Commerce Cloud with Elasticsearch quickly and easily in Commerce Manager.

Whenever you publish a catalog, the full catalog will be synced to Elasticsearch. This is triggered using events delivered by a webhook.

  1. When a catalog is published, a catalog-release.updated event is triggered.
  2. Once a catalog-release.updated event is received by the webhook, the integration begins to execute.
  3. The integration performs the following:
    • Builds a taxonomy for the catalog.
    • Retrieves the mapping for Elastic Path Commerce Cloud fields to Elasticsearch fields.
    • Syncs all products to Elasticsearch.

Elasticsearch Prerequisites

You must create an index called search-products in your Elasticsearch instance before configuring the integration in Elastic Path Commerce Cloud.

You must create the index using a join data type. The join data type is a special field that creates parent/child relations within documents of the same index. The relations section defines a set of possible relations within the documents, each relation being a parent name and a child name. See for more information.

    "mappings": {
        "properties": {
            "my_join_field": {
                "type": "join",
                "relations": {
                    "parentID": "childID"

Collecting Your Setup Information

Before you begin configuring your Elasticsearch integration in Commerce Manager, you need to collect the necessary setup information from Elasticsearch and Commerce Manager.

Collect the following information and make sure you have it available, for example, in a text file, before configuring your Elasticsearch integration in Commerce Manager. If you leave the Elasticsearch Integration page in Commerce Manager, the integration is not saved and you must remove the integration and create a new one.

Collecting Elasticsearch Setup Information

You can find this information in the Management section on the Elasticsearch Dashboard.

Admin API TokenYour Admin API Key for your Elasticsearch account.
Indexing EndpointYour Indexing Endpoint for your Elasticsearch account.
Elasticsearch HostYour Elastic Search URL.

Collecting Commerce Manager Setup Information

Collect the following Elastic Path Commerce Cloud API keys. You can find this information in System > Application Keys in Commerce Manager when logged in as a user with Seller Admin privileges.

Elastic Path Commerce Cloud API KeyDescription
API Base URLYour Elastic Path Commerce Cloud API Base URL.
Client IDYour Elastic Path Commerce Cloud Client ID.
Client SecretYour Elastic Path Commerce Cloud Client Secret.

When integrating with third-party providers, we recommend you use the closest region in the third-party service to reduce latency as much as possible. See Regions and URLs table.

Configuring the Integration

Now that you've collected the setup information let's begin by configuring the integration.

  1. In Commerce Manager, go to System > Integrations Hub.
  2. Under EPCC Site Search Integrations click on the Elasticsearch Full Catalog Sync Integration.
  3. Click Configure.
  4. In the text fields, input the setup information you collected previously.
  5. Click Activate.

The integration starts an execution which:

  • Configures a webhook to listen to the catalog-release.updated event, named EPCC Elasticsearch Integration.
  • Creates a flow for containing field mappings between Elastic Path Commerce Cloud and Elasticsearch, called Elasticsearch Mapping.

It is important that you don't delete the Elasticsearch Mapping flow or the EPCC Elasticsearch Integration webhook, or the integration ceases to work.

Now that you've configured the integration, let's learn how you use it.

Understanding Field Mappings Between Elastic Path Commerce Cloud and Elasticsearch

To sync the catalog to Elasticsearch you must map the data to pass from Elastic Path Commerce Cloud to Elasticsearch.

The integration uses a flow to contain the fields that you want to pass from Elastic Path Commerce Cloud to Elasticsearch. These can be any fields you like. There are some special fields and a default set which are created when you first configure the integration. See the table below.

The following table describes some example fields in Commerce Manager and their corresponding fields in Elasticsearch.

Elastic Path Commerce Cloud FieldMaps to Elasticsearch Field
main_imageep_main_image_url in Elasticsearch. You can change the name in Elasticsearch but if you also change the field name in Commerce Manager, the URL lookup function is not triggered.
taxonomyep_categories. This field is used to trigger the creation of a hierarchy in Elasticsearch.

Creating New Field Mappings

  1. In Commerce Manager, go to the Elasticsearch Mapping page under the Flows. (If you just configured your integration, refresh your Commerce Manager tab to pick up the newly added flow from the integration.)
  2. Click New Entry.
  3. Create the field mappings you desire by supplying the EPCC Field and the Elasticsearch Field.
  4. In Elasticsearch, create the fields described above. Refer to the documentation provided with Elasticsearch for more information.

Was this helpful?

Coveo Integration