Entity Synchronization
Published by Marc Bednar on February 16, 2024
Overview
OrderCloud introduces the ability to publish base entities to the destination of your choice. You will be notified when the entities are created, updated or deleted via any of the following delivery configuration targets:
SearchIngestion for out-of-the-box integration with Sitecore Discover 2.0
An Http(s) endpoint
An EventHub instance
A Kafka instance
AzureBlob logging
The current release allows you to synchronize categories, with many more entities in the near future. This is just the beginning.
Sitecore Discover 2.0 Integration
When synchronizing entities using the SearchIngestion delivery target, you must specify the name of the entity as part of the delivery target. If you are going to synchronize different entity types, then it is crucial that you create a separate delivery configuration for each entity type.
Example of a Product Synchronization Delivery Configuration
{
"ID": "SynchronizeProducts",
"Name": "SynchronizeProducts",
"Enabled": true,
"DeliveryTargets": {
"SearchIngestion": {
"Domain": "<your domain>",
"Source": "<your source>",
"Endpoint": "https://discover.sitecorecloud.io",
"Entity": "product",
"ApiKey": null
}
}
}
Example of a Category Entity Synchronization Delivery Configuration
{
"ID": "SynchronizeCategories",
"Name": "SynchronizeCategories",
"Enabled": true,
"DeliveryTargets": {
"SearchIngestion": {
"Domain": "<your domain>",
"Source": "<your source>",
"Endpoint": "https://discover.sitecorecloud.io",
"Entity": "category",
"ApiKey": null
}
}
}
Notice in the above configurations, the Entity names are specific to the type of entity defined in Sitecore Discover 2.0.
New Properties
EntitySyncConfig
{
DeliveryConfigID: ""
}
New Endpoints
PUT /v1/entitysync/categories
DELETE /v1/entitysync/categories
PUT /v1/integrations/entitysync/suppliers
DELETE /v1/integrations/entitysync/suppliers
PUT /v1/integrations/entitysync/adminusers
DELETE /v1/integrations/entitysync/adminusers
PUT /v1/integrations/entitysync/buyers/users
DELETE /v1/integrations/entitysync/buyers/users
PUT /v1/integrations/entitysync/categories
DELETE /v1/integrations/entitysync/categories
PUT /v1/integrations/entitysync/suppliers/users
DELETE /v1/integrations/entitysync/suppliers/users
For more information, see Entity Sync API Reference
Still have questions?
Ask in our Community Channel