---
title: Product synchronization
slug: productsync
abstract: OrderCloud enables catalog content synchronization with external systems using pre-defined delivery mechanisms
content_type: concept
audience: \[architect, developer]
---
# Product synchronization

## Overview

OrderCloud enables catalog content synchronization with external systems using pre-defined delivery mechanisms. When products are created, updated, or deleted, these changes are communicated through your chosen Delivery Configuration:

### Available delivery mechanisms

- SearchIngestion: Built-in Sitecore Search integration
- Http(s) endpoint: Custom web service integration
- EventHub instance: Azure Event Hubs integration
- Kafka instance: Apache Kafka integration

## OrderCloud connection setup

### Prerequisites

1. Active OrderCloud production marketplace
2. [DeliveryConfiguration](https://api-docs.sitecore.com/ordercloud/product-synchronization) for chosen delivery mechanism
3. Enabled ProductSync configuration

## Configuration properties

### ProductSyncConfig model

```json
{
  "SyncProductChanged": true,
  "SyncProductDeleted": true,
  "Paused": true,
  "DeliveryConfigID": "",
  "ExcludePriceSchedules": true
}
```

For pause functionality details, see [Pausing synchronization tasks](https://doc.sitecore.com/ordercloud/en/developers/platform/entity-synchronization.html#pausing-synchronization-tasks).

## API endpoints

### Configuration management

- `GET /integrations/ProductSync`: Retrieve current configuration
- `PUT /integrations/ProductSync`: Replace entire configuration
- `PATCH /integrations/ProductSync`: Update specific properties
- `DELETE /integrations/ProductSync`: Remove configuration

For complete API details, see [Product Sync API Reference](https://api-docs.sitecore.com/ordercloud/product-synchronization).

## Sync endpoint

### Purpose

The product-sync feature includes a `/sync` endpoint for targeted product synchronization:

- Quickly resolve sync issues
- Synchronize specific products
- Address individual sync failures

### Usage guidelines

This endpoint is designed for:

- Single product synchronization
- Quick issue resolution
- Targeted updates

Not intended for:

- Full catalog synchronization
- Bulk product updates
- Incremental sync processes

### Implementation

Endpoint: `POST /integrations/ProductSync/Sync`

Request body:

```json
{
  "ProductID": ""
}
```

For Sitecore Search integration details, see [Product synchronization & Sitecore Search](https://doc.sitecore.com/ordercloud/en/developers/platform/product-sync-sitecore-search.html).

## Related reading

- [Product synchronization & Sitecore Search](https://doc.sitecore.com/ordercloud/en/developers/platform/product-sync-sitecore-search.html)
- [Order synchronization](https://doc.sitecore.com/ordercloud/en/developers/platform/ordersync.html)
- [Entity synchronization](https://doc.sitecore.com/ordercloud/en/developers/platform/entity-synchronization.html)