actions - Benutzerkonto - WEBSALE Dokumentation

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.

Ü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": {
    ...
    "accountActivate": {...},
    "accountActivateOptIn": {...},
    "accountDelete": {...},
    "accountDisplayNameUpdate": {...},
    "accountRegister": {...},
    "addressCreate": {...},
    "addressDelete": {...},
    "addressUpdate": {...},
    "creditCardDelete": {...},
    "confirmZipCode": {...},
    "emailUpdate": {...},
    "emailVerify": {...},
    "setCustomerData": {...},
    "setMainAddress": {...},
    "subAccountCreate": {...},
    "userInvitation": {...},
    ...
  }
}

Aktionsübersicht

Aktion	Beschreibung
`accountActivate`	Konfiguriert die Opt-In-E-Mail sowie die Fehlermeldungen bei der Aktivierung eines bestehenden Kundenkontos durch Bestandskunden.
`accountActivateOptIn`	Konfiguriert die Verifizierungs-E-Mail sowie die Fehlermeldungen bei der Bestätigung des Opt-In-Links im Rahmen der Bestandskundenaktivierung.
`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.

`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.

`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": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`confirmationEmail`	object	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`	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.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`actionNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

`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": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>",
    "insufficientPrivileges": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.
`insufficientPrivileges`	string	Fehlermeldung, die ausgegeben wird, wenn ein Mitarbeiterkonto (Sub-Account) nicht über die nötige Berechtigung verfügt, den eigenen Anzeigenamen zu ändern.

`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": "<Textbaustein>",
    "duplicateAccountFound": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>"
  },
  "verifyEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mein Onlineshop",
    "subject": "Mein Onlineshop | Registrierung",
    "template": "accountRegister.htm"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`accountAlreadyExists`	string	Fehlermeldung, die ausgegeben wird, wenn der Account bereits existiert.
`duplicateAccountFound`	string	Fehlermeldung, die ausgegeben wird, wenn bei der Registrierung eine Dublette gefunden wurde (Duplettenprüfung über accounts.account → `duplicate`).
`emailCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
`missingEmail`	string	Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
`missingId`	string	Fehlermeldung, die ausgegeben wird, wenn keine Login-ID ü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

`actions.accountActivate` - Bestandskunden aktivieren

Die Aktion accountActivate steuert die Opt-In-E-Mail sowie die Fehlermeldungen bei der Aktivierung eines bereits im Shop vorhandenen Kundenkontos durch Bestandskunden. Voraussetzung ist, dass der Kundendatensatz zuvor im Shop angelegt wurde (beispielsweise über einen Import). Weitere Informationen zur Konfiguration der Bestandskundenregistrierung finden sich unter accounts.account. Beispielkonfiguration

{
  "optInEmail": {
    "template": "account/activateAccountOptIn.htm",
    "subject": "Registration attempt for your Account",
    "fromAddress": "no-reply@websale.de",
    "fromName": "Websale Shop"
  },
  "errorCodes": {
    "disabled": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingCustomerNumber": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "accountNotFound": "<Textbaustein>",
    "accountAlreadyActivated": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`optInEmail`	object	Konfiguriert die Opt-In-E-Mail, die nach der Aktivierung an die im Kundenkonto hinterlegte Adresse versendet wird. Der Kunde muss die Registrierung darüber nochmals bestätigen. Der Versand kann in accounts.account über `requireOptIn` deaktiviert werden. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert.
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`disabled`	string	Fehlermeldung, die ausgegeben wird, wenn die Bestandskundenregistrierung deaktiviert ist.
`missingId`	string	Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
`missingCustomerNumber`	string	Fehlermeldung, die ausgegeben wird, wenn keine Kundennummer übermittelt wurde.
`missingPassword`	string	Fehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
`passwordMismatch`	string	Fehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
`emailCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
`passwordCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
`accountNotFound`	string	Fehlermeldung, die ausgegeben wird, wenn kein Konto mit den übermittelten Daten gefunden werden konnte.
`accountAlreadyActivated`	string	Fehlermeldung, die ausgegeben wird, wenn das Konto bereits aktiviert wurde.

`actions.accountActivateOptIn` - Bestandskundenaktivierung Opt-In Bestätigung

Die Aktion accountActivateOptIn steuert die Verifizierungs-E-Mail sowie die Fehlermeldungen, die bei der Bestätigung des Opt-In-Links im Rahmen der Bestandskundenaktivierung auftreten. Diese Aktion greift, nachdem der Kunde den Opt-In-Link aus der von accountActivate versendeten E-Mail aufgerufen hat. Beispielkonfiguration

{
  "verifyEmail": {
    "template": "account/email_verify.htm",
    "subject": "Verify your Email-Address",
    "fromAddress": "no-reply@websale.de",
    "fromName": "Websale Shop"
  },
  "errorCodes": {
    "actionNotAllowed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`verifyEmail`	object	Konfiguriert die Verifizierungs-E-Mail, die nach erfolgreicher Bestätigung des Opt-In-Links an den Kunden versendet wird. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert.
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`actionNotAllowed`	string	Fehlermeldung, die ausgegeben wird, wenn das Opt-In-Token ungültig oder abgelaufen ist.
`accountAlreadyExists`	string	Fehlermeldung, die ausgegeben wird, wenn eine Aufteilung in Firmen-/Mitarbeiterkonten konfiguriert ist und das Mitarbeiterkonto nicht angelegt werden konnte, weil die E-Mail-Adresse bereits vergeben ist.

`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.

`actions.addressCreate` - Adresse anlegen

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

Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "emptyAddress": "<Textbaustein>",
    "unknownField": "<Textbaustein>",
    "invalidFieldType": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.

`actions.addressDelete` - Adresse löschen

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

Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.

`actions.addressUpdate` - Adresse bearbeiten

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

Beispielkonfiguration

{
  "errorCodes": {
    "emptyAddress": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>",
    "unknownField": "<Textbaustein>",
    "invalidFieldType": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "readOnlyField": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.

`actions.creditCardDelete` - Gespeicherte Kreditkarte löschen

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

Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingPseudoId": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.

`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": "<Textbaustein>",
    "missingOrderId": "<Textbaustein>",
    "invalidZipCode": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	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.

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.

`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": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}

Parameterübersicht

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.

`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": "<Textbaustein>"
  }
}

Parameterübersicht

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.

`actions.set*` - Datenzuweisung & Aktualisierung

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

`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.

Beispielkonfiguration

{
  "errorCodes": {
    "fieldCheckFailed": "<Textbaustein>",
    "invalidNumberValue": "<Textbaustein>",
    "invalidCheckboxValue": "<Textbaustein>",
    "requiredCheckboxUnchecked": "<Textbaustein>",
    "requiredTextfieldEmpty": "<Textbaustein>",
    "requiredNumberfieldEmpty": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`fieldCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn eine Feldprüfung fehlschlägt (beispielsweise Pflichtfeld verletzt oder Formatfehler).
`invalidNumberValue`	string	Fehlermeldung, die ausgegeben wird, wenn in einem Zahlenfeld kein gültiger numerischer Wert übermittelt wurde.
`invalidCheckboxValue`	string	Fehlermeldung, die ausgegeben wird, wenn für eine Checkbox ein ungültiger Wert übermittelt wurde.
`requiredCheckboxUnchecked`	string	Fehlermeldung, die ausgegeben wird, wenn eine als erforderlich markierte Checkbox nicht aktiviert wurde.
`requiredTextfieldEmpty`	string	Fehlermeldung, die ausgegeben wird, wenn ein erforderliches Textfeld leer gelassen wurde.
`requiredNumberfieldEmpty`	string	Fehlermeldung, die ausgegeben wird, wenn ein erforderliches Zahlenfeld leer gelassen wurde.

`actions.setMainAddress` - Hauptadresse festlegen

Mit der Aktion setMainAddress werden Fehlermeldungen definiert, die beim Festlegen der Hauptadresse im Kundenkonto auftreten.

Beispielkonfiguration

{
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingAddressId": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>"
  }
}

Parameterübersicht

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

`actions.subAccountCreate` - Unterkonten (Sub-Accounts) anlegen

Die Aktion subAccountCreate definiert Fehlermeldungen, die bei der Registrierung eines Unterkontos zu einem bestehenden Hauptkundenkonto auftreten (beispielsweise für Mitarbeiter-, Filial- oder Team-Accounts).

Beispielkonfiguration

{
  "errorCodes": {
    "disabled": "<Textbaustein>",
    "notLoggedIn": "<Textbaustein>",
    "accountNotVerified": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "accountAlreadyExists": "<Textbaustein>",
    "mailSendFailed": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`disabled`	string	Fehlermeldung, die ausgegeben wird, wenn die Anlage von Unterkonten im Shop grundsätzlich deaktiviert ist.
`notLoggedIn`	string	Fehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
`accountNotVerified`	string	Fehlermeldung, die ausgegeben wird, wenn das Hauptkonto noch nicht verifiziert ist und deshalb keine Unterkonten anlegen darf.
`missingId`	string	Fehlermeldung, die ausgegeben wird, wenn keine Login-ID übermittelt wurde.
`missingEmail`	string	Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
`missingPassword`	string	Fehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
`passwordMismatch`	string	Fehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
`emailCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
`passwordCheckFailed`	string	Fehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
`accountAlreadyExists`	string	Fehlermeldung, die ausgegeben wird, wenn ein Account mit dieser E-Mail-Adresse bereits existiert.
`mailSendFailed`	string	Fehlermeldung, die ausgegeben wird, wenn die Einladungs-E-Mail an das neue Unterkonto nicht versendet werden konnte.

​Übersicht der Aktionen

​Auszug der Grundstruktur actions

​Aktionsübersicht

​actions.account* - Benutzer

​actions.accountDelete - Kontolöschung

​Beispielkonfiguration

​Parameterübersicht

​actions.accountDisplayNameUpdate - Anzeigename ändern

​Beispielkonfiguration

​Parameterübersicht

​actions.accountRegister - Benutzer registrieren

​Beispielkonfiguration

​Parameterübersicht

​actions.accountActivate - Bestandskunden aktivieren

​actions.accountActivateOptIn - Bestandskundenaktivierung Opt-In Bestätigung

​actions.address* - Adressdaten

​actions.addressCreate - Adresse anlegen

​Beispielkonfiguration

​Parameterübersicht

​actions.addressDelete - Adresse löschen

​Beispielkonfiguration

​Parameterübersicht

​actions.addressUpdate - Adresse bearbeiten

​Beispielkonfiguration

​Parameterübersicht

​actions.creditCardDelete - Gespeicherte Kreditkarte löschen

​Beispielkonfiguration

​Parameterübersicht

​actions.confirmZipCode - Postleitzahl bestätigen

​Beispielkonfiguration

​Parameterübersicht

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

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

​Beispielkonfiguration

​Parameterübersicht

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

​Beispielkonfiguration

​Parameterübersicht

​actions.set* - Datenzuweisung & Aktualisierung

​actions.setCustomerData - Kundenzusatzdaten

​Beispielkonfiguration

​Parameterübersicht

​actions.setMainAddress - Hauptadresse festlegen

​Beispielkonfiguration

​Parameterübersicht

​actions.subAccountCreate - Unterkonten (Sub-Accounts) anlegen

​Beispielkonfiguration

​Parameterübersicht

Übersicht der Aktionen

Auszug der Grundstruktur `actions`

Aktionsübersicht

`actions.account*` - Benutzer

`actions.accountDelete` - Kontolöschung

Beispielkonfiguration

Parameterübersicht

`actions.accountDisplayNameUpdate` - Anzeigename ändern

Beispielkonfiguration

Parameterübersicht

`actions.accountRegister` - Benutzer registrieren

Beispielkonfiguration

Parameterübersicht

`actions.accountActivate` - Bestandskunden aktivieren

`actions.accountActivateOptIn` - Bestandskundenaktivierung Opt-In Bestätigung

`actions.address*` - Adressdaten

`actions.addressCreate` - Adresse anlegen

Beispielkonfiguration

Parameterübersicht

`actions.addressDelete` - Adresse löschen

Beispielkonfiguration

Parameterübersicht

`actions.addressUpdate` - Adresse bearbeiten

Beispielkonfiguration

Parameterübersicht

`actions.creditCardDelete` - Gespeicherte Kreditkarte löschen

Beispielkonfiguration

Parameterübersicht

`actions.confirmZipCode` - Postleitzahl bestätigen

Beispielkonfiguration

Parameterübersicht

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

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

Beispielkonfiguration

Parameterübersicht

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

Beispielkonfiguration

Parameterübersicht

`actions.set*` - Datenzuweisung & Aktualisierung

`actions.setCustomerData` - Kundenzusatzdaten

Beispielkonfiguration

Parameterübersicht

`actions.setMainAddress` - Hauptadresse festlegen

Beispielkonfiguration

Parameterübersicht

`actions.subAccountCreate` - Unterkonten (Sub-Accounts) anlegen

Beispielkonfiguration

Parameterübersicht