> ## 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

> Full result of the CreateConnector live pipeline: the created (or, for ?simulate=true, merely verified) connector account together with its complete metadata mirror. Base data and configuration are the persisted DB state (null/default-filled from the WPF editor defaults where the request omitted them); the connector-driven sections (Languages, Currencies, Features, TaxRates, ServerInfo) are always sourced live from the endpoint handshake, ISO-identified per the ADR-85 pattern established by ConnectorCurrency. Deliberate ADR-4 deviation: ADR-4 asks Create commands to return only the created Id, but this command returns the full object instead, because ?simulate=true never persists anything and therefore has no Id to return - the live handshake/taxrate-validation result (Languages, Currencies, Features, TaxRates, ServerInfo) is the only useful response for that preview path, so the same shape is used for the persisted case too rather than modeling two different response contracts. Known limitations: (1) RootCategoryId and UseShopOrderNumber are modeled here rather than folded into ConnectorAccount/ConnectorConfiguration, because those two shared GET models are out of this ticket's scope - reconcile once WAWI-91760 lands; (2) synchronisation settings (send/receive/delete per object type) are deliberately NOT included here - ConnectorSynchronisationEntityType is a 90+ value enum owned by JTL.Wawi.Connector.Core.Contracts, and duplicating it into this response ahead of WAWI-91760's actual mapping design risked a stale/incorrect mirror; use the existing QueryConnectorSynchronisationSettings endpoint for now and fold it in here once the orchestration lands.



**Kind**: `object`

## Fields

**`salesChannelId`**: `String`

Sales channel id of this connector account. Null when the request used ?simulate=true - no account was persisted, so no id could be 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!`

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

---

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

The 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 country code, or null if not set. Canonical form is UPPERCASE (ADR-85); matching is case-insensitive.

---

**`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 Wawi-generated one.

---

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

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

---

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

ISO 4217 currencies known to the 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!]!`

Taxrates reported by the connector endpoint's live handshake, each merged with the internal Wawi taxrate it was validated against.

---

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

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

