> ## Documentation Index > Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt > Use this file to discover all available pages before exploring further. # Test Shop Connection > Runs a live connection and credentials test against a Wawi-managed webshop and reports the verdict. Mirrors the 'Verbindung testen' button of the WPF Verkaufskanalverwaltung. The test performs the shop's dbeS handshake - a POST to the shop's /dbeS/mytest.php with the stored sync credentials, a licence round trip to the JTL license server, and a POST of the resulting licence blob back to the shop - and therefore validates reachability AND credentials in one call. Credentials are never accepted from the caller: they are read server-side from the shop record addressed by salesChannelId, so a caller can only test credentials that are already stored. Two properties of this endpoint are deliberate and must not be 'corrected': (1) It answers HTTP 200 for every completed test, including an unreachable or unauthenticated shop - an unreachable shop is a successful test with a negative verdict, not a failed request, and a diagnostic endpoint whose job is to report a failure must not itself fail. That is why no 502 and no 504 is declared, unlike CreateConnector, where the same live handshake is a means to creating a resource rather than the subject. (2) It is a POST behind saleschannels.write although its name suggests a read: the dbeS handshake rewrites dbo.tBroken and two dbo.tOptions rows on every run, so a caller that loops this endpoint re-hits the JTL license server and rewrites those rows each time. The handshake is bounded by an internal timeout well below the platform request timeout, so a slow or unreachable shop returns Status = TimedOut rather than letting the platform timeout fire; there is no SSE, so the check is synchronous by design. ## OpenAPI ````yaml /openapi/erp/2.1.json post /v2/sales-channels/{salesChannelId}/shop/connection-tests openapi: 3.0.0 info: title: JTL-WAWI API (Cloud) description: "JTL-Wawi-Version: 2.2.0-beta.900+Sha.6df00fe\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system." contact: name: JTL-Software-GmbH url: https://developer.jtl-software.com/ email: partner@jtl-software.com version: '2.1' x-application-version: 2.2.0.0 servers: - url: https://api.jtl-cloud.com/erp description: Production Environment Cloud API Gateway security: [] tags: - name: WMS description: >-

Query all pick lists for a specific wms warehouse that are not completed. - name: Wawi App description: >-

Get a specific customer - name: Warehouses description: >-

Queries all storage locations for a given warehouse. - name: Units description: Development - name: Transaction Status description: >-

Queries all transaction statuses for a sales order. - name: Tax description: >-

Returns the tax rate for the given item. - name: Inventory description: >-

Queries stocks for a specific item, warehouse or storage location. - name: Sales Order description: Planned - name: Sales Invoice Correction description: Planned - name: Return description: >-

Create a new return with associated items and packages. - name: Item description: >-

Queries all responsible persons. - name: Refund description: Planned - name: Property description: >-

Queries all properties of items. - name: Printer description: >-

Retrieves all installed printers. - name: Master Data description: >-

Queries all on hold reasons for sales orders. - name: Manufacturer description: Development - name: Label description: Development - name: Sales Invoice description: Planned - name: Info description: >-

Returns the status of the API. - name: Features description: >-

Returns the available feature sets with release state and API version. - name: Extensibility description: Planned - name: Shipment description: Development - name: Delivery Note description: Planned - name: Custom Field description: Development - name: Customer description: >-

Deletes a specific customer. - name: Authentication description: >-

DEPRECATED seit Wawi 2.2.0: No-Op. Seit Wawi 2.1.0 registriert sich die Wawi selbst per JWT. - name: Attribute description: Development - name: Sales Quotation description: >-

Execute the printing of a sales quotation - name: Production - name: Resources - name: Company - name: Sales Orders - name: Marketplace Order - name: Marketplace Offer - name: Marketplace Invoicing - name: Sales Channel - name: Payment - name: Warehouse Assistant - name: Worker paths: /v2/sales-channels/{salesChannelId}/shop/connection-tests: post: tags: - wawi - Sales Channel summary: Test Shop Connection description: >- Runs a live connection and credentials test against a Wawi-managed webshop and reports the verdict. Mirrors the 'Verbindung testen' button of the WPF Verkaufskanalverwaltung. The test performs the shop's dbeS handshake - a POST to the shop's /dbeS/mytest.php with the stored sync credentials, a licence round trip to the JTL license server, and a POST of the resulting licence blob back to the shop - and therefore validates reachability AND credentials in one call. Credentials are never accepted from the caller: they are read server-side from the shop record addressed by salesChannelId, so a caller can only test credentials that are already stored. Two properties of this endpoint are deliberate and must not be 'corrected': (1) It answers HTTP 200 for every completed test, including an unreachable or unauthenticated shop - an unreachable shop is a successful test with a negative verdict, not a failed request, and a diagnostic endpoint whose job is to report a failure must not itself fail. That is why no 502 and no 504 is declared, unlike CreateConnector, where the same live handshake is a means to creating a resource rather than the subject. (2) It is a POST behind saleschannels.write although its name suggests a read: the dbeS handshake rewrites dbo.tBroken and two dbo.tOptions rows on every run, so a caller that loops this endpoint re-hits the JTL license server and rewrites those rows each time. The handshake is bounded by an internal timeout well below the platform request timeout, so a slow or unreachable shop returns Status = TimedOut rather than letting the platform timeout fire; there is no SSE, so the check is synchronous by design. operationId: Shop_TestShopConnection parameters: - name: salesChannelId in: path required: true description: >- 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. schema: type: string - name: Idempotency-Key in: header description: >- 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. schema: type: string maxLength: 255 minLength: 1 - name: x-tenant-id in: header required: true schema: type: string format: uuid description: The tenant ID for the target ERP instance. responses: '200': description: >- 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. content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopConnectionTestResult '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '404': description: >- Malformed sales channel id, the sales channel does not name an online-shop channel, or the named shop is not Wawi-managed. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' security: - oauth2-authorization-code: - saleschannels.write - oauth2-client-credentials: - saleschannels.write components: schemas: JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopConnectionTestResult: type: object description: >- Verdict of a completed connection test. Carries no credential and no part of one - not the value, not its length, not a hash. additionalProperties: false required: - status properties: status: $ref: >- #/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopConnectionTestStatus description: >- 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. latencyMs: type: integer description: >- Wall-clock duration of the outbound handshake in milliseconds, measured by this endpoint around all three sequential dbeS round trips. Null when no call was attempted (Status = NotConfigured). Diagnostic only - not an SLA and not comparable across networks. format: int64 shopVersion: type: string description: >- The shop's own version token as reported by its dbeS 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: type: string description: >- 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: type: string description: >- 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. FastEndpoints.ProblemDetails: type: object additionalProperties: false properties: type: type: string default: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1 title: type: string default: One or more validation errors occurred. status: type: integer format: int32 default: 400 instance: type: string default: /api/route traceId: type: string default: 0HMPNHL0JHL76:00000001 detail: type: string errors: type: array items: $ref: '#/components/schemas/FastEndpoints.ProblemDetails_Error' JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopConnectionTestStatus: type: integer description: >- 0 = Unknown, 1 = Succeeded, 2 = AuthenticationFailed, 3 = Unreachable, 4 = TimedOut, 5 = IncompatibleVersion, 6 = InvalidResponse, 7 = NotConfigured format: int32 x-enumNames: - Unknown - Succeeded - AuthenticationFailed - Unreachable - TimedOut - IncompatibleVersion - InvalidResponse - NotConfigured enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 FastEndpoints.ProblemDetails_Error: type: object additionalProperties: false properties: name: type: string default: Error or field name reason: type: string default: Error reason code: type: string severity: type: string securitySchemes: oauth2-authorization-code: type: oauth2 flows: authorizationCode: authorizationUrl: https://id.jtl-cloud.com/oauth/v2/authorize tokenUrl: https://id.jtl-cloud.com/oauth/v2/token scopes: inventories.write: Grants permission to modify stock levels. inventory.read: Grants permission to read stock levels. inventory.write: Grants permission to modify stock levels. items.read: Grants permission to read item data. items.write: Grants permission to create and modify item data. procurements.read: Beschaffung lesen saleschannels.read: Grants permission to read sales channels. saleschannels.write: Grants permission to create and modify sales channels. all.read: Allows the application to read all data. customers.read: Grants permission to read customer data. customers.write: Grants permission to create and modify customer data. customfields.read: Grants permission to read custom fields. customfields.write: Grants permission to create and modify custom fields. deliveries.read: Grants permission to read deliveries. deliveries.write: Grants permission to create and modify deliveries. deliverynotes.print: Grants permission to print and output delivery notes. deliverynotes.read: Grants permission to read delivery notes. deliverynotes.write: Grants permission to create and modify delivery notes. extensibility.integration: >- Grants permission to manage extensions and integrations of the JTL-Wawi. inventories.read: Grants permission to read stock levels. invoices.read: Grants permission to read invoices. invoices.write: Grants permission to create and modify invoices. labels.read: Grants permission to read labels. labels.write: Grants permission to create and modify labels. masterdata.read: >- Read master data such as shipping methods, payment methods, color codes and tax classes. orders.read: Grants permission to read orders. picklists.read: Grants permission to read pick lists. picklists.write: Grants permission to create and modify pick lists. returns.read: Grants permission to read returns. returns.write: Grants permission to create and modify returns. salesinvoicecorrections.read: Grants permission to read invoice corrections. salesinvoicecorrections.write: Grants permission to create and modify invoice corrections. salesorders.print: Grants permission to print and output sales orders. salesorders.read: Grants permission to read sales orders. salesorders.write: Grants permission to create and modify sales orders. system.config.read: Grants permission to read the system configuration. system.config.write: Grants permission to modify the system configuration. taxes.read: Grants permission to read tax data. warehouse.read: Grants permission to read warehouse data. wawiapp.all: Grants access to Wawi app related operations. currencies.read: Grants read access to currencies. jera.read: Grants read access to JERA internal endpoints. paymentmethods.read: Grants read access to payment methods. payments.read: Ermöglicht den Lesezugriff auf Zahlungen. payments.write: Ermöglicht den Schreibzugriff auf Zahlungen. salesinvoicecorrections.print: Grants permission to print and output invoice corrections. salesinvoices.print: Grants permission to print and output sales invoices. salesinvoices.read: Grants read access to sales invoices. salesinvoices.write: Grants write access to sales invoices. salesquotations.print: Grants permission to print and output sales quotations. salesquotations.read: Grants read access to sales quotations. salesquotations.write: Grants write access to sales quotations. system.worker.read: Worker-Synchronisationen lesen system.worker.write: Worker-Synchronisationen schreiben resources.read: Grants permission to read resource management data. resources.write: Grants permission to create and modify resource management data. pps.read: Grants permission to read production data. pps.write: Grants permission to create and modify production data. channels.read: Grants permission to read marketplace channels. invoices.print: >- Grants permission to print marketplace external documents (invoices, credit notes). marketplaceoffers.read: Grants permission to read marketplace offers and offer failures. marketplaceoffers.write: Grants permission to create and modify marketplace offers. notifications.read: Grants permission to read marketplace notifications. orders.write: >- Grants permission to modify marketplace order data (exclude/reset cancellation, payment, return and shipping uploads). masterdata.write: Write master data taxes.write: Grants permission to create and modify tax data. application.runas: >- Allows the application to execute requests on behalf of another user. oauth2-client-credentials: type: oauth2 flows: clientCredentials: tokenUrl: https://id.jtl-cloud.com/oauth/v2/token scopes: inventories.write: Grants permission to modify stock levels. inventory.read: Grants permission to read stock levels. inventory.write: Grants permission to modify stock levels. items.read: Grants permission to read item data. items.write: Grants permission to create and modify item data. procurements.read: Beschaffung lesen saleschannels.read: Grants permission to read sales channels. saleschannels.write: Grants permission to create and modify sales channels. all.read: Allows the application to read all data. customers.read: Grants permission to read customer data. customers.write: Grants permission to create and modify customer data. customfields.read: Grants permission to read custom fields. customfields.write: Grants permission to create and modify custom fields. deliveries.read: Grants permission to read deliveries. deliveries.write: Grants permission to create and modify deliveries. deliverynotes.print: Grants permission to print and output delivery notes. deliverynotes.read: Grants permission to read delivery notes. deliverynotes.write: Grants permission to create and modify delivery notes. extensibility.integration: >- Grants permission to manage extensions and integrations of the JTL-Wawi. inventories.read: Grants permission to read stock levels. invoices.read: Grants permission to read invoices. invoices.write: Grants permission to create and modify invoices. labels.read: Grants permission to read labels. labels.write: Grants permission to create and modify labels. masterdata.read: >- Read master data such as shipping methods, payment methods, color codes and tax classes. orders.read: Grants permission to read orders. picklists.read: Grants permission to read pick lists. picklists.write: Grants permission to create and modify pick lists. returns.read: Grants permission to read returns. returns.write: Grants permission to create and modify returns. salesinvoicecorrections.read: Grants permission to read invoice corrections. salesinvoicecorrections.write: Grants permission to create and modify invoice corrections. salesorders.print: Grants permission to print and output sales orders. salesorders.read: Grants permission to read sales orders. salesorders.write: Grants permission to create and modify sales orders. system.config.read: Grants permission to read the system configuration. system.config.write: Grants permission to modify the system configuration. taxes.read: Grants permission to read tax data. warehouse.read: Grants permission to read warehouse data. wawiapp.all: Grants access to Wawi app related operations. currencies.read: Grants read access to currencies. jera.read: Grants read access to JERA internal endpoints. paymentmethods.read: Grants read access to payment methods. payments.read: Ermöglicht den Lesezugriff auf Zahlungen. payments.write: Ermöglicht den Schreibzugriff auf Zahlungen. salesinvoicecorrections.print: Grants permission to print and output invoice corrections. salesinvoices.print: Grants permission to print and output sales invoices. salesinvoices.read: Grants read access to sales invoices. salesinvoices.write: Grants write access to sales invoices. salesquotations.print: Grants permission to print and output sales quotations. salesquotations.read: Grants read access to sales quotations. salesquotations.write: Grants write access to sales quotations. system.worker.read: Worker-Synchronisationen lesen system.worker.write: Worker-Synchronisationen schreiben resources.read: Grants permission to read resource management data. resources.write: Grants permission to create and modify resource management data. pps.read: Grants permission to read production data. pps.write: Grants permission to create and modify production data. channels.read: Grants permission to read marketplace channels. invoices.print: >- Grants permission to print marketplace external documents (invoices, credit notes). marketplaceoffers.read: Grants permission to read marketplace offers and offer failures. marketplaceoffers.write: Grants permission to create and modify marketplace offers. notifications.read: Grants permission to read marketplace notifications. orders.write: >- Grants permission to modify marketplace order data (exclude/reset cancellation, payment, return and shipping uploads). masterdata.write: Write master data taxes.write: Grants permission to create and modify tax data. application.runas: >- Allows the application to execute requests on behalf of another user. ````