Connect and configure catalog

📌

Phase objective: Connect your data and customize the search experience.

Key tasks

What you do

1. You generate your product feed from your product catalog. Daily generation and delivery of your product/content feed is a required ongoing step.

2. Optional: You generate a delta feed. You can supplement your full product/content feed by delivering a delta feed.

3. You deliver feeds via API or SFTP.

What we do together

1. If you choose SFTP, we set up your delivery location and add the public SSH keys that you share with us.

2. We help determine if you need to supplement your full product feed with a delta feed.

📘

What is feed data?

The feed is the contents of your product or content catalog. Feed data provides critical information that Bloomreach technology needs to act on your content. You can deliver your feed via our Catalog Management APIs.

When you generate your feed, ensure to include all your products or content. If your product or content doesn't exist in your feed, Bloomreach cannot act on it.

1. Prepare product catalog data

• Work with the Bloomreach team to identify the catalog data to be indexed by Bloomreach, including any data you want to be searchable.

• After identifying all the catalog data you want to index and sync with Bloomreach, it’s time to format the data and pass it to Bloomreach. Read these articles to learn how to format catalog data:

  • How to properly format catalog data
  • How to format and send special types of attributes called Reserved attributes
  • Example feed format

• For a Discovery integration with Shopify, BigCommerce, Magento, or Salesforce, contact your Technical Consultant for the latest feed reference architecture (in Beta).

2. Send catalog data (full and delta feeds) via SFTP or API

After formatting the catalog data in the required JSONL format, you must send data to Bloomreach via SFTP or API. Follow this guide on how to send your catalog data.

Send data via SFTP

• If you choose to send catalog data via SFTP, Bloomreach sets up the delivery location.

• You must provide Bloomreach with a public SSH key for the SFTP account. We add the public SSH key to establish a secure connection to the SFTP server.

Send data via API

• The product catalog is ingested and indexed via the Catalog Management API calls.

• You can manage and configure indexed data via the Catalog Management APIs or the Catalog Management dashboard application. These allow you to verify the status of the index job, including any errors and issues that arise while indexing the catalog.

3. Configure product catalog attributes

Custom product attributes can be configured to be facetable, searchable, and returned in the API call. You can manage this configuration on the Attributes page in Catalog Management or via Catalog Management APIs v3.

4. Configure Catalog Settings

Once feed data has been validated, you can configure your feed and indexing settings. You can also configure the catalog’s Search and Autosuggest settings on the Settings page.

5. Validate product catalog

Once the product catalog is sent and indexed, you can validate and test the catalog via the Catalog Management dashboard. Use the Search page of the Catalog Management dashboard to explore and preview the indexed data and the configured search and autosuggest settings.

Resource library