Catalog management API v3 provides a set of endpoints to interact with your content and product catalog data. This covers everything from sending, viewing, and modifying your Catalog data and settings.
The detailed OpenAPI specification for the Catalog management API v3 can be found on GitHub:
Note
To learn more about the terminology and structure of a catalog, refer to the Understanding feed guide.
Format your data
You must format your catalog data properly before sending it through the APIs for Bloomreach to ingest it.
Send and manage feed records
After properly formatting your Catalog data, you must send it to Bloomreach for ingestion. There are two modes of delivery:
- PUT (Upload full feed at once)
- PATCH (Modify specific parts of the feed)
Catalog data may be sent as an API payload or as a file sent to a SFTP.
The Manage feed records endpoints allow you to send feed records and get various details about them.
Catalog configuration
After sending your data, you can configure your Catalogs so that Bloomreach processes your data as needed. There are various configuration options available for a Catalog:
- Attributes configuration: Configure product attributes such as title, description, price, sku, etc.
- Catalog settings: Set preferences for feed, indexing, variants, Autosuggest, and more.
- Customize the behavior of the Catalog Management API
You can configure attributes and Catalog settings through the Catalogs application in your Bloomreach dashboard or via the Catalog configuration API endpoints.
Publish the feed index
After making changes to your catalog data, you must trigger an Feed indexing API call to inform Bloomreach about the new catalog data and to index that catalog.
The index update ensures that the configurations available on your APIs are in sync with the data on your catalog's index.
Job processing details
Each operation related to an update in the Catalog is called a Job. The Job processing endpoints give you valuable information about all jobs and their status for monitoring and validation.