What is Item collections API
The Item Collections API provides endpoints to both ingest and manage data. The API enables automation and integration with other systems, ideal for your development workflow to maintain complete control over all aspects of the collection data flow.
Why use Item collections API
The Item collections API offers several key benefits:
-
Complete control: You decide exactly when updates occur and what data changes.
-
Granular updates: Update a single field on a single variant without resending entire products. This precision improves performance and reduces processing time.
-
Full and delta support: Do complete catalog replacements for clean syncs or incremental updates for efficiency. Use the same API and data format for both approaches.
Working with Item collections API
Product data flows into Bloomreach through item collections, which serve as containers for your catalog information. The Item collections API provides a unified way to send product data to Bloomreach, whether you're doing an initial load, daily refreshes, or real-time updates.
Understand data update process
Data hub item collections use records to store raw data. Your data doesn't need to follow a strict schema. You send it as flexible JSON, and the schema transforms these raw records into structured items.
The separation between records and items allows you to store raw data in any format while ensuring Bloomreach applications receive clean, structured data. Schema mappings control how records transform into items. Check the detailed guide on how data flows through item collections.
Patch mechanism
To send/update your product data, you interact with the Item collections API via a patch mechanism. Check the detailed guide on how the patch mechanism works.
Update product data via API
Follow step-by-step instructions on updating product data via API.
FAQs
When sending product data into the Item collection API, how do I configure the destination if it goes to a staging or production Discovery catalog?
When ingesting product data using the Item Collection API, the flow of data into either the staging or production Discovery catalog is determined by how you configure destinations within the item collection setup.
This distinction is made at the point of destination creation/configuration, and isn't tied to the API that ingests records, but to how (and where) you sync the collection data after ingestion.