CreateConnectorCommandRequestInput
Creates a new JTL-Connector account. The sales channel id is assigned by JTL-Wawi and returned in the response as an opaque, tenant-local composite identifier (not a UUID); it cannot be set in the request. Before anything is saved, JTL-Wawi performs a live handshake with the connector endpoint and checks that every tax rate reported by the endpoint exists for the selected company. If the handshake or the tax rate check fails, no account is created. Languages, currencies, features, tax rates and server information in the response are always read live from the endpoint and cannot be set in the request. Set “Simulate” to true to run the same checks without creating the account. - Request
CreateConnectorCommandRequestInputFields
If true, runs the live handshake and tax rate check without creating the account; use this to test a connection first. Optional. Defaults to false. When true, the response contains no "SalesChannelId" (omitted in REST, null in GraphQL).
URL of the connector endpoint. Mandatory. Must not point to the same host and path as another active JTL-Connector account (compared case-insensitively, ignoring scheme and trailing slash); deleted (inactive) accounts are ignored, locked accounts are not.
API token used to authenticate against the connector endpoint. Mandatory. Write-only; never echoed back in the response.
Name of the connector account. Mandatory.
ID of the company the connector account belongs to. Mandatory. The tax rates reported by the endpoint are validated against this company's tax rates.
DEPRECATED: do not use. This property is ignored and will be removed in a future API version. A new connector account is always created as active.
Connector account is locked. Optional. Defaults to false.
Root category for imported items. Optional. Defaults to null (no root category set).
Use the shop-assigned order number instead of the JTL-Wawi-generated one. Optional. Defaults to false.
The connector account is allowed to import data from the endpoint. Optional. Defaults to false.
Items and categories are imported. Optional. Defaults to false.
Orders and customers are imported. Optional. Defaults to false.
Item images are imported. Optional. Defaults to false.
The connector account is allowed to upload data to the endpoint. Optional. Defaults to false.
Items are uploaded completely, rather than price/stock-restricted. Optional. Defaults to false.
Item uploads are restricted to prices only. Optional. Defaults to false.
Item uploads are restricted to stock only. Optional. Defaults to false.
Customer data is uploaded. Optional. Defaults to false.
Images are uploaded. Optional. Defaults to false.
Existing items are merged/refreshed rather than only added. Optional. Defaults to false.
Existing customer data is refreshed. Optional. Defaults to false.
Images are deleted on import. Optional. Defaults to false.
JTL-Wawi calculates the tax rate for items, rather than taking the endpoint-reported one. Optional. Defaults to false.
JTL-Wawi calculates the tax rate for shipping, rather than taking the endpoint-reported one. Optional. Defaults to false.
The shipping (departure) country as an ISO 3166-1 alpha-2 code, e.g. DE. Optional. Defaults to null. Case-insensitive; returned in uppercase.
Maximum number of entities transferred per run. Optional. Omit or send null to use the default (5).
Maximum pull count per sync run. Optional. Defaults to 50.
Maximum number of images transferred per run. Optional. Omit or send null to use the default (10).
Maximum transfer rate for uploads, in megabytes, or null for unrestricted. Optional. Defaults to null (no limit).
Maximum quick-sync count per sync run. Optional. Defaults to 10.
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.
Was this page helpful?