mutation TestShopConnection($request: TestShopConnectionCommandRequestInput!) {
TestShopConnection(request: $request) {
status
latencyMs
shopVersion
errorCode
message
}
}{
"request": {
"salesChannelId": "string"
}
}{
"data": {
"TestShopConnection": {
"status": "UNKNOWN",
"latencyMs": "value",
"shopVersion": "string",
"errorCode": "string",
"message": "string"
}
}
}TestShopConnection
Tests the connection to a JTL-Wawi-managed online shop and returns the result. Uses the stored synchronization credentials; credentials cannot be passed in the request. Checks both reachability and credentials. A completed test always returns HTTP 200, also if the shop is unreachable or rejects the credentials; check “Status” for the result. Requires the “saleschannels.write” scope, because each test updates the shop’s stored connection status; do not call it in a polling loop. If the shop does not respond within the internal timeout, “Status” is “TimedOut”.
If a request with this mutation’s Idempotency-Key was already completed, the response’s extensions contains an idempotency.{responseName} entry with wasReplayed: true.
TestShopConnection(request: TestShopConnectionCommandRequestInput!): ShopConnectionTestResult!Arguments
Returns
Result of the test. REST returns the numeric enum value; GraphQL returns the enum name (e.g. SUCCEEDED).
Wall-clock duration of the outbound test in milliseconds, measured by this endpoint around the call to the shop. Null when no call was attempted (Status = NotConfigured). Diagnostic only; not an SLA and not comparable across networks.
The shop's own version token as reported by its synchronization interface, verbatim and unnormalized (the shop returns e.g. '503' for version 5.03). Null unless the shop got far enough to report one, which in practice means Status = Succeeded.
Stable machine-readable failure code, or null on success: shop-authentication-failed, shop-unreachable, shop-connection-timed-out, shop-incompatible-version, shop-invalid-response, shop-not-configured. Prefer this over parsing Message.
Human-readable, English, status-derived description of the failure, or null on success. Diagnostic only; not stable, not localized, and must not be parsed. Never contains the raw response text.
mutation TestShopConnection($request: TestShopConnectionCommandRequestInput!) {
TestShopConnection(request: $request) {
status
latencyMs
shopVersion
errorCode
message
}
}{
"request": {
"salesChannelId": "string"
}
}{
"data": {
"TestShopConnection": {
"status": "UNKNOWN",
"latencyMs": "value",
"shopVersion": "string",
"errorCode": "string",
"message": "string"
}
}
}Was this page helpful?