accounts, basket, general) that are defined in a JSON-like structure.
Within these nodes, the individual parameters are explained along with their possible values.This allows administrators or developers to understand exactly which options are available and how they affect the system’s behavior. All configuration settings can be made either via the Admin Interface or via the REST API configuration.
Alphabetical overview of configurations
- accounts - user accounts — The
accountsconfiguration node covers all settings related to managing user accounts in the online shop. - actions - error texts & emails — The
actionssection describes the configuration of error messages and email templates related to so-called shop actions. - app - WEBSALE APP — The
appnode covers all configurations for connecting and controlling the WEBSALE APP. - authentication - authentication & access data — The
authenticationconfiguration area is used to manage authentication information and access data for external services, interfaces, or systems. - b2b - business-to-business (B2B) — B2B-specific settings (for example groups, permissions, pricing logic).
- basket - shopping cart — The
basketsection covers all settings related to the shopping cart of the online shop. - creditCheck - credit check
- checkout - order process
- content - catalog (categories & products) — The
contentnode forms the central configuration level for all catalog content. - customer - customer data
- finance - currencies & taxes
- general - general shop settings — The
generalnode bundles all general and system-wide basic settings of the online shop. It is one of the most central and at the same time most extensive configuration areas and contains parameters that affect many modules, functions, and presentations of the shop. - inquiry - forms — The
inquirynode controls shop-side forms (for example contact, withdrawal, return, catalog order). - maintenance - maintenance mode
- messages - event-driven emails — The
messagesnode is used to configure custom email notifications that are automatically triggered when certain events or states occur in the shop. - newsletter - newsletter
- payment - payment methods
- search - sorting and filtering
- seoMetaData - metadata & SEO texts
- security - security rules
- storefrontApi - Storefront API
- urls - URLs (web addresses)
- Validation and verification services
- Emails & email settings — The WEBSALE shop system sends a wide variety of emails for different purposes, for example in the checkout, in the customer account, for form inquiries, or for notifications.
Using text snippets in configurations
Configurations generally apply platform-wide and are therefore available to all subshops contained within by default. In addition to purely technical settings, configurations can also contain language-dependent content that is displayed in the frontend, for example names, descriptions, labels, or other display-relevant texts. This is particularly relevant when the same configuration is used in several language versions of a shop. In such cases, it is not sufficient to enter a fixed text value directly in the configuration, since it would otherwise be output identically in all language variants. Example:Definition of the countries offered for selection in the billing and shipping address.
name parameter contains a fixed text value. This value would be displayed directly in the frontend, for example in a country selection list. In a multilingual shop, however, this would be inflexible, since depending on the language, “Germany” or “Allemagne” should be output instead of “Deutschland”.
For this reason, text snippets can also be used for such display-relevant texts:
name parameter does not refer to a fixed text but to a text snippet. The actual language-dependent content is then maintained per language via the text snippet service in the Admin Interface. This way, the same configuration can be used in several language versions of a shop without having to duplicate the configuration structure for each language.
Text snippets in configurations can generally be assigned freely and created individually. This allows language-dependent frontend texts to be managed centrally and reused consistently across different configuration areas.
An exception is automatically generated text snippets for error messages within configurations. In the actions area, the system generates its own text snippets for error codes whose names begin with ws.error. These are used to translate technical error codes into understandable and maintainable frontend error messages. Further information can be found in the section actions - error texts & emails.
Text snippets can be used not only in configurations but also in templates. This is especially useful because templates, like configurations, generally apply to the entire platform. Further information on using text snippets in templates can be found in the section Template Engine.
URL access to configurations (temporary)
The configuration nodes described in this documentation correspond to the technical structures on which the settings in the Admin Interface are based. In the Admin Interface, the individual nodes are organized thematically under the respective services (for example Catalog, Basket, Orders, General). If a particular node cannot be found in the menu, it can currently also be accessed directly via the URL in the browser. The URL always follows this scheme:content.categoryFieldGroup node directly in the Admin Interface.
Direct URL access is currently a temporary workaround as long as many configurations are still provided via “configuration by code” and do not yet have their own clickable interface in the Admin Interface. As soon as the relevant configurations are available via the regular user interface, we reserve the right to disable this call logic at any time.