Sitecore OrderCloud Documentation

docs

Portal login

Entity synchronization

Entity synchronization lets marketplace owners to configure synchronization for different types of base entities changes with external systems.

EntitySyncs.GetAdminUsers

Retrieve the entity sync delivery configuration for admin users

get

v1/integrations/entitysync/adminusers

EntitySyncs.SaveAdminUsers

Create or update the entity sync delivery configuration for admin users

put

v1/integrations/entitysync/adminusers

EntitySyncs.DeleteAdminUsers

Delete the entity sync delivery configuration for admin users

delete

v1/integrations/entitysync/adminusers

EntitySyncs.PatchAdminUsers

Partially update the entity sync delivery configuration for admin users

patch

v1/integrations/entitysync/adminusers

EntitySyncs.SyncAdminUser

Sync an admin user

post

v1/integrations/entitysync/adminusers/sync

EntitySyncs.GetBuyers

Retrieve the entity sync delivery configuration for buyers

get

v1/integrations/entitysync/buyers

EntitySyncs.SaveBuyers

Create or update the entity sync delivery configuration for buyers

put

v1/integrations/entitysync/buyers

EntitySyncs.DeleteBuyers

Delete the entity sync delivery configuration for buyers

delete

v1/integrations/entitysync/buyers

EntitySyncs.PatchBuyers

Partially update the entity sync delivery configuration for buyers

patch

v1/integrations/entitysync/buyers

EntitySyncs.SyncBuyer

Sync a buyer

post

v1/integrations/entitysync/buyers/sync

EntitySyncs.GetBuyerUserGroups

Retrieve the entity sync delivery configuration for buyer user groups

get

v1/integrations/entitysync/buyers/usergroups

EntitySyncs.SaveUserGroups

Create or update the entity sync delivery configuration for buyer user groups

put

v1/integrations/entitysync/buyers/usergroups

EntitySyncs.DeleteUserGroups

Delete the entity sync delivery configuration for buyer user groups

delete

v1/integrations/entitysync/buyers/usergroups

EntitySyncs.PatchBuyerUserGroups

Partially update the entity sync delivery configuration for buyer user groups

patch

v1/integrations/entitysync/buyers/usergroups

EntitySyncs.SyncBuyerUserGroup

Sync a buyer user group

post

v1/integrations/entitysync/buyers/usergroups/sync

EntitySyncs.GetBuyerUsers

Retrieve the entity sync delivery configuration for buyer users

get

v1/integrations/entitysync/buyers/users

EntitySyncs.SaveBuyerUsers

Create or update the entity sync delivery configuration for buyer users

put

v1/integrations/entitysync/buyers/users

EntitySyncs.DeleteBuyerUsers

Delete the entity sync delivery configuration for buyer users

delete

v1/integrations/entitysync/buyers/users

EntitySyncs.PatchBuyerUsers

Partially update the entity sync delivery configuration for buyer users

patch

v1/integrations/entitysync/buyers/users

EntitySyncs.SyncBuyerUser

Sync a buyer user

post

v1/integrations/entitysync/buyers/users/sync

EntitySyncs.GetCategories

Retrieve the entity sync delivery configuration for categories

get

v1/integrations/entitysync/categories

EntitySyncs.SaveCategories

Create or update the entity sync delivery configuration for categories

put

v1/integrations/entitysync/categories

EntitySyncs.DeleteCategories

Delete the entity sync delivery configuration for categories

delete

v1/integrations/entitysync/categories

EntitySyncs.PatchCategories

Partially update the entity sync delivery configuration for categories

patch

v1/integrations/entitysync/categories

EntitySyncs.SyncCategory

Sync a category

post

v1/integrations/entitysync/categories/sync

EntitySyncs.GetInventoryRecords

Retrieve the entity sync delivery configuration for inventory records

get

v1/integrations/entitysync/products/inventoryrecords

EntitySyncs.SaveInventoryRecords

Create or update the entity sync delivery configuration for inventory records

put

v1/integrations/entitysync/products/inventoryrecords

EntitySyncs.DeleteInventoryRecords

Delete the entity sync delivery configuration for inventory records

delete

v1/integrations/entitysync/products/inventoryrecords

EntitySyncs.PatchInventoryRecords

Partially update the entity sync delivery configuration for inventory records

patch

v1/integrations/entitysync/products/inventoryrecords

EntitySyncs.SyncInventoryRecord

Sync an inventory record

post

v1/integrations/entitysync/products/inventoryrecords/sync

EntitySyncs.SyncSupplier

Sync a supplier

post

v1/integrations/entitysync/supplier/sync

EntitySyncs.GetSuppliers

Retrieve the entity sync delivery configuration for suppliers

get

v1/integrations/entitysync/suppliers

EntitySyncs.SaveSuppliers

Create or update the entity sync delivery configuration for suppliers

put

v1/integrations/entitysync/suppliers

EntitySyncs.DeleteSuppliers

Delete the entity sync delivery configuration for suppliers

delete

v1/integrations/entitysync/suppliers

EntitySyncs.PatchSuppliers

Partially update the entity sync delivery configuration for suppliers

patch

v1/integrations/entitysync/suppliers

EntitySyncs.GetSupplierUsers

Retrieve the entity sync delivery configuration for supplier users

get

v1/integrations/entitysync/suppliers/users

EntitySyncs.SaveSupplierUsers

Create or update the entity sync delivery configuration for supplier users

put

v1/integrations/entitysync/suppliers/users

EntitySyncs.DeleteSupplierUsers

Delete the entity sync delivery configuration for supplier users

delete

v1/integrations/entitysync/suppliers/users

EntitySyncs.PatchSupplierUsers

Partially update the entity sync delivery configuration for supplier users

patch

v1/integrations/entitysync/suppliers/users

EntitySyncs.SyncSupplierUser

Sync a supplier user

post

v1/integrations/entitysync/suppliers/users/sync

Sitecore Logo

© Copyright 2025, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore