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

Definition of shop actions

WEBSALE refers to shop actions as requests sent to the shop system to perform specific operations — for example, adding a product to the watchlist, signing in, 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 can arise, for example, when a product is no longer available, required prerequisites are not met, or an unexpected system error occurs. In such cases the system returns an error code.

Error messages

These error codes are not suitable for direct output in the frontend, however, because shoppers cannot interpret them. To display a meaningful and contextually appropriate error message in the shop, these technical codes have to be mapped to readable text. For this purpose, WEBSALE automatically creates a text snippet for every error code. The error text shown in the frontend can be customised via this text snippet.

Structure of the ws.error text snippets

The names of these text snippets always start with ws.error. This means they can also be found and maintained specifically via the search of the text snippet service in the Admin Interface. The naming generally follows this scheme:
ws.error.<configId>.<errorCode>
In most cases <configId> corresponds to the affected action configuration below actions, and <errorCode> corresponds to the respective error code of the action.

Determining the meaning of a ws.error text snippet

Example:
ws.error.accountDelete.actionNotAllowed
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 associated action configuration actions.accountDelete. There, in the error codes section, you will find the description for actionNotAllowed. The description of the error code explains in which case the message is output and thus helps you to formulate an appropriate text for the error for display in the frontend.

Success messages

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

Email templates

In addition, the actions also contain configuration options for email templates that are sent as part of certain successful actions — for example, on a successful registration or a completed order. Here, sender, recipient, subject and email template can be configured.

REST API configuration

Action error codes for which a ws.error text snippet has been generated can no longer be edited via the REST API configuration. Email templates are not affected by this.

Overview of actions for error texts & emails

  • actions - Alphabetical overview — These pages let you quickly find all actions and jump directly to the corresponding thematic group. They serve as a central reference for a targeted search and an efficient handling of individual action configurations.
  • actions - Sign-in & registration — This page contains all actions related to the sign-in and registration process in the online shop. All messages and email templates that are output during sign-in, unblocking an account, or resetting a password etc. are documented here.
  • actions - User account — This page contains all actions related to the user account and thus includes all messages and email templates that occur when account data is created, changed, deleted or checked.
  • actions - Newsletter — This page contains all actions related to newsletter dispatch.
  • actions - Products — This page contains all actions related to products.
  • actions - Security & data protection — This page contains all actions related to security and data protection in the shop. This includes messages and notifications around session control and the consent layer for managing user consents.
  • actions - Test mode — This area covers all actions used to control test mode. They allow you to enable, disable or toggle the test mode within the system.
  • actions - Basket & checkout — This page contains all actions that are performed during the order process in the shop.
  • actions - Forms — This page contains all actions related to submitting forms. The associated messages and email templates output when forms are sent through the shop are documented here — for example, for contact, inquiry or service forms.