Skip to main content
The actions section describes the configuration of error messages and email templates associated with so-called shop actions.

​
Definition of shop actions

WEBSALE refers to shop actions as requests to the shop system to perform specific operations — for example, adding a product to the wishlist, the sign-in process, creating a user account or other actions that require an interaction with the backend. The shop system checks the request and performs the requested action if no errors occur. Errors may arise, for example, when a product is no longer available, when required preconditions are not met, or when an unexpected system error occurs. In these cases the system returns an error code.

​
Error messages

Such error codes are, however, not suitable for direct output in the frontend, as they are not understandable to buyers. To display a meaningful and appropriate error message in the shop, these technical codes must be mapped to a readable text. For this purpose, WEBSALE automatically creates a text snippet for every error code. The error text shown in the frontend can be adjusted via this text snippet.

​
Structure of the ws.error text snippets

The names of these text snippets always start with ws.error. This makes them easy to locate and maintain via the search of the text-snippet service in the admin interface. The naming generally follows this scheme:
Here, <configId> typically corresponds to the affected action configuration below actions, and <errorCode> to the respective error code of the action.

​
Determining the meaning of a ws.error text snippet

Example:
To determine the meaning of such a text snippet, look at the middle part of the name — here accountDelete. You can then search the documentation for the corresponding action configuration actions.accountDelete. In the section on error codes you will find the description for actionNotAllowed. The description of the error code explains in which case the message is output and helps you to formulate an appropriate error text for the frontend display.

​
Success messages

Success messages are not part of the action configurations. They are defined directly through the storefront templates and can be adjusted there if needed. The texts contained therein can be changed via the templates themselves or via the associated text snippets.

​
Email templates

Additionally, the actions also provide configuration options for email templates that are sent during certain successful actions — for example, on successful registration or a completed order. Sender, recipient, subject and email template can be defined here.

​
REST API configuration

Error-code fields for which a ws.error text snippet has been generated are stored as read-only in the action configuration. They therefore cannot be edited via the REST API configuration — the output text is adjusted exclusively via the respective text snippet. Email templates are not affected by this.

​
Overview of the actions for error texts & emails

  • actions - Alphabetical overview — This page lets you quickly locate all actions and jump directly to the corresponding thematic group. It serves as a central reference for a targeted search and efficient editing of individual action configurations.
  • actions - Sign-in & registration — This page contains all actions relating to the sign-in and registration process in the online shop. All messages and email templates output during sign-in, when unblocking an account, or when resetting a password are documented here.
  • actions - User account — This page contains all actions relating to the user account and therefore all messages and email templates that occur when creating, changing, deleting and checking account data.
  • actions - Forms — This page contains all actions relating to the submission of forms. The associated messages and email templates output when sending forms via the shop — for example, contact, inquiry or service forms — are documented here.
  • actions - Newsletter — This page contains all actions relating to newsletter dispatch.
  • actions - Products — This page contains all actions related to products.
  • actions - Security & privacy — This page contains all actions relating to security and data protection in the shop. This includes messages and notifications around session control and the consent layer for managing consents.
  • actions - Test mode — This area covers all actions used to control the test mode. They allow you to activate, deactivate or toggle the test mode within the system.
  • actions - Basket & checkout — This page contains all actions executed during the ordering process in the shop.