> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connector

> A connector account with its configuration and the metadata reported by its endpoint. Returned when a connector account is created ("POST /v2/sales-channels/connector/accounts" or "CreateConnector"), updated ("PATCH /v2/sales-channels/{salesChannelId}/connector" or "UpdateConnector") or refreshed ("POST /v2/sales-channels/{salesChannelId}/connector/refresh" or "RefreshConnector"). Languages, currencies, features, tax rates and server information are read-only and come from the endpoint; currency codes are uppercase and language codes are lowercase. Per-object-type synchronization settings are not included; use "GET /v2/sales-channels/{salesChannelId}/connector/synchronisation-settings" or "QueryConnectorSynchronisationSettings".



**Kind**: `object`

## Fields

**`salesChannelId`**: `String`

Sales channel id of this connector account. Opaque, tenant-local composite identifier (not a UUID). Null when "Simulate" is true (omitted in REST, null in GraphQL); no account was saved, so no id is assigned.

---

**`name`**: `String`

Name of the connector account.

---

**`url`**: `String`

URL of the connector endpoint.

---

**`isActive`**: `Boolean!`

Connector account is active.

---

**`isLocked`**: `Boolean!`

Connector account is locked.

---

**`companyId`**: `ID`

ID of the company the connector account belongs to.

---

**`canImport`**: `Boolean!`

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

---

**`shouldImportItemsAndCategories`**: `Boolean!`

Items and categories are imported.

---

**`shouldImportOrdersAndCustomers`**: `Boolean!`

Orders and customers are imported.

---

**`shouldImportImages`**: `Boolean!`

Item images are imported.

---

**`canUpload`**: `Boolean!`

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

---

**`shouldUploadItemComplete`**: `Boolean!`

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

---

**`shouldUploadItemPriceRestricted`**: `Boolean!`

Item uploads are restricted to prices only.

---

**`shouldUploadItemStockRestricted`**: `Boolean!`

Item uploads are restricted to stock only.

---

**`shouldUploadCustomers`**: `Boolean!`

Customer data is uploaded.

---

**`shouldUploadImages`**: `Boolean!`

Images are uploaded.

---

**`shouldRefreshExistingItems`**: `Boolean!`

Existing items are merged/refreshed rather than only added.

---

**`shouldRefreshCustomers`**: `Boolean!`

Existing customer data is refreshed.

---

**`shouldDeleteImagesOnImport`**: `Boolean!`

Images are deleted on import.

---

**`shouldWawiCalculateTaxRate`**: `Boolean!`

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

---

**`shouldWawiCalculateTaxRateForShipping`**: `Boolean!`

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

---

**`maximumTransferRate`**: `Decimal`

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

---

**`imagesCount`**: `Int`

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

---

**`entityCount`**: `Int`

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

---

**`pullCount`**: `Int!`

Maximum pull count per sync run.

---

**`quickSyncCount`**: `Int!`

Maximum quick-sync count per sync run.

---

**`sendOnlyAssignedManufacturers`**: `Boolean!`

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

---

**`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`**: `ID`

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

---

**`rootCategoryId`**: `ID`

Root category for imported items, or null if not set.

---

**`useShopOrderNumber`**: `Boolean!`

The shop-assigned order number is used instead of the JTL-Wawi-generated one.

---

**`languages`**: `[ConnectorLanguage!]!`

Languages available in JTL-Wawi, annotated with the assignment/default state reported by the connector endpoint's live handshake.

---

**`currencies`**: `[ConnectorCurrency!]!`

ISO 4217 currencies known to JTL-Wawi, annotated with the assignment/default state reported by the connector endpoint's live handshake.

---

**`features`**: `[ConnectorFeatureListItem!]!`

Every known connector feature, each marked whether the connector endpoint reported it as enabled.

---

**`taxRates`**: `[ConnectorTaxRate!]!`

Tax rates reported by the endpoint during the live handshake, each with the JTL-Wawi tax rate it was matched to. Returned when a connector account is created ("POST /v2/sales-channels/connector/accounts" or "CreateConnector") or refreshed ("POST /v2/sales-channels/{salesChannelId}/connector/refresh" or "RefreshConnector"); always empty in the update response ("PATCH /v2/sales-channels/{salesChannelId}/connector" or "UpdateConnector").

---

**`serverInfo`**: `ConnectorServerInfo!`

Live-only metadata about the connected endpoint's platform and protocol version, as reported by its handshake.