Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

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

AktionBeschreibung
accountActivateKonfiguriert die Opt-In-E-Mail sowie die Fehlermeldungen bei der Aktivierung eines bestehenden Kundenkontos durch Bestandskunden.
accountActivateOptInKonfiguriert die Verifizierungs-E-Mail sowie die Fehlermeldungen bei der Bestätigung des Opt-In-Links im Rahmen der Bestandskundenaktivierung.
accountDeleteKonfiguriert die verwendeten E-Mail-Vorlagen für Bestätigungs- und Double-Opt-In-Mails sowie mögliche Fehlermeldungen bei der Kontolöschung.
accountDisplayNameUpdateHier wird festgelegt, welche Fehlertexte bei fehlenden Eingaben oder nicht angemeldeten Benutzern während der Änderung des Namens ausgegeben werden.
accountRegisterDefiniert die Fehlertexte bei der Registrierung neuer Kundinnen und Kunden.
addressCreateDefiniert die Fehlermeldungen beim Erstellen neuer Adressen im Kundenkonto.
addressUpdateDefiniert die Fehlermeldungen beim Aktualisieren bestehender Adressen im Kundenkonto.
addressDeleteDefiniert die Fehlermeldungen beim Löschen der Adressen im Kundenkonto.
creditCardDeleteDefiniert die Fehlermeldungen beim Entfernen gespeicherter Pseudokreditkartendaten aus dem Kundenkonto.
confirmZipCodeDefiniert die Fehlermeldungen bei der Überprüfung einer evtl. ungültig angegebenen Postleitzahl.
emailUpdateDefiniert die Fehlermeldungen bei der Aktualisierung der E-Mail-Adresse im Kundenkonto.
emailVerifyDefiniert die Fehlermeldungen bei der Verifizierung der E-Mail-Adresse im Kundenkonto.
setCustomerDataDefiniert die Fehlermeldungen beim Speichern oder Aktualisieren von Kundendaten im Shop.
setMainAddressDefiniert die Fehlermeldungen beim festlegen einer Hauptadresse im Kundenkonto.
subAccountCreateDefiniert die Fehlermeldungen beim Erstellen neuer Unterkonten innerhalb eines bestehenden Kundenkontos.
userInvitationDefiniert 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": "",
    "notLoggedIn": "Sie sind nicht eingeloggt"
  }
}

Parameterübersicht

ParameterTypBeschreibung
confirmationEmailarrayKonfiguriert 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
doubleOptInEmailarrayKonfiguriert 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
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
actionNotAllowedstringFehlermeldung, 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": "",
    "notLoggedIn": ""
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingDisplayNamestringFehlermeldung, die ausgegeben wird, wenn der Anzeigename nicht übergeben wurde.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.

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

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
accountAlreadyExistsstringFehlermeldung, die ausgegeben wird, wenn der Account bereits existiert.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
missingIdstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
missingPasswordstringFehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
passwordCheckFailedstringFehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
passwordMismatchstringFehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
verifyEmailobjectKonfiguriert 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 (z.B. ü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": "Bestandskundenregistrierung ist deaktiviert.",
    "missingId": "Fehlende E-Mail Adresse",
    "missingCustomerNumber": "Fehlende Kundennummer",
    "missingPassword": "Fehlendes Passwort",
    "passwordMismatch": "Passwörter stimmen nicht überein",
    "emailCheckFailed": "E-Mail Adresse ist ungültig",
    "passwordCheckFailed": "Passwort entspricht nicht den Anforderungen",
    "accountNotFound": "Konto nicht gefunden",
    "accountAlreadyActivated": "Konto ist bereits aktiviert"
  }
}
Parameterübersicht
ParameterTypBeschreibung
optInEmailobjectKonfiguriert 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.
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
disabledstringFehlermeldung, die ausgegeben wird, wenn die Bestandskundenregistrierung deaktiviert ist.
missingIdstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
missingCustomerNumberstringFehlermeldung, die ausgegeben wird, wenn keine Kundennummer übermittelt wurde.
missingPasswordstringFehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
passwordMismatchstringFehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
passwordCheckFailedstringFehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
accountNotFoundstringFehlermeldung, die ausgegeben wird, wenn kein Konto mit den übermittelten Daten gefunden werden konnte.
accountAlreadyActivatedstringFehlermeldung, 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": "Das Opt-In Token ist für diese Aktion nicht gültig",
    "accountAlreadyExists": "Eine Aufteilung in Firmenkonten/Mitarbeiterkonten ist konfiguriert und es konnte kein Mitarbeiterkonto angelegt werden, weil die EMail schon benutzt wird."
  }
}
Parameterübersicht
ParameterTypBeschreibung
verifyEmailobjectKonfiguriert 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.
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
actionNotAllowedstringFehlermeldung, die ausgegeben wird, wenn das Opt-In-Token ungültig oder abgelaufen ist.
accountAlreadyExistsstringFehlermeldung, 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": "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

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
emptyAddressstringFehlermeldung, die ausgegeben wird, wenn keine oder unvollständige Adressdaten übermittelt wurden.
unknownFieldstringFehlermeldung, die ausgegeben wird, wenn Felder übergeben wurden, die dem System nicht bekannt sind.
invalidFieldTypestringFehlermeldung, 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": "Bitte melden Sie sich an, um eine Adresse zu löschen.",
    "invalidAddressId": "Die ausgewählte Adresse konnte nicht gefunden werden."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
invalidAddressIdstringFehlermeldung, 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": "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

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
emptyAddressstringFehlermeldung, die ausgegeben wird, wenn keine oder unvollständige Adressdaten übermittelt wurden.
invalidAddressIdstringFehlermeldung, die ausgegeben wird, wenn die angegebene Adress-ID ungültig ist oder die Adresse nicht gefunden werden kann.
unknownFieldstringFehlermeldung, die ausgegeben wird, wenn Felder übergeben wurden, die dem System nicht bekannt sind.
invalidFieldTypestringFehlermeldung, die ausgegeben wird, wenn Felder mit einem ungültigen Dateityp gefüllt sind.
expressCheckoutNotAllowedstringFehlermeldung, die ausgegeben wird, wenn die Adresse im Rahmen eines Express-Checkouts nicht geändert werden darf.
readOnlyFieldstringFehlermeldung, 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": "Bitte melden Sie sich an, um eine gespeicherte Kreditkarte zu löschen.",
    "missingPseudoId": "Die ausgewählte Kreditkarte konnte nicht gefunden werden."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
missingPseudoIdstringFehlermeldung, 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": "Bitte geben Sie Ihre Postleitzahl ein.",
    "missingOrderId": "Bitte geben Sie Ihre Bestellnummer ein.",
    "invalidZipCode": "Die angegebene Postleitzahl passt nicht zu dieser Bestellung."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesarrayKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingZipCodestringFehlermeldung, die ausgegeben wird, wenn keine Postleitzahl übermittelt wurde.
missingOrderIdstringFehlermeldung, die ausgegeben wird, wenn keine Bestellnummer übermittelt wurde.
invalidZipCodestringFehlermeldung, die ausgegeben wird, wenn die Postleitzahl nicht zur Bestellung passt.

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.

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

ParameterTypBeschreibung
verifyEmailobjectKonfiguriert 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
doubleOptInEmailobjectKonfiguriert 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
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
accountAlreadyExistsstringFehlermeldung, die ausgegeben wird, wenn ein Account mit dieser E-Mail-Adresse bereits existiert.
actionNotAllowedstringFehlermeldung, 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": "Die E-Mail-Adresse konnte nicht bestätigt werden."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
actionNotAllowedstringFehlermeldung, 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": "Mindestens ein Feld enthält einen ungültigen oder unvollständigen Wert.",
    "invalidNumberValue": "Bitte geben Sie in diesem Feld eine gültige Zahl ein.",
    "invalidCheckboxValue": "Der Wert für diese Auswahl ist ungültig.",
    "requiredCheckboxUnchecked": "Bitte aktivieren Sie diese Option, um fortzufahren.",
    "requiredTextfieldEmpty": "Bitte füllen Sie alle als Pflichtfeld gekennzeichneten Eingabefelder aus."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
fieldCheckFailedstringFehlermeldung, die ausgegeben wird, wenn eine Feldprüfung fehlschlägt (z.B. Pflichtfeld verletzt oder Formatfehler).
invalidNumberValuestringFehlermeldung, die ausgegeben wird, wenn in einem Zahlenfeld kein gültiger numerischer Wert übermittelt wurde.
invalidCheckboxValuestringFehlermeldung, die ausgegeben wird, wenn für eine Checkbox ein ungültiger Wert übermittelt wurde.
requiredCheckboxUncheckedstringFehlermeldung, die ausgegeben wird, wenn eine als erforderlich markierte Checkbox nicht aktiviert wurde.
requiredTextfieldEmptystringFehlermeldung, die ausgegeben wird, wenn ein erforderliches Textfeld 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": "Bitte melden Sie sich an, um eine Hauptadresse festzulegen.",
    "missingAddressId": "Es wurde keine Adresse ausgewählt.",
    "invalidAddressId": "Die ausgewählte Adresse konnte nicht gefunden werden."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
missingAddressIdstringFehlermeldung, die ausgegeben wird, wenn keine Adress-ID übermittelt wurde (keine Adresse ausgewählt).
invalidAddressIdstringFehlermeldung, 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 (z. B. für Mitarbeiter-, Filial- oder Team-Accounts).

Beispielkonfiguration

{
  "errorCodes": {
    "disabled": "Die Anlage von Unterkonten ist derzeit nicht möglich.",
    "notLoggedIn": "Bitte melden Sie sich mit Ihrem Hauptkonto an, um ein Unterkonto anzulegen.",
    "missingEmail": "Bitte geben Sie eine E-Mail-Adresse für das Unterkonto an.",
    "missingPassword": "Bitte vergeben Sie ein Passwort für das Unterkonto.",
    "passwordMismatch": "Die angegebenen Passwörter stimmen nicht überein.",
    "emailCheckFailed": "Die angegebene E-Mail-Adresse ist ungültig.",
    "passwordCheckFailed": "Das Passwort erfüllt nicht die Mindestanforderungen.",
    "accountAlreadyExists": "Unter dieser E-Mail-Adresse besteht bereits ein Konto."
  }
}

Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
disabledstringFehlermeldung, die ausgegeben wird, wenn die Anlage von Unterkonten im Shop grundsätzlich deaktiviert ist.
notLoggedInstringFehlermeldung, die ausgegeben wird, wenn der Benutzer nicht eingeloggt ist.
missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
missingPasswordstringFehlermeldung, die ausgegeben wird, wenn kein Passwort übermittelt wurde.
passwordMismatchstringFehlermeldung, die ausgegeben wird, wenn Passwort und Passwort-Bestätigung nicht übereinstimmen.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
passwordCheckFailedstringFehlermeldung, die ausgegeben wird, wenn das Passwort die Mindestanforderungen nicht erfüllt.
accountAlreadyExistsstringFehlermeldung, die ausgegeben wird, wenn ein Account mit dieser E-Mail-Adresse bereits existiert.