Zum Hauptinhalt springen
Der Abschnitt actions beschreibt die Konfiguration von Fehlermeldungen und E-Mail-Vorlagen. Die Knoten unterhalb von actions werden in der Konfigurationsübersicht des Admin-Interface nicht als eigene Gruppe angeboten. Stattdessen wird ein einzelner Knoten über seinen Deeplink oder über die REST API geöffnet. Für die Fehlertexte selbst ist das zweitrangig, weil diese ausschließlich über Textbausteine gepflegt werden. Der Direktaufruf wird nur für die E-Mail-Vorlagen innerhalb der Aktionen benötigt.
**Fehlertexte sind schreibgeschützt.** Die Fehlercode-Felder auf dieser Seite enthalten den Namen eines Textbausteins (ws.error.<configId>.<errorCode>), nicht den Fehlertext. Gepflegt wird der Text ausschließlich im Textbaustein-Dienst des Admin-Interface – Änderungen an der Konfiguration werden beim Speichern abgewiesen, auch über die [REST API](/schnittstellen/admin-interface-api/api-referenz-konfiguration). E-Mail-Vorlagen sind nicht betroffen.

​
Definition Shopaktionen

Als Shopaktionen bezeichnet WEBSALE Anfragen an das Shopsystem, um bestimmte Vorgänge auszuführen – beispielsweise das Hinzufügen eines Produkts zur Merkliste, den Login-Vorgang, das Anlegen eines Benutzerkontos oder andere Aktionen, die eine Interaktion mit dem Backend erfordern. Das Shopsystem prüft dabei die Anfrage und führt die angeforderte Aktion aus, sofern keine Fehler auftreten. Fehler können beispielsweise entstehen, wenn ein Produkt nicht mehr verfügbar ist, erforderliche Voraussetzungen nicht erfüllt sind oder ein unerwarteter Systemfehler vorliegt. In diesen Fällen liefert das System einen Fehlercode zurück.

​
Fehlermeldungen

Solche Fehlercodes sind für die direkte Ausgabe im Frontend jedoch nicht geeignet, da sie für Käufer nicht verständlich sind. Damit im Shop eine sprechende und fachlich passende Fehlermeldung angezeigt werden kann, müssen diese technischen Codes einem lesbaren Text zugeordnet werden. Hierfür erzeugt WEBSALE für jeden Fehlercode automatisch einen Textbaustein. Der im Frontend ausgegebene Fehlertext wird ausschließlich über diesen Textbaustein gepflegt. Für nahezu alle Aktionen sind diese Textbausteine mit verständlichen deutschen Standardtexten vorbelegt. Dies betrifft unter anderem die Bereiche Anmeldung, Registrierung, Adressen, Warenkorb, Checkout, Gutscheine, Newsletter, Merkliste sowie die Zahlungsarten Kreditkarte, PayPal und Stripe. Sie müssen die Texte also nicht selbst formulieren, können sie aber jederzeit im jeweiligen Textbaustein überschreiben. Die Fehlercode-Felder in der Aktions-Konfiguration selbst sind schreibgeschützt. Ihr Wert ist der Name des Textbausteins (beispielsweise ws.error.accountDelete.actionNotAllowed), nicht der Fehlertext. Änderungen daran werden im Admin-Interface und über die REST-API beim Speichern abgewiesen. E-Mail-Vorlagen innerhalb der actions.*-Konfiguration sind davon nicht betroffen und bleiben regulär editierbar.

​
Aufbau der Textbausteine ws.error

Die Namen dieser Textbausteine beginnen immer mit ws.error. Dadurch lassen sie sich auch gezielt über die Suche des Textbaustein-Dienstes im Admin-Interface finden und pflegen. Die Benennung folgt in der Regel diesem Schema:
Dabei entspricht <configId> in vielen Fällen der betroffenen Aktionskonfiguration unterhalb von actions, und <errorCode> dem jeweiligen Fehlercode der Aktion.

​
Bedeutung eines ws.error - Textbausteins ermitteln

Beispiel:
Um die Bedeutung eines solchen Textbausteins zu ermitteln, wird der mittlere Teil des Namens betrachtet, hier also accountDelete. Anschließend kann in der Dokumentation nach der zugehörigen Aktionskonfiguration actions.accountDelete gesucht werden. Dort findet sich im Abschnitt der Fehlercodes die Beschreibung zu actionNotAllowed. Die Beschreibung des Fehlercodes erläutert, in welchem Fall die Meldung ausgegeben wird, und hilft Ihnen somit, den passenden Fehlertext für die Frontend-Darstellung zu formulieren.

​
Erfolgsmeldungen

Erfolgsmeldungen sind nicht Bestandteil der Aktions-Konfigurationen. Sie werden direkt über die Templates der Storefront definiert und können dort bei Bedarf angepasst werden. Die darin enthaltenen Texte lassen sich über die Templates selbst oder über die zugehörigen Textbausteine ändern.

​
E-Mail-Vorlagen

Die Aktionen enthalten zusätzlich Konfigurationsmöglichkeiten für E-Mail-Vorlagen, die im Rahmen bestimmter erfolgreicher Aktionen versendet werden, beispielsweise bei einer erfolgreichen Registrierung oder einer abgeschlossenen Bestellung. Hier können Absender, Empfänger, Betreff und E-Mail-Vorlage hinterlegt werden. Da die Aktionen in der Konfigurationsübersicht nicht angeboten werden, führen zwei Wege zu diesen Feldern: der Deeplink des jeweiligen Knotens oder die REST API Konfiguration. Die vollständige Liste aller Aktionsknoten mit fertigem Deeplink steht unter Konfigurations-Deeplinks.

​
REST API Konfiguration

Fehlercode-Felder, für die ein ws.error-Textbaustein erzeugt worden ist, sind in der Aktions-Konfiguration schreibgeschützt hinterlegt. Sie können daher nicht über die REST API Konfiguration bearbeitet werden - die Anpassung des ausgegebenen Textes erfolgt ausschließlich über den jeweiligen Textbaustein. E-Mail-Vorlagen sind davon nicht betroffen.

​
Übersicht der actions für Fehlertexte & E-Mails

  • actions - Alphabetische Übersicht — Über diese Seiten lassen sich alle Aktionen schnell auffinden und direkt zur entsprechenden thematischen Gruppe aufrufen. Sie dient damit als zentrale Referenz für eine gezielte Suche und eine effiziente Bearbeitung einzelner Aktionskonfigurationen.
  • actions - Anmeldung & Registrierung — Diese Seite enthält alle Aktionen, die den Anmeldungs- und Registrierungsprozess im Onlineshop betreffen. Hier sind alle Meldungen und E-Mail-Vorlagen dokumentiert, die beim Anmelden, beim Entsperren eines Kontos oder beim Zurücksetzen eines Passworts ausgegeben werden.
  • actions - Benutzerkonto — Diese Seite enthält alle Aktionen, die das Benutzerkonto betreffen, und enthält somit alle Meldungen und E-Mail-Vorlagen, die beim Erstellen, Ändern, Löschen und Prüfen von Kontodaten auftreten.
  • actions - Formulare — Diese Seite enthält alle Aktionen, die das Absenden von Formularen betreffen. Hier werden die zugehörigen Meldungen und E-Mail-Vorlagen dokumentiert, die beim Versenden von Formularen über den Shop ausgegeben werden – beispielsweise bei Kontakt-, Anfrage- oder Serviceformularen.
  • actions - Newsletter — Diese Seite enthält alle Aktionen, die den Newsletter-Versand betreffen.
  • actions - Produkte — Diese Seite enthält alle Aktionen, die im Zusammenhang mit Produkten stehen.
  • actions - Sicherheit & Datenschutz — Diese Seite enthält alle Aktionen, die die Sicherheit und den Datenschutz im Shop betreffen. Dazu zählen Meldungen und Benachrichtigungen rund um die Sitzungssteuerung und den Consent Layer zur Verwaltung von Einwilligungen.
  • actions - Testmodus — Dieser Bereich umfasst alle Aktionen, die zur Steuerung des Testmodus dienen. Sie ermöglichen das Aktivieren, Deaktivieren oder Umschalten des Testmodus innerhalb des Systems.
  • actions - Warenkorb & Checkout — Diese Seite enthält alle Aktionen, die während des Bestellvorgangs im Shop ausgeführt werden.