---
title: Order synchronization
slug: ordersync
abstract: Order synchronization enables real-time integration between OrderCloud and your internal systems
content_type: concept
audience: \[architect, developer]
---
# Order synchronization

## Overview

Order synchronization enables real-time integration between OrderCloud and your internal systems by:

- Notifying you when orders are submitted
- Tracking changes throughout the order lifecycle
- Delivering updates through your chosen mechanism
- Maintaining data consistency across systems

This feature streamlines order processing by:

- Automating data transfer
- Reducing manual intervention
- Ensuring timely updates
- Supporting system integration

## Setup requirements

### 1. Production marketplace

- Active OrderCloud production environment
- Proper access configuration
- Appropriate security settings

### 2. Delivery configuration

Create a [DeliveryConfiguration](https://doc.sitecore.com/ordercloud/en/developers/platform/delivery-configuration.html) with one of these mechanisms:

- Kafka
- Event Hub
- HTTP endpoints
- Azure Blob storage
- Other supported targets

Configuration considerations:

- Message format
- Delivery reliability
- Error handling
- Performance requirements

### 3. OrderSync configuration

Enable synchronization through the API:

- Configure delivery settings
- Set up error handling
- Define sync parameters
- Establish monitoring

## OrderSyncConfig properties

Configuration model:

```json
{
  "DeliveryConfigID": "",  // References delivery configuration
  "ConfigData": ""        // Custom configuration data
}
```

Key aspects:

- `DeliveryConfigID`: Links to your delivery mechanism
- `ConfigData`: Supports custom settings and parameters
- Flexible configuration options
- Environment-specific settings

## API endpoints

Management endpoints:

- `GET /integrations/OrderSync`
  - Retrieve current configuration
  - View sync status
  - Check settings

- `PUT /integrations/OrderSync`
  - Create new configuration
  - Replace existing settings
  - Full configuration update

- `PATCH /integrations/OrderSync`
  - Partial configuration updates
  - Modify specific settings
  - Preserve existing values

- `DELETE /integrations/OrderSync`
  - Remove configuration
  - Disable synchronization
  - Clean up settings

For complete details, see the [Order sync API reference](https://api-docs.sitecore.com/ordercloud/order-synchronization)

## Implementation benefits

### 1. Real-time updates

- Immediate order notifications
- Change tracking
- Status updates
- Error reporting

### 2. System integration

- Automated data flow
- Consistent information
- Reduced manual effort
- Improved accuracy

### 3. Flexibility

- Multiple delivery options
- Custom configuration
- Scalable implementation
- Adaptable settings

### 4. Monitoring

- Track sync status
- Identify issues
- Performance metrics
- System health checks

## Best practices

### 1. Configuration

- Choose appropriate delivery mechanism
- Set reasonable timeouts
- Configure error handling
- Document settings

### 2. Implementation

- Test in non-production first
- Monitor performance
- Handle errors gracefully
- Maintain documentation

### 3. Maintenance

- Regular monitoring
- Performance optimization
- Error resolution
- Configuration updates

## Related reading

- [Entity synchronization](https://doc.sitecore.com/ordercloud/en/developers/platform/entity-synchronization.html)
- [Product synchronization](https://doc.sitecore.com/ordercloud/en/developers/platform/productsync.html)