Product Synchronization
Published by Marc Bednar on July 26, 2023
Last updated on April 25, 2025
Overview
OrderCloud allows you to synchronize your catalog content with any system of your choosing using one of the pre-defined delivery mechanism that best suits your needs. When products are created, updated or deleted, you will be notified of these changes via any of the following Delivery Configurations:
SearchIngestion for out-of-the-box integration with Sitecore Search
An Http(s) endpoint
An EventHub instance
A Kafka instance
Add a Connection to OrderCloud
You must have an OrderCloud production marketplace.
You must create a DeliveryConfiguration that enables one of the delivery mechanisms.
You must enable ProductSync using the API described later in this document.
New Properties
ProductSyncConfig
1{2 "SyncProductChanged": true | false,3 "SyncProductDeleted": true | false,4 "Paused" : true | false,5 "DeliveryConfigID": ""6}
For more information on the pause feature, please refer to Pausing Synchronization Tasks
New Endpoints
GET /integrations/ProductSync
PUT /integrations/ProductSync
PATCH /integrations/ProductSync
DELETE /integrations/ProductSync
For more in formation, see Product Sync API Reference
Sync Endpoint
The product-sync
feature now support a /sync
endpoint, allowing you to target a specific product for synchronization to quickly resolve sync issues. This endpoint is not intended—and should never be used—for syncing entire catalogs or handling incremental updates. Such operations are better managed through the dedicated full sync and incremental sync processes provided by this feature.
POST /integrations/ProductSync/Sync
1{2 "ProductID": ""3}
Still have questions?
Ask in our Community Channel