Skip to main content
inputUpdateConnectorCommandRequestInput

Fields

salesChannelId
String!
required

Sales channel id of the connector account to update. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

url
String

URL of the connector endpoint. Omit to leave unchanged. Connection data; submitting a different value triggers the live handshake, which must succeed before anything is written. A changed URL must not point to the same host and path as another active JTL-Connector account; deleted (inactive) accounts are ignored, and a deleted account itself is not checked.

apiToken
String

API token used to authenticate against the connector endpoint. Omit to leave unchanged. Write-only; never returned. A new token is verified with a live handshake before it is saved.

name
String

Name of the connector account. Omit to leave unchanged.

companyId
ID

ID of the company the connector account belongs to. Omit to leave unchanged. Cannot be null. The tax rates reported by the endpoint are validated against this company's tax rates.

isActive
Boolean

DEPRECATED: do not use. This property is ignored and will be removed in a future API version.

isLocked
Boolean

Connector account is locked. Omit to leave unchanged.

rootCategoryId
ID

Root category for imported items. Omit to leave unchanged; send null to clear it.

useShopOrderNumber
Boolean

Use the shop-assigned order number instead of the JTL-Wawi-generated one. Omit to leave unchanged.

canImport
Boolean

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

shouldImportItemsAndCategories
Boolean

Items and categories are imported. Omit to leave unchanged.

shouldImportOrdersAndCustomers
Boolean

Orders and customers are imported. Omit to leave unchanged.

shouldImportImages
Boolean

Item images are imported. Omit to leave unchanged.

canUpload
Boolean

The connector account is allowed to upload data to the endpoint. Omit to leave unchanged.

shouldUploadItemComplete
Boolean

Items are uploaded completely, rather than price/stock-restricted. Omit to leave unchanged.

shouldUploadItemPriceRestricted
Boolean

Item uploads are restricted to prices only. Omit to leave unchanged.

shouldUploadItemStockRestricted
Boolean

Item uploads are restricted to stock only. Omit to leave unchanged.

shouldUploadCustomers
Boolean

Customer data is uploaded. Omit to leave unchanged.

shouldUploadImages
Boolean

Images are uploaded. Omit to leave unchanged.

shouldRefreshExistingItems
Boolean

Existing items are merged/refreshed rather than only added. Omit to leave unchanged.

shouldRefreshCustomers
Boolean

Existing customer data is refreshed. Omit to leave unchanged.

shouldDeleteImagesOnImport
Boolean

Images are deleted on import. Omit to leave unchanged.

shouldWawiCalculateTaxRate
Boolean

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

shouldWawiCalculateTaxRateForShipping
Boolean

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

shippingCountryIso
String

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

entityCount
Int

Maximum number of entities transferred per run. Omit to leave unchanged; send null for unrestricted.

pullCount
Int

Maximum number of entities pulled per synchronization run. Omit to leave unchanged. Cannot be null.

imagesCount
Int

Maximum number of images transferred per run. Omit to leave unchanged; send null for unrestricted.

maximumTransferRate
Decimal

Maximum transfer rate for uploads, in megabytes. Omit to leave unchanged; send null for unrestricted.

quickSyncCount
Int

Maximum number of entities per quick-sync run. Omit to leave unchanged. Cannot be null.

sendOnlyAssignedManufacturers
Boolean

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

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.