Note
To use the latest Catalog management API v3, refer to its API reference.
As part of Bloomreach integration, you need to send your catalog data to Bloomreach. For an overview of the integration process, refer to Connect and configure catalog guide.
Product Catalog
To integrate Bloomreach product search via API feed ingestion, follow the steps given below.
Step 1. Format your data
You must format your catalog data properly in order for Bloomreach to ingest it. In this step, you will learn how to format a product record, which contains the data for a single product. We also provide details on how to implement variants and/or views, if your catalog uses them.
- Products
- Variants
- Views
- Variants and Views
Step 2. Send your data
After properly formatting your catalog data, you must send it to Bloomreach for ingestion. There are two modes of delivery:
- PUT (full replacement of catalog data)
- PATCH (partial updates to catalog data)
Catalog data may be sent as an API payload, or as a file sent to a SFTP.
Step 3: Configure Attributes
After sending your data, you can configure your product catalog data attributes such as title, description, price, sku, etc., so that Bloomreach processes your data as you need it, and to configure the APIs.
You can configure Attributes from the Catalog Management Tab.
Step 4. Publish the index
You must publish the index in order to query your catalogs with our Search APIs. Make sure to deploy the Product Search API.
Content Catalog
To integrate Bloomreach content search via API feed ingestion, follow the steps given below.
Step 1. Format your data
You must format your catalog data properly in order for Bloomreach to ingest it. In this step, you will learn how to format an item record, which contains the data for a single content item. We also provide details on how to implement views, if your catalog uses them.
- Sample Feed
- Attributes
- Views
Step 2. Send your data
After properly formatting your catalog data, you must send it to Bloomreach for ingestion. There are two modes of delivery:
- PUT (full replacement of catalog data)
- PATCH (partial updates to catalog data)
Catalog data may be sent as an API payload, or as a file sent to a SFTP.
Step 3: Configure Attributes
You can configure your product catalog data attributes such as title, description, etc. so that Bloomreach processes your data the way you need it. Work with your Bloomreach representative to configure the required attributes.
Step 4. Publish the index
You must publish the index in order to query your catalogs with our Search APIs. Make sure to deploy the Content Search API.
Run in Postman
Easily import the Discovery API collection and try the endpoints in Postman. It offers many examples of how the endpoints can be used for different use cases.
Follow this quick step-by-step guide to set up the environment and use the APIs: Postman Collections Welcome Kit