Skip to main content
PUT
Save Connector Configuration

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 replaced. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Body

application/json

Request model for SaveConnectorConfiguration command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

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

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

shouldWawiCalculateTaxRateForShipping
boolean
required

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

pullCount
integer<int32>
required

Maximum number of entities pulled per synchronization run. Must not be negative.

quickSyncCount
integer<int32>
required

Maximum number of entities per quick-sync run. Must not be negative.

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. Omit or send null for unrestricted.

imagesCount
integer<int32>

Maximum number of images transferred per run. Omit or send null for unrestricted.

entityCount
integer<int32>

Maximum number of entities transferred per run. Omit or send null for unrestricted.

shippingCountryIso
string

Shipping (departure) country as an ISO 3166-1 alpha-2 code, e.g. DE. Omit or send null to clear it. Case-insensitive; returned in uppercase.

Response

The configuration was replaced. Returns the configuration as persisted, re-read after the write (not an echo of the request), so normalized values (uppercased ShippingCountryIso, omitted optionals resolved to null) and the preserved read-only DummyCategoryId are visible to the caller.

The synchronization configuration of a connector account. Endpoint-reported information (platform, versions, server info) is not part of this model.

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

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

shouldWawiCalculateTaxRateForShipping
boolean
required

JTL-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 code, e.g. DE, or null if not set. Case-insensitive; returned in uppercase.

dummyCategoryId
string<uuid>

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

Example:

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