Skip to main content
POST
Test Shop Connection

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 Wawi-managed shop whose connection is tested. This is a tenant-local, composite identifier and not a UUID (ADR-69) - it is opaque to the caller and must be taken verbatim from a sales channel listing; the internal shop key (kShop) is never accepted here.

Response

The connection test completed. The verdict is in the body - a 200 does NOT mean the shop was reachable or that the credentials were accepted; inspect Status. Status = Succeeded is the equivalent of the WPF IsAuthentificationValid flag.

Verdict of a completed connection test. Carries no credential and no part of one - not the value, not its length, not a hash.

status
enum<integer>
required

The verdict. Status == Succeeded is the equivalent of the WPF IsAuthentificationValid flag. Note that REST transports this as the raw numeric enum value (the API registers no StringEnumConverter), while GraphQL renders it as SCREAMING_SNAKE_CASE.

Available options:
0,
1,
2,
3,
4,
5,
6,
7
latencyMs
integer<int64>

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.

shopVersion
string

The shop's own version token as reported by its synchronisation 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.

errorCode
string

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.

message
string

Human-readable, English, status-derived description of the failure, or null on success. Diagnostic only - not stable, not localized, and must not be parsed. Deliberately never the raw text the shop or the JTL license server returned.