ProductAPI Reference
Updates
Outlines best practices when updating products in Omnium via API
Best practice
This guide outlines best practices when pushing product data to Omnium, focusing on efficient synchronization and asset handling.
Product Synchronization
-
Use
PatchMany
whenever possible.- Reduces system load and ensures that only relevant properties are updated.
- Ideal for continuous synchronization of specific changes to selected products.
-
Use
UpdateMany
for full product catalog syncs (e.g., nightly or weekly).- Updates only products that have changed.
- Improves performance and scalability.
-
Avoid using
AddMany
except for an initial population of products.
Handling Assets
When performing full product syncs (e.g., nightly/weekly), it's important to control asset updates carefully to avoid unintended uploads.
- Use
UpdateMany
for asset-related updates. - Ensure that
ForceUpload
is set tofalse
. - Only change the
ExternalUrl
of an asset when the underlying image has actually changed.