The patch mechanism offers two update modes: full and delta. The update mode determines how the system applies your patch.
The patch format (your JSON operations) remains the same for both update types. The difference is how Bloomreach applies it—either wiping all the records first (full) or merging changes (delta) to the existing state of records.
Full mode
Removes all existing records in the collection, then applies your patch operations. This mode works well for:
-
Daily complete data refreshes.
-
Recovering from sync issues with source systems.
-
Ensuring a clean, consistent state.
-
Initial data loads.
Full mode typically has only "add product" or "add product" and "add variant" operations, but any combination of operations and path targets are allowed. Use any combination of operation types (add, upsert, remove), not just add operations. The full mode designation only means Bloomreach clears all existing records before applying your operations.
Delta mode (default)
Applies only the operations in your patch. Existing records not mentioned in the patch remain unchanged. This mode works well for:
-
Incremental updates throughout the day.
-
Inventory or price changes.
-
Adding new products without affecting existing ones.
-
Modifying specific fields or variants.
Note
For delta updates, it's recommended to batch small changes. There's a limit of one update per minute on average over a 24-hour window, with bursts not exceeding once per second. Each delta update can include multiple operations.
Query parameter
Specify the update mode as a query parameter when submitting your patch.
POST .../records?update_mode=full
POST .../records?update_mode=delta