Skip to main content
GET
Delivers the persisted synchronisation configuration of a connector account.

Authorizations

Authorization
string
header
required

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

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId
string
required

Sales channel id of the connector account whose configuration is retrieved.

Response

Success.

The persisted synchronisation configuration of a connector account (dbo.tShopKonfiguration). Live-only, non-persisted fields reported by the connected endpoint's handshake (PlatformName, PlatformVersion, ProtocolVersion, EndpointVersion, IsOldConnector, ServerInfo) are not part of this DB-backed read.

canImport
boolean
required

The connector account is allowed to import data from the endpoint.

shouldImportItemsAndCategories
boolean
required

Items and categories are imported.

shouldImportOrdersAndCustomers
boolean
required

Orders and customers are imported.

shouldImportImages
boolean
required

Item images are imported.

canUpload
boolean
required

The connector account is allowed to upload data to the endpoint.

shouldUploadItemComplete
boolean
required

Items are uploaded completely, rather than price/stock-restricted.

shouldUploadItemPriceRestricted
boolean
required

Item uploads are restricted to prices only.

shouldUploadItemStockRestricted
boolean
required

Item uploads are restricted to stock only.

shouldUploadCustomers
boolean
required

Customer data is uploaded.

shouldUploadImages
boolean
required

Images are uploaded.

shouldRefreshExistingItems
boolean
required

Existing items are merged/refreshed rather than only added.

shouldRefreshCustomers
boolean
required

Existing customer data is refreshed.

shouldDeleteImagesOnImport
boolean
required

Images are deleted on import.

shouldWawiCalculateTaxRate
boolean
required

The Wawi calculates the tax rate for items, rather than taking the endpoint-reported one.

shouldWawiCalculateTaxRateForShipping
boolean
required

The Wawi calculates the tax rate for shipping, rather than taking the endpoint-reported one.

pullCount
integer<int32>
required

Maximum pull count per sync run.

quickSyncCount
integer<int32>
required

Maximum quick-sync count per sync run.

sendOnlyAssignedManufacturers
boolean
required

Manufacturer data sent to the endpoint is filtered to only assigned manufacturers.

maximumTransferRate
number<decimal>

Maximum transfer rate for uploads, in megabytes, or null if unrestricted.

imagesCount
integer<int32>

Maximum number of images transferred per run, or null if unrestricted.

entityCount
integer<int32>

Maximum number of entities transferred per run, or null if unrestricted.

shippingCountryIso
string

The shipping/departure country as an ISO 3166-1 alpha-2 country code, or null if not set. Canonical form is UPPERCASE (ADR-85); matching is case-insensitive.

dummyCategoryId
string<uuid>

Fallback category for uncategorized imported items, or null if not set.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"