Skip to main content
inputCreateConnectorCommandRequestInput

Fields

simulate
Boolean

When true, runs the identical live handshake and taxrate validation but writes nothing to the database - a connection test before the real create. Defaults to false when omitted. Note: the response shape differs when true - nothing is persisted and SalesChannelId is null - see the response description for the transport-specific details of this deviation.

url
String!
required

URL of the connector endpoint. Mandatory.

apiToken
String!
required

API token used to authenticate against the connector endpoint. Mandatory. Write-only - never echoed back in the response.

name
String!
required

Name of the connector account. Mandatory.

companyId
ID!
required

ID of the company the connector account belongs to. Mandatory - also the company whose tSteuersatz the connector-reported taxrates are validated against.

isActive
Boolean

Connector account is active. Optional - defaults to the WPF editor default when omitted.

isLocked
Boolean

Connector account is locked. Optional - defaults to the WPF editor default when omitted.

rootCategoryId
ID

Root category for imported items. Optional - defaults to the WPF editor default when omitted.

useShopOrderNumber
Boolean

Use the shop-assigned order number instead of the Wawi-generated one. Optional - defaults to the WPF editor default when omitted.

canImport
Boolean

The connector account is allowed to import data from the endpoint. Optional - defaults to the WPF editor default when omitted.

shouldImportItemsAndCategories
Boolean

Items and categories are imported. Optional - defaults to the WPF editor default when omitted.

shouldImportOrdersAndCustomers
Boolean

Orders and customers are imported. Optional - defaults to the WPF editor default when omitted.

shouldImportImages
Boolean

Item images are imported. Optional - defaults to the WPF editor default when omitted.

canUpload
Boolean

The connector account is allowed to upload data to the endpoint. Optional - defaults to the WPF editor default when omitted.

shouldUploadItemComplete
Boolean

Items are uploaded completely, rather than price/stock-restricted. Optional - defaults to the WPF editor default when omitted.

shouldUploadItemPriceRestricted
Boolean

Item uploads are restricted to prices only. Optional - defaults to the WPF editor default when omitted.

shouldUploadItemStockRestricted
Boolean

Item uploads are restricted to stock only. Optional - defaults to the WPF editor default when omitted.

shouldUploadCustomers
Boolean

Customer data is uploaded. Optional - defaults to the WPF editor default when omitted.

shouldUploadImages
Boolean

Images are uploaded. Optional - defaults to the WPF editor default when omitted.

shouldRefreshExistingItems
Boolean

Existing items are merged/refreshed rather than only added. Optional - defaults to the WPF editor default when omitted.

shouldRefreshCustomers
Boolean

Existing customer data is refreshed. Optional - defaults to the WPF editor default when omitted.

shouldDeleteImagesOnImport
Boolean

Images are deleted on import. Optional - defaults to the WPF editor default when omitted.

shouldWawiCalculateTaxRate
Boolean

The Wawi calculates the tax rate for items, rather than taking the endpoint-reported one. Optional - defaults to the WPF editor default when omitted.

shouldWawiCalculateTaxRateForShipping
Boolean

The Wawi calculates the tax rate for shipping, rather than taking the endpoint-reported one. Optional - defaults to the WPF editor default when omitted.

shippingCountryIso
String

The shipping/departure country as an ISO 3166-1 alpha-2 country code. Optional - defaults to the WPF editor default when omitted. Canonical form is UPPERCASE (ADR-85); matching is case-insensitive.

entityCount
Int

Maximum number of entities transferred per run, or null for unrestricted. Optional - defaults to the WPF editor default when omitted.

pullCount
Int

Maximum pull count per sync run. Optional - defaults to the WPF editor default when omitted.

imagesCount
Int

Maximum number of images transferred per run, or null for unrestricted. Optional - defaults to the WPF editor default when omitted.

maximumTransferRate
Decimal

Maximum transfer rate for uploads, in megabytes, or null for unrestricted. Optional - defaults to the WPF editor default when omitted.

quickSyncCount
Int

Maximum quick-sync count per sync run. Optional - defaults to the WPF editor default when omitted.

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.