Skip to main content
POST
Configure Sync

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

syncId
integer<int32>
required

Body

application/json

The relevant Information of the Sync Item

Model Class: CreateWorkerSyncConfiguration

Interval
string<duration>
Example:

"00:05:00"

Configs
object[]

Response

The changed Worker Configuration

Model Class: WorkerSyncItem

Identifier
string<uuid>
required
SyncName
string
required

the Name of the Sync

Example:

"Ebay"

SalesChannelName
string
required

The Name of the Sales Channel

Example:

"Shop"

SalesChannelId
string
required
Example:

"1-1-1"

ReportProgress
boolean
required

The Sync can Report Progress in Percent

Example:

false

Configurations
object[]
required

The Configurations

Interval
string<duration>

The Sync Interval

Example:

"00:05:00"