> ## 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.
# Save Shop Customer Groups
> Declaratively replaces the complete set of tenant-wide customer groups assigned to a shop. The request describes the full desired state - every customer group contained in it is assigned and every customer group not contained in it is unassigned. Exactly one assignment must be marked as the default customer group, and the list must not be empty. When an assigned customer group is removed and still has customers assigned to it, the request must name a replacement customer group for it via Replacements - all affected groups are reported together in a single batched error rather than one at a time. Note on the response shape: unlike a command that returns only the minimal necessary data, this one echoes the complete resulting assignment list, matching the existing sales channel precedent (see SaveShopCurrencies) and the declarative-replace example in ADR-57. Concurrency: this write is last-writer-wins, like SaveShopCurrencies - it takes no If-Match header and no row version, so two concurrent calls for the same shop overwrite each other without a conflict being reported.
## OpenAPI
````yaml /openapi/erp/2.1.json put /v2/sales-channels/{salesChannelId}/shop/customer-groups
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.10095+Sha.f961005\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/customer-groups:
put:
tags:
- wawi
- Sales Channel
summary: Save Shop Customer Groups
description: >-
Declaratively replaces the complete set of tenant-wide customer groups
assigned to a shop. The request describes the full desired state - every
customer group contained in it is assigned and every customer group not
contained in it is unassigned. Exactly one assignment must be marked as
the default customer group, and the list must not be empty. When an
assigned customer group is removed and still has customers assigned to
it, the request must name a replacement customer group for it via
Replacements - all affected groups are reported together in a single
batched error rather than one at a time. Note on the response shape:
unlike a command that returns only the minimal necessary data, this one
echoes the complete resulting assignment list, matching the existing
sales channel precedent (see SaveShopCurrencies) and the
declarative-replace example in ADR-57. Concurrency: this write is
last-writer-wins, like SaveShopCurrencies - it takes no If-Match header
and no row version, so two concurrent calls for the same shop overwrite
each other without a conflict being reported.
operationId: Shop_SaveShopCustomerGroups
parameters:
- name: salesChannelId
in: path
required: true
description: >-
Sales channel id of the Wawi-managed shop whose customer groups are
replaced. 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: x-tenant-id
in: header
required: true
schema:
type: string
format: uuid
description: The tenant ID for the target ERP instance.
requestBody:
x-name: SaveShopCustomerGroupsRequest
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.Endpoints.V2.Shop.SaveShopCustomerGroupsRequest
required: true
x-position: 1
responses:
'200':
description: >-
Successfully replaced the shop customer groups. Returns the
resulting assignments.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.SaveShopCustomerGroupsCommandResponse
'400':
description: >-
The customer group list is empty; no assignment or more than one
assignment is marked as the default; a submitted CustomerGroupId
does not resolve to a customer group in the Wawi customer group
master data; or the same customer group is named more than once.
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'
'409':
description: >-
One or more removed customer groups still have assigned customers
and no matching entry in Replacements. All affected customer groups
are named together in a single error.
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.Endpoints.V2.Shop.SaveShopCustomerGroupsRequest:
type: object
description: >-
Request model for SaveShopCustomerGroups command endpoint.
Route parameters bind from the route, query parameters from the query
string, everything else from the body.
additionalProperties: false
required:
- customerGroups
properties:
customerGroups:
type: array
description: >-
The complete desired set of customer groups for the shop. Any
customer group currently assigned but not contained in this list is
unassigned. Must contain at least one entry, exactly one of which is
marked as the default.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.CustomerGroupAssignment
replacements:
type: array
description: >-
For every removed customer group that still has assigned customers,
names the customer group taking over those customers. Optional and
empty by default - only required when a removal actually needs one.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.CustomerGroupReplacement
JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.SaveShopCustomerGroupsCommandResponse:
type: object
description: >-
Declaratively replaces the complete set of tenant-wide customer groups
assigned to a shop. The request describes the full desired state - every
customer group contained in it is assigned and every customer group not
contained in it is unassigned. Exactly one assignment must be marked as
the default customer group, and the list must not be empty. When an
assigned customer group is removed and still has customers assigned to
it, the request must name a replacement customer group for it via
Replacements - all affected groups are reported together in a single
batched error rather than one at a time. Note on the response shape:
unlike a command that returns only the minimal necessary data, this one
echoes the complete resulting assignment list, matching the existing
sales channel precedent (see SaveShopCurrencies) and the
declarative-replace example in ADR-57. Concurrency: this write is
last-writer-wins, like SaveShopCurrencies - it takes no If-Match header
and no row version, so two concurrent calls for the same shop overwrite
each other without a conflict being reported. - Response
additionalProperties: false
required:
- customerGroups
properties:
customerGroups:
type: array
description: The persisted customer group assignments, in the order submitted.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopCustomerGroupListItem
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.CustomerGroupAssignment:
type: object
description: >-
A single customer group to assign to a shop. Presence in the request
list is the assignment - there is no separate IsAssigned flag.
additionalProperties: false
required:
- customerGroupId
- isDefault
properties:
customerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: The customer group's internal key.
isDefault:
type: boolean
description: >-
This customer group is the shop default customer group. Exactly one
assignment in the request must set this flag.
JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.CustomerGroupReplacement:
type: object
description: >-
Names the replacement customer group for a customer group that is being
removed from the shop and still has assigned customers. Supplied only
for removed groups that have assigned customers.
additionalProperties: false
required:
- removedCustomerGroupId
- replacementCustomerGroupId
properties:
removedCustomerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: The customer group being removed from the shop.
replacementCustomerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: >-
The customer group that takes over the customers of the removed
customer group.
JTL.Wawi.Verkaufskanaele.PublicApi.DataTransferObjects.V2.Shop.ShopCustomerGroupListItem:
type: object
description: >-
A single tenant-wide customer group (dbo.tKundenGruppe), together with
its assignment state for a Wawi-managed webshop.
additionalProperties: false
required:
- customerGroupId
- isAssigned
- isDefault
properties:
customerGroupId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey'
description: The customer group's internal key.
isAssigned:
type: boolean
description: This customer group is currently assigned to the shop.
isDefault:
type: boolean
description: >-
This customer group is the shop default customer group. Only
meaningful while IsAssigned is true.
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
JTL.Data.Contracts.Keys.KundenGruppeKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
securitySchemes:
oauth2-authorization-code:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth
tokenUrl: https://auth.jtl-cloud.com/oauth2/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.
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://auth.jtl-cloud.com/oauth2/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.
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.
````