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.

Inhaltsverzeichnis

1 1. Übersicht der Aktionen
2 2. actions.account* - Benutzer
3 3. actions.address* - Adressdaten
4 4. actions.creditCardDelete - Gespeicherte Kreditkarte löschen
5 5. actions.confirmZipCode - Postleitzahl bestätigen
6 6. actions.email* - E-Mail-Adresse für den Login
- 6.1 6.1 actions.emailUpdate - E-Mail-Adresse ändern
- 6.2 6.2 actions.emailVerify - E-Mail-Adresse bestätigen
7 7. actions.set* - Datenzuweisung & Aktualisierung
- 7.1 7.1 actions.setCustomerData - Kundenzusatzdaten
- 7.2 7.2 actions.setMainAddress - Hauptadresse festlegen
8 8. actions.subAccountCreate - Unterkonten (Sub-Accounts) anlegen

1. Übersicht der Aktionen

Folgend eine Auflistung aller Aktionen, die für Benutzerkonten angeboten werden.

Aktionen, die inhaltlich zu einem anderen Themenbereich gehören, finden sich in den entsprechenden Abschnitten dieser Dokumentation oder in der alphabetischen Übersicht der Aktionen.

Auszug der Grundstruktur `actions`:

{
    "actions": {
      ...
      "accountDelete": {...},
      "accountDisplayNameUpdate": {...},
      "accountRegister": {...},
      "addressCreate": {...},
      "addressDelete": {...},
      "addressUpdate": {...},
      "creditCardDelete": {...},
      "confirmZipCode": {...},
      "emailUpdate": {...},
      "emailVerify": {...},
      "setCustomerData": {...},
      "setMainAddress": {...},
      "subAccountCreate": {...},
      "userInvitation": {...},
      ...
    }
}

Aktionsübersicht

Aktion	Beschreibung

Aktion	Beschreibung
`accountDelete`	Konfiguriert die verwendeten E-Mail-Vorlagen für Bestätigungs- und Double-Opt-In-Mails sowie mögliche Fehlermeldungen bei der Kontolöschung.
`accountDisplayNameUpdate`	Hier wird festgelegt, welche Fehlertexte bei fehlenden Eingaben oder nicht angemeldeten Benutzern während der Änderung des Namens ausgegeben werden.
`accountRegister`	Definiert die Fehlertexte bei der Registrierung neuer Kundinnen und Kunden.
`addressCreate`	Definiert die Fehlermeldungen beim Erstellen neuer Adressen im Kundenkonto.
`addressUpdate`	Definiert die Fehlermeldungen beim Aktualisieren bestehender Adressen im Kundenkonto.
`addressDelete`	Definiert die Fehlermeldungen beim Löschen der Adressen im Kundenkonto.
`creditCardDelete`	Definiert die Fehlermeldungen beim Entfernen gespeicherter Pseudokreditkartendaten aus dem Kundenkonto.
`confirmZipCode`	Definiert die Fehlermeldungen bei der Überprüfung einer evtl. ungültig angegebenen Postleitzahl.
`emailUpdate`	Definiert die Fehlermeldungen bei der Aktualisierung der E-Mail-Adresse im Kundenkonto.
`emailVerify`	Definiert die Fehlermeldungen bei der Verifizierung der E-Mail-Adresse im Kundenkonto.
`setCustomerData`	Definiert die Fehlermeldungen beim Speichern oder Aktualisieren von Kundendaten im Shop.
`setMainAddress`	Definiert die Fehlermeldungen beim festlegen einer Hauptadresse im Kundenkonto.
`subAccountCreate`	Definiert die Fehlermeldungen beim Erstellen neuer Unterkonten innerhalb eines bestehenden Kundenkontos.
`userInvitation`	Definiert die Fehlermeldungen beim Einladen neuer Benutzerinnen und Benutzer, beispielsweise zu Unterkonten oder gemeinsam genutzten Kundenkonten. Hier werden sowohl die Einladungs-Mail als auch mögliche Fehlermeldungen bei der Einladungskontrolle definiert.

2. `actions.account*` - Benutzer

Die unter diesem Abschnitt beschriebenen Aktionen betreffen Vorgänge rund um das Benutzerkonto. Sie werden immer dann ausgelöst, wenn der Benutzer eine entsprechende Aktion im Shop ausführt - beispielsweise bei der Registrierung, bei Änderungen am Profil oder beim Löschen des Kontos.

2.1 `actions.accountDelete` - Kontolöschung

Mithilfe der Aktion accountDelete werden die Fehlermeldungen für Anfragen zur Löschung eines Kundenkontos gesteuert. Gleichzeitig wird hier konfiguriert, welche Bestätigungs-E-Mail nach erfolgreicher Löschung versendet wird und ob zusätzlich eine Double-Opt-In-E-Mail zur Bestätigung des Löschwunsches eingesetzt wird.

Beispielkonfiguration:

{
  "confirmationEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Löschung ihres Kontos",
    "template": "accountDelete.htm"
  },
  "doubleOptInEmail": {
    "enabled": false,
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Löschung ihres Kontos",
    "template": "accountDeleteOptIn.htm"
  },
  "errorCodes": {
    "actionNotAllowed": "",
    "notLoggedIn": "Sie sind nicht eingeloggt"
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`confirmationEmail`	array	Konfiguriert die Bestätigungs-E-Mail, die nach erfolgter Kontolöschung an den Kunden gesendet wird. Der Versand kann über `enabled` aktiviert oder deaktiviert werden. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mails & E-Mail Einstellungen
`doubleOptInEmail`	array	Konfiguriert die optionale Double-Opt-In-Email, mit der der Kunde seine Kontolöschung vor der Ausführung bestätigen muss. Der Versand kann über `enabled` aktiviert oder deaktiviert werden. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mails & E-Mail Einstellungen
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`actionNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

2.2 `actions.accountDisplayNameUpdate` - Anzeigename ändern

Mithilfe der Aktion accountDisplayNameUpdate werden die Fehlermeldungen bei der Aktualisierung des öffentlichen Anzeigenamens gesteuert. Dieser wird ausschließlich bei abgegebenen Kundenbewertungen angezeigt und ersetzt dort den echten Namen.

Beispielkonfiguration:

{
  "errorCodes": {
    "missingDisplayname": "",
    "notLoggedIn": ""
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`missingDisplayName`	string	Fehlermeldung, die ausgegeben wird, wenn der Anzeigename nicht übergeben wurde.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.

2.3 `actions.accountRegister` - Benutzer registrieren

Die Aktion accountRegister steuert die Fehlermeldungen bei der Registrierung eines neuen Benutzerkontos im Shop. Optional kann nach erfolgreicher Registrierung eine Bestätigungs- bzw. Verifizierungsmail über verifyEmail versendet werden.

Beispielkonfiguration:

{
  "errorCodes": {
    "accountAlreadyExists": "Account existiert bereits",
    "emailCheckFailed": "E-Mail ungültig",
    "missingId": "E-Mail fehlt",
    "missingPassword": "Passwort fehlt",
    "passwordCheckFailed": "Passwort ungenügend",
    "passwordMismatch": "Passwörter stimmen nicht überein"
  },
  "verifyEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Registrierung",
    "template": "accountRegister.htm"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`accountAlreadyExists`	string	Fehlermeldung, die ausgegeben wird, wenn der Account bereits existiert.
`emailCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
`missingId`	string	Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
`missingPassword`	string	Fehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
`passwordCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
`passwordMismatch`	string	Fehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
`verifyEmail`	object	Konfiguriert die E-Mail, über die der Kunde seine Registrierung bestätigen kann. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mails & E-Mail Einstellungen

3. `actions.address*` - Adressdaten

Dieser Abschnitt enthält alle Aktionen, die die Verwaltung von Adressdaten im Benutzerkonto betreffen. Hier werden die Meldungen dokumentiert, die beim Anlegen, Ändern oder Löschen von Rechnungs- und Lieferadressen im Shop ausgegeben werden.

3.1 `actions.addressCreate` - Adresse anlegen

Die Aktion adressCreate steuert die Fehlermeldungen beim Anlegen einer neuen Adresse im Kundenkonto.

Beispielkonfiguration:

{
  "errorCodes": {
    "notLoggedIn": "Bitte melden Sie sich an, um eine Adresse anzulegen.",
    "emptyAddress": "Bitte füllen Sie alle erforderlichen Adressfelder aus.",
    "unknownField": "Es wurden ungültige Adressfelder übermittelt.",
    "invalidFieldType": "Mindestens ein Adressfeld enthält einen ungültigen Wert."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`emptyAddress`	string	Fehlermeldung, die ausgegeben wird, wenn keine oder unvollständige Adressdaten übermittelt wurden.
`unknownField`	string	Fehlermeldung, die ausgegeben wird, wenn Felder übergeben wurden, die dem System nicht bekannt sind.
`invalidFieldType`	string	Fehlermeldung, die ausgegeben wird, wenn Felder mit einem ungültigen Dateityp gefüllt sind.

3.2 `actions.addressDelete` - Adresse löschen

Die Aktion addressDelete steuert die Fehlermeldungen beim Löschen einer bestehenden Adresse im Kundenkonto.

Beispielkonfiguration:

{
  "errorCodes": {
    "notLoggedIn": "Bitte melden Sie sich an, um eine Adresse zu löschen.",
    "invalidAddressId": "Die ausgewählte Adresse konnte nicht gefunden werden."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`invalidAddressId`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene Adress-ID ungültig ist oder die Adresse nicht gefunden werden kann.

3.3 `actions.addressUpdate` - Adresse bearbeiten

Die Aktion addressUpdate steuert die Fehlermeldungen, die beim Bearbeiten einer bestehenden Adresse im Kundenkonto auftreten.

Beispielkonfiguration:

{
  "errorCodes": {
    "emptyAddress": "Bitte füllen Sie alle erforderlichen Adressfelder aus.",
    "invalidAddressId": "Die ausgewählte Adresse konnte nicht gefunden werden.",
    "unknownField": "Es wurden ungültige Adressfelder übermittelt.",
    "invalidFieldType": "Mindestens ein Adressfeld enthält einen ungültigen Wert.",
    "expressCheckoutNotAllowed": "Die Adresse kann im Express-Checkout nicht geändert werden.",
    "readOnlyField": "Mindestens ein Feld darf nicht geändert werden."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`emptyAddress`	string	Fehlermeldung, die ausgegeben wird, wenn keine oder unvollständige Adressdaten übermittelt wurden.
`invalidAddressId`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene Adress-ID ungültig ist oder die Adresse nicht gefunden werden kann.
`unknownField`	string	Fehlermeldung, die ausgegeben wird, wenn Felder übergeben wurden, die dem System nicht bekannt sind.
`invalidFieldType`	string	Fehlermeldung, die ausgegeben wird, wenn Felder mit einem ungültigen Dateityp gefüllt sind.
`expressCheckoutNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn die Adresse im Rahmen eines Express-Checkouts nicht geändert werden darf.
`readOnlyField`	string	Fehlermeldung, die ausgegeben wird, wenn versucht wird, ein schreibgeschütztes Feld zu ändern.

4. `actions.creditCardDelete` - Gespeicherte Kreditkarte löschen

Die Aktion creditCardDelete definiert die Fehlermeldungen, die beim Löschen einer gespeicherten Kreditkarte ausgegeben werden.

Beispielkonfiguration:

{
  "errorCodes": {
    "notLoggedIn": "Bitte melden Sie sich an, um eine gespeicherte Kreditkarte zu löschen.",
    "missingPseudoId": "Die ausgewählte Kreditkarte konnte nicht gefunden werden."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`missingPseudoId`	string	Fehlermeldung, die ausgegeben wird, wenn keine oder eine ungültige Karten-Referenz übermittelt wurde bzw. die Karte nicht gefunden werden kann.

5. `actions.confirmZipCode` - Postleitzahl bestätigen

Die Aktion confirmZipCode definiert die Fehlermeldungen für die Prüfung, ob die übermittelte Postleitzahl zu einer angegebenen Bestellung passt.

Beispielkonfiguration:

{
  "errorCodes": {
    "missingZipCode": "Bitte geben Sie Ihre Postleitzahl ein.",
    "missingOrderId": "Bitte geben Sie Ihre Bestellnummer ein.",
    "invalidZipCode": "Die angegebene Postleitzahl passt nicht zu dieser Bestellung."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	array	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`missingZipCode`	string	Fehlermeldung, die ausgegeben wird, wenn keine Postleitzahl übermittelt wurde.
`missingOrderId`	string	Fehlermeldung, die ausgegeben wird, wenn keine Bestellnummer übermittelt wurde.
`invalidZipCode`	string	Fehlermeldung, die ausgegeben wird, wenn die Postleitzahl nicht zur Bestellung passt.

6. `actions.email*` - E-Mail-Adresse für den Login

In diesem Abschnitt werden alle Aktionen rund um die E-Mail-Adresse für den Login behandelt. Hier können die E-Mails und Fehlermeldungen konfiguriert werden, die beim Ändern der Login-E-Mail-Adresse sowie bei der Bestätigung bzw. Verifizierung der E-Mail-Adresse über Bestätigungslinks zum Einsatz kommen.

6.1 `actions.emailUpdate` - E-Mail-Adresse ändern

Mit der Aktion emailUpdate werden E-Mails und Fehlermeldungen bei der Änderung der E-Mail-Adresse eines bestehenden Kundenkontos definiert. Dabei können zwei E-Mail-Typen genutzt werden: eine optionale Double-Opt-In-E-Mail und eine Bestätigungs-/Verifizierungs-E-Mail an die neue Adresse.

Beispielkonfiguration:

{
  "verifyEmail": {
    "template": "email_update_verify.htm",
    "subject": "Bitte bestätigen Sie Ihre neue E-Mail-Adresse",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop"
  },
  "doubleOptInEmail": {
    "template": "email_update_double_opt_in.htm",
    "subject": "Bestätigung zur Änderung Ihrer E-Mail-Adresse",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop",
    "enabled": false
  },
  "errorCodes": {
    "missingEmail": "Bitte geben Sie eine E-Mail-Adresse an.",
    "emailCheckFailed": "Die angegebene E-Mail-Adresse ist ungültig.",
    "accountAlreadyExists": "Unter dieser E-Mail-Adresse besteht bereits ein Kundenkonto.",
    "actionNotAllowed": "Die Änderung der E-Mail-Adresse ist aktuell nicht erlaubt."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`verifyEmail`	object	Konfiguriert die E-Mail, über die der Kunde seine Änderung bestätigen kann. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mails & E-Mail Einstellungen
`doubleOptInEmail`	object	Konfiguriert die optionale Double-Opt-In-Email, mit der der Kunde seine Kontolöschung vor der Ausführung bestätigen muss. Der Versand kann über `enabled` aktiviert oder deaktiviert werden. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mails & E-Mail Einstellungen
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`missingEmail`	string	Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
`emailCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
`accountAlreadyExists`	string	Fehlermeldung, die ausgegeben wird, wenn ein Account mit dieser E-Mail-Adresse bereits existiert.
`actionNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

6.2 `actions.emailVerify` - E-Mail-Adresse bestätigen

Mithilfe der Aktion emailVerify können Fehlermeldungen definiert werden, die auftreten, wenn ein Kunde seine E-Mail-Adresse über einen Bestätigungslink (Double-Opt-In) verifizieren soll.

Beispielkonfiguration:

{
  "errorCodes": {
    "actionNotAllowed": "Die E-Mail-Adresse konnte nicht bestätigt werden."
  }
}

Parameterübersicht:

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`actionNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

7. `actions.set*` - Datenzuweisung & Aktualisierung

Dieser Abschnitt umfasst Aktionen, mit denen im laufenden Shop-Kontext bestimmte Daten oder Werte gesetzt bzw. aktualisiert werden.

7.1 `actions.setCustomerData` - Kundenzusatzdaten

Mithilfe der Aktion setCustomerData können Fehlermeldungen bei der Verarbeitung zusätzlicher Kundendaten gesteuert werden. Diese Daten werden beispielsweise über Formulare im Kundenkonto oder im Checkout erfasst.

actions - Benutzerkonto

Inhaltsverzeichnis

1. Übersicht der Aktionen

Auszug der Grundstruktur actions:

Aktionsübersicht

2. actions.account* - Benutzer

2.1 actions.accountDelete - Kontolöschung

Beispielkonfiguration:

Parameterübersicht:

2.2 actions.accountDisplayNameUpdate - Anzeigename ändern

Beispielkonfiguration:

Parameterübersicht:

2.3 actions.accountRegister - Benutzer registrieren

Beispielkonfiguration:

Parameterübersicht

3. actions.address* - Adressdaten

3.1 actions.addressCreate - Adresse anlegen

Beispielkonfiguration:

Parameterübersicht:

3.2 actions.addressDelete - Adresse löschen

Beispielkonfiguration:

Parameterübersicht:

3.3 actions.addressUpdate - Adresse bearbeiten

Beispielkonfiguration:

Parameterübersicht:

4. actions.creditCardDelete - Gespeicherte Kreditkarte löschen

Beispielkonfiguration:

Parameterübersicht:

5. actions.confirmZipCode - Postleitzahl bestätigen

Beispielkonfiguration:

Parameterübersicht:

6. actions.email* - E-Mail-Adresse für den Login

6.1 actions.emailUpdate - E-Mail-Adresse ändern

Beispielkonfiguration:

Parameterübersicht:

6.2 actions.emailVerify - E-Mail-Adresse bestätigen

Beispielkonfiguration:

Parameterübersicht:

7. actions.set* - Datenzuweisung & Aktualisierung

7.1 actions.setCustomerData - Kundenzusatzdaten

Beispielkonfiguration:

Auszug der Grundstruktur `actions`:

2. `actions.account*` - Benutzer

2.1 `actions.accountDelete` - Kontolöschung

2.2 `actions.accountDisplayNameUpdate` - Anzeigename ändern

2.3 `actions.accountRegister` - Benutzer registrieren

3. `actions.address*` - Adressdaten

3.1 `actions.addressCreate` - Adresse anlegen

3.2 `actions.addressDelete` - Adresse löschen

3.3 `actions.addressUpdate` - Adresse bearbeiten

4. `actions.creditCardDelete` - Gespeicherte Kreditkarte löschen

5. `actions.confirmZipCode` - Postleitzahl bestätigen

6. `actions.email*` - E-Mail-Adresse für den Login

6.1 `actions.emailUpdate` - E-Mail-Adresse ändern

6.2 `actions.emailVerify` - E-Mail-Adresse bestätigen

7. `actions.set*` - Datenzuweisung & Aktualisierung

7.1 `actions.setCustomerData` - Kundenzusatzdaten