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 to refresh. Opaque, tenant-local composite identifier (not a UUID); use the value returned by a sales channel listing.

Response

The metadata was refreshed. Returns the full Connector object with the metadata reported by the endpoint; "SalesChannelId" is always set. Acknowledgements are sent to the endpoint afterwards on a best-effort basis and do not affect the response.

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".

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

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

shouldWawiCalculateTaxRateForShipping
boolean
required

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

languages
object[]
required

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

currencies
object[]
required

ISO 4217 currencies known to JTL-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

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

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 code, e.g. DE, or null if not set. Case-insensitive; returned in uppercase.

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"