Skip to main content
POST
Refresh Connector

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesChannelId
string
required

Sales channel id of the Connector account whose metadata is re-mirrored.

Response

Declares the response for a completed refresh: the connector-driven metadata has been re-mirrored and the full object is returned. Deliberately the same model as CreateConnector rather than an id or a 204: the point of a refresh is to show the caller what the endpoint now reports, which only the full object carries. The connector-driven sections (Languages, Currencies, Features, TaxRates, ServerInfo) are sourced from the live handshake the call performs and are never accepted as request input. SalesChannelId is always populated here - unlike CreateConnector's simulate path, this command requires an account that already exists. The response reflects what was persisted and the live snapshot behind it; it does not depend on the outcome of the acknowledgement push that follows, which is best-effort by design.

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.

isActive
boolean
required

Connector account is active.

isLocked
boolean
required

Connector account is locked.

canImport
boolean
required

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

shouldImportItemsAndCategories
boolean
required

Items and categories are imported.

shouldImportOrdersAndCustomers
boolean
required

Orders and customers are imported.

shouldImportImages
boolean
required

Item images are imported.

canUpload
boolean
required

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

shouldUploadItemComplete
boolean
required

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

shouldUploadItemPriceRestricted
boolean
required

Item uploads are restricted to prices only.

shouldUploadItemStockRestricted
boolean
required

Item uploads are restricted to stock only.

shouldUploadCustomers
boolean
required

Customer data is uploaded.

shouldUploadImages
boolean
required

Images are uploaded.

shouldRefreshExistingItems
boolean
required

Existing items are merged/refreshed rather than only added.

shouldRefreshCustomers
boolean
required

Existing customer data is refreshed.

shouldDeleteImagesOnImport
boolean
required

Images are deleted on import.

shouldWawiCalculateTaxRate
boolean
required

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

shouldWawiCalculateTaxRateForShipping
boolean
required

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

pullCount
integer<int32>
required

Maximum pull count per sync run.

quickSyncCount
integer<int32>
required

Maximum quick-sync count per sync run.

sendOnlyAssignedManufacturers
boolean
required

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

useShopOrderNumber
boolean
required

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

languages
object[]
required

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

currencies
object[]
required

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

features
object[]
required

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

taxRates
object[]
required

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

serverInfo
object
required

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

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.

companyId
string<uuid>

ID of the company the connector account belongs to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

maximumTransferRate
number<decimal>

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

imagesCount
integer<int32>

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

entityCount
integer<int32>

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

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
string<uuid>

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

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

rootCategoryId
string<uuid>

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

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"