> ## 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. # Create Shop > Creates a new JTL-Wawi-managed online shop account. The request is validated first; then a live connection and credentials test is run against the shop. If either fails, no shop is created. The customer group, currency and language with the lowest ID are assigned as defaults; they can be changed afterwards via "PUT /v2/sales-channels/{salesChannelId}/shop/customer-groups" or "SaveShopCustomerGroups", "PUT /v2/sales-channels/{salesChannelId}/shop/currencies" or "SaveShopCurrencies", and the corresponding language endpoint. Running the connection test updates the stored connection state, also when simulating. When "simulate" is true, only validation and the connection test run; no shop is created and no sales channel id is returned ("salesChannelId" is omitted in the REST response and null in GraphQL). The sales channel id is assigned by the server and cannot be supplied. ## OpenAPI ````yaml /openapi/erp/2.2.json post /v2/sales-channels/shop/accounts openapi: 3.0.0 info: title: JTL-WAWI API (Cloud) description: "JTL-Wawi-Version: 2.3.0-alpha.1837+Sha.cefeacf\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.2' x-application-version: 2.3.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/shop/accounts: post: tags: - wawi - Sales Channel summary: Create Shop description: >- Creates a new JTL-Wawi-managed online shop account. The request is validated first; then a live connection and credentials test is run against the shop. If either fails, no shop is created. The customer group, currency and language with the lowest ID are assigned as defaults; they can be changed afterwards via "PUT /v2/sales-channels/{salesChannelId}/shop/customer-groups" or "SaveShopCustomerGroups", "PUT /v2/sales-channels/{salesChannelId}/shop/currencies" or "SaveShopCurrencies", and the corresponding language endpoint. Running the connection test updates the stored connection state, also when simulating. When "simulate" is true, only validation and the connection test run; no shop is created and no sales channel id is returned ("salesChannelId" is omitted in the REST response and null in GraphQL). The sales channel id is assigned by the server and cannot be supplied. operationId: Shop_CreateShop parameters: - name: simulate in: query description: >- When true, only validation and the connection test run and no shop is created. Optional; defaults to false. schema: type: boolean - 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. requestBody: x-name: CreateShopRequest description: '' content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.Endpoints.V2.Shop.CreateShopRequest required: true x-position: 1 responses: '201': description: >- The shop account was created; "salesChannelId" identifies it and can be used with "GET /v2/sales-channels/{salesChannelId}/shop/accounts" or "GetShopAccountById". When "simulate" is true, validation and the connection test succeeded and no shop was created; "salesChannelId" is omitted in the REST response and null in GraphQL. The status is 201 in both cases. content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.CreateShopResult '400': description: >- Request validation failed (error code ValidationError): a mandatory field is missing or blank, a length limit is exceeded, "url" is not an absolute http:// or https:// address or matches another JTL-Wawi-managed online shop, "companyId" does not reference an active company, or "rootCategoryId" does not reference an existing category. The connection test is not run and no shop is created. 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' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '502': description: >- The connection test failed and no shop was created. Error codes: shop-authentication-failed - The shop rejected the sync user or sync password. shop-unreachable - The shop could not be reached: DNS, TCP, TLS, or an HTTP error status. shop-incompatible-version - The shop reported that this JTL-Wawi version is incompatible with it. shop-invalid-response - The shop or the JTL license server returned a response that could not be interpreted. shop-not-configured - The shop URL is not a valid http:// or https:// address. content: application/json: schema: $ref: '#/components/schemas/FastEndpoints.ProblemDetails' '504': description: >- The connection test did not complete within the endpoint's internal timeout; no shop was created (error code shop-connection-timed-out). 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.Endpoints.V2.Shop.CreateShopRequest: type: object description: >- Request model for CreateShop command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body. additionalProperties: false required: - name - url - username - password - apiKey - companyId properties: name: type: string description: Name of the shop. Mandatory, at most 255 characters. url: type: string description: >- Absolute http:// or https:// URL of the shop. Mandatory, at most 255 characters. Must not point to the same host and path as another JTL-Wawi-managed online shop, whether active or not. username: type: string description: >- Login name of the sync user for this shop. Mandatory, at most 32 characters. password: type: string description: >- Password of the sync user for this shop. Mandatory. Maximum 111 bytes in UTF-8; multi-byte characters count as several bytes. Write-only; never returned by any endpoint. apiKey: type: string description: >- API key of this shop. Mandatory, at most 64 characters. Write-only; never returned by any endpoint. companyId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.FirmaKey' description: >- ID of the company the shop belongs to. Mandatory; must reference an active company. rootCategoryId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey' description: >- ID of the shop's root category. Optional; when omitted, no root category is set. When given, it must reference an existing category. isActive: type: boolean description: Shop is active. Optional; defaults to true. orderAsOffer: type: boolean description: >- Orders imported from this shop are created as offers rather than as sales orders. Optional; defaults to false. useShopOrderNumber: type: boolean description: >- The shop's own order number is used instead of a JTL-Wawi-generated one. Optional; defaults to false. JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.CreateShopResult: type: object description: Result of creating a JTL-Wawi-managed online shop account. additionalProperties: false properties: salesChannelId: type: string description: >- Sales channel id of the created shop. Opaque, tenant-local composite identifier (not a UUID); use this value to address the shop in follow-up calls. Omitted in the REST response (null in GraphQL) when "simulate" is true, because no shop was created. 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.Data.Contracts.Keys.FirmaKey: type: string description: Represents a key for identifying a firm within the application. format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false JTL.Data.Contracts.Keys.KategorieKey: type: string format: uuid example: b45f6432-2462-4c6f-b00f-1d9d01000000 additionalProperties: false 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. warehouse.read: Grants permission to read warehouse data. 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. 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. warehouse.read: Grants permission to read warehouse data. 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. 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. ````