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 während des Bestellvorgangs im Shop ausgeführt werden.
Hier finden sich die zugehörigen Meldungen und E-Mail-Vorlagen, die beim Hinzufügen, Entfernen oder Aktualisieren von Artikeln sowie beim Abschluss einer Bestellung oder bei Gastregistrierungen verwendet werden.
Übersicht der Aktionen
Die hier aufgeführten Aktionen wurden thematisch gruppiert, um die zugehörigen Fehlermeldungen und E-Mail-Vorlagen übersichtlich darzustellen.
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": {
...
"basketItemAdd": {...},
"basketItemDelete": {...},
"basketItemUpdate": {...},
"checkoutAccountTypeSelect": {...},
"checkoutBillAddressSelect": {...},
"checkoutConfirm": {...},
"checkoutPaymentUpdate": {...},
"checkoutPseudoCCSelect": {...},
"checkoutSetFreeFields": {...},
"checkoutSetGuestEmail": {...},
"checkoutShippingAddressSelect": {...},
"checkoutShippingMethodUpdate": {...},
"checkoutUseDifferentShippingAddress": {...},
"guestRegister": {...},
"directOrder": {...},
"voucherAdd": {...},
"voucherDelete": {...},
"inventoryReserve": {...},
...
}
}
Aktionsübersicht
| Aktion | Beschreibung |
|---|
basketItemAdd | Definiert Fehlermeldungen beim Hinzufügen eines Artikels zum Warenkorb. |
basketItemDelete | Definiert Fehlermeldungen beim Entfernen eines Artikels aus dem Warenkorb. |
basketItemUpdate | Definiert Fehlermeldungen beim Ändern einer Warenkorbposition. |
checkoutAccountTypeSelect | Definiert Fehlermeldungen der Auswahl des Konto-Typs im Checkout. |
checkoutBillAddressSelect | Definiert Fehlermeldungen bei der Auswahl der Rechnungsadresse im Checkout. |
checkoutConfirm | Definiert E-Mails und Fehlermeldungen für den Bestellabschluss. |
checkoutPaymentUpdate | Definiert Fehlermeldungen beim Ändern der Zahlungsart im Checkout. |
checkoutPseudoCCSelect | Definiert Fehlermeldungen beim Auswählen einer gespeicherten (Pseudo-)Kreditkarte im Checkout. |
checkoutSetFreeFields | Definiert Fehlermeldungen bei der Prüfung von Freitextfeldern im Checkout. |
checkoutSetGuestEmail | Definiert Fehlermeldungen bei der Eingabe der E-Mail-Adresse für eine Gastbestellung. |
checkoutShippingAddressSelect | Definiert die Fehlermeldungen bei der Auswahl der Lieferadresse im Checkout. |
checkoutShippingMethodUpdate | Definiert Fehlermeldungen beim Ändern der Versandart im Checkout. |
guestRegister | Definiert E-Mails und Fehlermeldungen für das Anlegen eines Kundenkontos nach Gastbestellung. |
directOrder | Definiert Fehlermeldungen für Direktbestellungen. |
voucherAdd | Definiert Fehlermeldungen beim Hinzufügen eines Gutscheins zum Warenkorb. |
voucherDelete | Definiert Fehlermeldungen beim Entfernen eines Gutscheins aus dem Warenkorb. |
inventoryReserve | Definiert Fehlermeldungen beim Reservieren von Lagerbestand für Warenkorbpositionen. |
actions.basketItem* - Warenkorbposition
actions.basketItemAdd - Warenkorbposition hinzufügen
Mithilfe der Aktion basketItemAdd werden die Fehlermeldungen beim Hinzufügen eines Artikels in den Warenkorb gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingProductId": "Es wurde kein Artikel für den Warenkorb ausgewählt.",
"missingQuantity": "Bitte geben Sie eine Bestellmenge ein.",
"invalidQuantity": "Die angegebene Menge ist ungültig.",
"invalidProductId": "Der ausgewählte Artikel konnte nicht gefunden werden.",
"invalidVariantId": "Die gewählte Variante ist ungültig oder nicht verfügbar.",
"insufficientAmount": "Die gewünschte Menge ist nicht auf Lager.",
"quantityExceeded": "Die maximal zulässige Bestellmenge wurde überschritten.",
"childProductOnly": "Dieser Artikel kann nur über eine übergeordnete Produktkonfiguration bestellt werden.",
"expressCheckoutNotAllowed": "Dieser Artikel kann im Express-Checkout nicht in den Warenkorb gelegt werden.",
"noVariantFound": "Für die gewählte Konfiguration wurde keine passende Variante gefunden.",
"invalidStore": "Der gewählte Store/Abholort ist für diesen Artikel nicht verfügbar."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingProductId | string | Fehlermeldung, die ausgegeben wird, wenn keine Produkt-ID übermittelt wurde. |
missingQuantity | string | Fehlermeldung, die ausgegeben wird, wenn keine Bestellmenge angegeben wurde. |
invalidQuantity | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Bestellmenge ungültig ist. |
invalidProductId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Produkt-ID ungültig ist. |
invalidVariantId | string | Fehlermeldung, die ausgegeben wird, wenn die gewählte Variante ungültig oder nicht verfügbar ist. |
insufficientAmount | string | Fehlermeldung, die ausgegeben wird, wenn nicht genügend Bestand für die gewünschte Menge vorhanden ist. |
quantityExceeded | string | Fehlermeldung, die ausgegeben wird, wenn eine definierte maximale Bestellmenge überschritten wird. |
childProductOnly | string | Fehlermeldung, die ausgegeben wird, wenn versucht wird, ein Produkt direkt zu bestellen, das nur als “Child”-Produkt konfigurierbar ist. |
expressCheckoutNotAllowed | string | Fehlermeldung, die ausgegeben wird, wenn der Artikel im Express-Checkout nicht in den Warenkorb gelegt werden darf. |
noVariantFound | string | Fehlermeldung, die ausgegeben wird, wenn zu den gewählten Optionen keine passende Produktvarianten gefunden wird. |
invalidStore | string | Fehlermeldung, die ausgegeben wird, wenn der gewählte Abholort für den Artikel ungültig oder nicht verfügbar ist. |
actions.basketItemDelete - Warenkorbposition löschen
Mithilfe der Aktion basketItemDelete werden die Fehlermeldungen beim Entfernen eines Artikels aus dem Warenkorb gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingBasketItemId": "Es wurde keine Warenkorbposition zum Entfernen ausgewählt.",
"invalidBasketItemId": "Die ausgewählte Warenkorbposition konnte nicht gefunden werden.",
"basketItemIsSetChild": "Diese Position gehört zu einem Produktset und kann nicht einzeln entfernt werden.",
"itemNotRemovable": "Diese Position kann nicht aus dem Warenkorb entfernt werden.",
"internalError": "Beim Entfernen der Position ist ein Fehler aufgetreten. Bitte versuchen Sie es später erneut.",
"invalidChildItem": "Die ausgewählte Unterposition ist ungültig.",
"expressCheckoutNotAllowed": "Im Express-Checkout kann diese Position nicht entfernt werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn keine Warenkorbpositions-ID übermittelt wurde. |
invalidBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Warenkorbposition ungültig ist oder nicht gefunden werden kann. |
basketItemIsSetChild | string | Fehlermeldung, die ausgegeben wird, wenn versucht wird, eine Variante zu entfernen, die nur über das Hauptprodukt entfernt werden darf. |
itemNotRemovable | string | Fehlermeldung, die ausgegeben wird, wenn die betreffende Position grundsätzlich nicht entfernt werden darf. |
internalError | string | Fehlermeldung, die ausgegeben wird, wenn ein unerwarteter Systemfehler auftritt. |
invalidChildItem | string | Fehlermeldung, die ausgegeben wird, wenn eine ungültige Variante referenziert wird. |
expressCheckoutNotAllowed | string | Fehlermeldung, die ausgegeben wird, wenn das Entfernen der Position im Rahmen eines Express-Checkout nicht erlaubt ist. |
actions.basketItemUpdate - Warenkorbposition ändern
Mithilfe der Aktion basketItemUpdate werden die Fehlermeldungen beim Ändern einer Warenkorbposition gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingBasketItemId": "Es wurde keine Warenkorbposition zum Ändern ausgewählt.",
"missingQuantity": "Bitte geben Sie eine neue Bestellmenge ein.",
"invalidBasketItemId": "Die ausgewählte Warenkorbposition konnte nicht gefunden werden.",
"invalidQuantity": "Die angegebene Menge ist ungültig.",
"invalidProductId": "Der zugehörige Artikel konnte nicht gefunden werden.",
"invalidVariantId": "Die gewählte Variante ist ungültig oder nicht verfügbar.",
"insufficientAmount": "Die gewünschte Menge ist nicht auf Lager.",
"quantityExceeded": "Die maximal zulässige Bestellmenge wurde überschritten.",
"childProductOnly": "Diese Position kann nur über die zugehörige Hauptkonfiguration geändert werden.",
"itemNotChangeable": "Diese Position kann nicht geändert werden.",
"internalError": "Beim Aktualisieren der Warenkorbposition ist ein Fehler aufgetreten. Bitte versuchen Sie es später erneut.",
"invalidChildItem": "Die ausgewählte Unterposition ist ungültig.",
"expressCheckoutNotAllowed": "Im Express-Checkout kann diese Position nicht geändert werden.",
"noVariantFound": "Für die gewählte Konfiguration wurde keine passende Variante gefunden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn keine Warenkorbpositions-ID übermittelt wurde. |
missingQuantity | string | Fehlermeldung, die ausgegeben wird, wenn keine Bestellmenge angegeben wurde. |
invalidBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Warenkorbposition ungültig ist oder nicht gefunden werden kann. |
invalidQuantity | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Bestellmenge ungültig ist. |
invalidProductId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Produkt-ID ungültig ist. |
invalidVariantId | string | Fehlermeldung, die ausgegeben wird, wenn die gewählte Variante ungültig oder nicht verfügbar ist. |
insufficientAmount | string | Fehlermeldung, die ausgegeben wird, wenn nicht genügend Bestand für die gewünschte Menge vorhanden ist. |
quantityExceeded | string | Fehlermeldung, die ausgegeben wird, wenn eine definierte maximale Bestellmenge überschritten wird. |
childProductOnly | string | Fehlermeldung, die ausgegeben wird, wenn versucht wird, ein Produkt direkt zu bestellen, das nur als “Child”-Produkt konfigurierbar ist. |
itemNotChangeable | string | Fehlermeldung, die ausgegeben wird, wenn die betreffende Warenkorbposition grundsätzlich nicht geändert werden darf. |
internalError | string | Fehlermeldung, die ausgegeben wird, wenn ein unerwarteter Systemfehler auftritt. |
invalidChildItem | string | Fehlermeldung, die ausgegeben wird, wenn eine ungültige Variante referenziert wird. |
expressCheckoutNotAllowed | string | Fehlermeldung, die ausgegeben wird, wenn der Artikel im Express-Checkout nicht in den Warenkorb gelegt werden darf. |
noVariantFound | string | Fehlermeldung, die ausgegeben wird, wenn zu den gewählten Optionen keine passende Produktvarianten gefunden wird. |
actions.checkout* - Bestellablauf
actions.checkoutAccountTypeSelect - Kontotyp auswählen
Auswahl zwischen Gastbestellung, Bestandskunde und Neukunden zum Starten der Bestellungps im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingAccountType": "Bitte wählen Sie aus, ob Sie als Gast bestellen oder ein Kundenkonto anlegen möchten.",
"invalidAccountType": "Die gewählte Kontoart ist ungültig. Bitte wählen Sie eine verfügbare Option."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingAccountType | string | Fehlermeldung, die ausgegeben wird, wenn kein Kontotyp ausgewählt wurde. |
invalidAccountType | string | Fehlermeldung, die ausgegeben wird, wenn ein ungültiger oder im Shop nicht unterstützter Kontotyp übermittelt wurde. |
actions.checkoutBillAddressSelect - Rechnungsadresse wählen
Mithilfe der Aktion checkoutBillAddressSelect werden die Fehlermeldungen bei der Auswahl der Rechnungsadresse im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingAddressId": "Bitte wählen Sie eine Rechnungsadresse aus.",
"invalidAddressId": "Die ausgewählte Rechnungsadresse konnte nicht gefunden werden.",
"invalidBillAddress": "Die ausgewählte Adresse kann nicht als Rechnungsadresse verwendet werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingAddressId | string | Fehlermeldung, die ausgegeben wird, wenn keine Adress-ID übermittelt wurde. |
invalidAddressId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Adress-ID ungültig ist oder die Adresse nicht gefunden werden konnte. |
invalidBillAddress | string | Fehlermeldung, die ausgegeben wird, wenn die Adresse nicht als Rechnungsadresse verwendet werden darf. |
actions.checkoutConfirm - Bestellung abschließen
Mithilfe der Aktion checkoutConfirm werden Fehlermeldungen und E-Mails für den Bestellabschluss gesteuert.
Beispielkonfiguration
{
"customerEmail": {
"template": "order_confirmation_customer.htm",
"subject": "Ihre Bestellung bei Mein Onlineshop",
"fromAddress": "noreply@meinshop.de",
"fromName": "Mein Onlineshop",
"merchantEmail": "bestellungen@meinshop.de",
"attachments": [
{
"name": "AGB.pdf",
"file": "/files/agb.pdf"
}
]
},
"paymentFailedEmail": {
"template": "order_payment_failed.htm",
"subject": "Zahlung Ihrer Bestellung fehlgeschlagen",
"fromAddress": "noreply@meinshop.de",
"fromName": "Mein Onlineshop",
"merchantEmail": "zahlung@meinshop.de"
},
"errorCodes": {
"invalid": "Ihre Bestellung konnte nicht bestätigt werden.",
"requiredCheckboxUnchecked": "Bitte stimmen Sie allen erforderlichen Bedingungen zu.",
"requiredTextfieldEmpty": "Bitte füllen Sie alle erforderlichen Eingabefelder aus.",
"voucherGenerateError": "Der Gutschein konnte nicht erstellt werden.",
"clearingFailed": "Die Zahlungsfreigabe war nicht erfolgreich.",
"invalidVoucherId": "Der eingegebene Gutscheincode ist ungültig.",
"voucherDeactivated": "Dieser Gutschein ist deaktiviert.",
"voucherExpired": "Dieser Gutschein ist abgelaufen.",
"voucherNotYetValid": "Dieser Gutschein ist noch nicht gültig.",
"voucherValueSpent": "Der Gutschein wurde bereits vollständig eingelöst.",
"voucherInsuffientAmount": "Der Gutscheinbetrag reicht für diese Bestellung nicht aus.",
"voucherCurrencyMismatch": "Der Gutschein ist für eine andere Währung gültig.",
"voucherInvalidCustomer": "Dieser Gutschein kann von diesem Kundenkonto nicht eingelöst werden.",
"voucherInvalidSubshop": "Dieser Gutschein ist in diesem Shop nicht gültig.",
"checkoutCompletedError": "Die Bestellung wurde bereits abgeschlossen.",
"itemsExpired": "Ein oder mehrere Artikel im Warenkorb sind nicht mehr verfügbar.",
"expiredReservation": "Die Reservierung für einen oder mehrere Artikel ist abgelaufen.",
"guestAccountsDisabled": "Gastbestellungen sind derzeit nicht möglich. Bitte legen Sie ein Kundenkonto an."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
customerEmail | object | Konfiguriert die Bestellbestätigungs-Email an den Kunden (inkl. optionaler Kopie an den Händler und Anhängen). Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mail Einstellungen |
paymentFailedEmail | object | Konfiguriert die E-Mail, die bei fehlgeschlagener Zahlung versendet werden kann. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mail Einstellungen |
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
invalid | string | Fehlermeldung, die ausgegeben wird, wenn die Bestellung nicht bestätigt werden kann. |
requiredCheckboxUnchecked | string | Fehlermeldung, die ausgegeben wird, wenn eine erforderliche Checkbox nicht aktiviert wurde. |
requiredTextfieldEmpty | string | Fehlermeldung, die ausgegeben wird, wenn ein als Pflichtfeld markiertes Eingabefeld leer ist. |
voucherGenerateError | string | Fehlermeldung, die ausgegeben wird, wenn beim Erzeugen eines Gutscheins ein Fehler auftritt. |
clearingFailed | string | Fehlermeldung, die ausgegeben wird, wenn die Zahlungsfreigabe durch den Zahlungsdienstleister fehlschlägt. |
invalidVoucherId | string | Fehlermeldung, die ausgegeben wird, wenn der eingegebene Gutschein-Code nicht existiert oder nicht erkannt wird. |
voucherDeactivated | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein deaktiviert ist und nicht mehr eingelöst werden kann. |
voucherExpired | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein abgelaufen ist. |
voucherNotYetValid | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein erst ab einem späteren Zeitpunkt gültig ist. |
voucherValueSpent | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein bereits vollständig verbraucht wurde. |
voucherInsuffientAmount | string | Fehlermeldung, die ausgegeben wird, wenn der Gutscheinbetrag für diese Bestellung nicht ausreicht. |
voucherCurrencyMismatch | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein für eine andere Währung ausgestellt wurde, als im aktuellen Warenkorb verwendet wird. |
voucherInvalidCustomer | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein an einen andere Kunden gebunden ist. |
voucherInvalidSubshop | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein im aktuellen Subshop nicht gültig ist. |
checkoutCompletedError | string | Fehlermeldung, die ausgegeben wird, wenn der Checkout bereits abgeschlossen wurde und nicht erneut ausgeführt werden kann. |
itemsExpired | string | Fehlermeldung, die ausgegeben wird, wenn der Artikel im Warenkorb inzwischen nicht mehr verfügbar ist. |
expiredReservation | string | Fehlermeldung, die ausgegeben wird, wenn eine zuvor angelegte Warenkorbreservierung abgelaufen ist. |
guestAccountsDisabled | string | Fehlermeldung, die ausgegeben wird, wenn Gastbestellungen deaktiviert sind und ein Kunde ohne Konto bestellen möchte. |
actions.checkoutPaymentUpdate - Zahlungsart ändern
Mithilfe der Aktion checkoutPaymentUpdate werden die Fehlermeldungen beim Ändern der Zahlungsart im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingPaymentId": "Bitte wählen Sie eine Zahlungsart aus.",
"inactivePayment": "Die ausgewählte Zahlungsart ist derzeit nicht verfügbar.",
"invalidPaymentId": "Die ausgewählte Zahlungsart konnte nicht gefunden werden.",
"expressCheckoutNotAllowed": "Im Express-Checkout kann die Zahlungsart nicht geändert werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingPaymentId | string | Fehlermeldung, die ausgegeben wird, wenn keine Zahlungsart ausgewählt wurde. |
inactivePayment | string | Fehlermeldung, die ausgegeben wird, wenn die ausgewählte Zahlungsart im Shop deaktiviert ist. |
invalidPaymentId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Zahlungs-ID ungültig ist oder die Zahlungsart nicht gefunden wurde. |
expressCheckoutNotAllowed | string | Fehlermeldung, die ausgegeben wird, wenn die Änderung der Zahlungsart im Express-Checkout nicht zulässig ist. |
actions.checkoutPseudoCCSelect - Kreditkarte wählen
Mithilfe der Aktion checkoutPseudoCCSelect werden die Fehlermeldungen beim Auswählen einer gespeicherten Kreditkarte im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"notLoggedIn": "Bitte melden Sie sich an, um eine gespeicherte Kreditkarte zu verwenden.",
"missingPseudoId": "Es wurde keine gespeicherte Kreditkarte ausgewählt.",
"notAllowed": "Die ausgewählte Kreditkarte kann für diese Bestellung nicht verwendet werden."
}
}
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 ein nicht angemeldeter Benutzer versucht, eine gespeicherte Kreditkarte zu verwenden. |
missingPseudoId | string | Fehlermeldung, die ausgegeben wird, wenn keine Karten-Referenz (Pseudo-ID) übermittelt wurde. |
notAllowed | string | Fehlermeldung, die ausgegeben wird, wenn die ausgewählte Kreditkarte im aktuellen Kontext nicht verwendet werden darf. |
actions.checkoutSetFreeFields - Freitextfelder im Checkout
Mithilfe der Aktion checkoutSetFreeFields werden die Fehlermeldungen für die Prüfung von Freitextfeldern im Checkout gesteuert.
Beispielkonfiguration actions.checkoutSetFreeFields
{
"errorCodes": {
"textfieldCheckFailed": "Mindestens ein Eingabefeld im Bestellvorgang wurde nicht korrekt ausgefüllt."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
textfieldCheckFailed | string | Fehlermeldung, die ausgegeben wird, wenn die Validierung eines oder mehrerer Freitextfelder fehlschlägt. (z.B. Pflichtfeld leer) |
actions.checkoutSetGuestEmail - Gastbestellung
Mithilfe der Aktion checkoutSetGuestEmail werden die Fehlermeldungen bei der Eingabe der E-Mail-Adresse für eine Gastbestellung gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingGuestEmail": "Bitte geben Sie Ihre E-Mail-Adresse ein.",
"invalidGuestEmail": "Die angegebene E-Mail-Adresse ist ungültig.",
"guestEmailAlreadyUsed": "Unter dieser E-Mail-Adresse besteht bereits ein Kundenkonto. Bitte melden Sie sich an oder verwenden Sie eine andere Adresse."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingGuestEmail | string | Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse eingegeben wurde. |
invalidGuestEmail | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse das erwartete Format nicht erfüllt. |
guestEmailAlreadyUsed | string | Fehlermeldung, die ausgegeben wird, wenn die E-Mail-Adresse bereits einem registrierten Kundenkonto zugeordnet ist. |
actions.checkoutShippingAddressSelect - Lieferadresse wählen
Mithilfe der Aktion checkoutShippingAddressSelect werden die Fehlermeldungen bei der Auswahl der Lieferadresse im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingAddressId": "Bitte wählen Sie eine Lieferadresse aus.",
"invalidAddressId": "Die ausgewählte Lieferadresse konnte nicht gefunden werden.",
"expressCheckoutNotAllowed": "Im Express-Checkout kann die Lieferadresse nicht geändert werden.",
"invalidShippingAddress": "Die ausgewählte Adresse kann nicht als Lieferadresse verwendet werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingAddressId | string | Fehlermeldung, die ausgegeben wird, wenn keine Adress-ID übermittelt wurde. |
invalidAddressId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Adress-ID ungültig ist oder die Adresse nicht gefunden werden kann. |
expressCheckoutNotAllowed | string | Fehlermeldung, die ausgegeben wird, wenn die Auswahl/Änderung der Lieferadresse im Express-Checkout nicht zulässig ist. |
invalidShippingAddress | string | Fehlermeldung, die ausgegeben wird, wenn die gewählte Adresse nicht als LIeferadresse verwendet werden darf. |
actions.checkoutShippingMethodUpdate - Versandart wählen / ändern
Mithilfe der Aktion checkoutShippingMethodUpdate werden die Fehlermeldungen beim Ändern der Versandart im Checkout gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingShippingMethodId": "Bitte wählen Sie eine Versandart aus.",
"inactiveShippingMethodId": "Die ausgewählte Versandart ist derzeit nicht verfügbar.",
"invalidShippingMethodId": "Die ausgewählte Versandart konnte nicht gefunden werden.",
"reservationFailed": "Für die gewählte Versandart konnte keine Reservierung vorgenommen werden. Bitte wählen Sie eine andere Versandart."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingShippingMethodId | string | Fehlermeldung, die ausgegeben wird, wenn keine Versandart ausgewählt bzw. keine Versandart-ID übermittelt wurde. |
inactiveShippingMethodId | string | Fehlermeldung, die ausgegeben wird, wenn die ausgewählte Versandart im Shop deaktiviert oder vorübergehend nicht verfügbar ist. |
invalidShippingMethodId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Versandart-ID ungültig ist oder die Versandart nicht gefunden werden kann. |
reservationFailed | string | Fehlermeldung, die ausgegeben wird, wenn eine notwendige Reservierung für die Versandart fehlschlägt. |
actions.guestRegister - Anmeldung nach Gastbestellung
Mithilfe der Aktion guestRegister werden die Fehlermeldungen und E-Mails beim Anlegen eines vollwertigen Kundenkontos aus einer Gastbestellung gesteuert.
Beispielkonfiguration
{
"verifyEmail": {
"template": "guest_register_verify.htm",
"subject": "Bitte bestätigen Sie Ihre Registrierung",
"fromAddress": "noreply@meinshop.de",
"fromName": "Mein Onlineshop"
},
"errorCodes": {
"nonGuestAccount": "Für diese Daten besteht bereits ein reguläres Kundenkonto.",
"duplicateEmail": "Unter dieser E-Mail-Adresse ist bereits ein Kundenkonto registriert.",
"missingEmail": "Bitte geben Sie eine E-Mail-Adresse an.",
"missingPassword": "Bitte vergeben Sie ein Passwort für Ihr Kundenkonto.",
"passwordMismatch": "Die eingegebenen Passwörter stimmen nicht überein.",
"passwordCheckFailed": "Das Passwort erfüllt nicht die Sicherheitsanforderungen.",
"createError": "Ihr Kundenkonto konnte nicht angelegt werden. Bitte versuchen Sie es später erneut."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
verifyEmail | object | Konfiguriert die E-Mail, mit der der ehemalige Gastkunde seine Registrierung bzw. E-Mail-Adresse bestätigen kann. Betreff, Absender und Template werden über die allgemeinen E-Mail-Parameter gesteuert, siehe hier: E-Mail Einstellungen |
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
nonGuestAccount | string | Fehlermeldung, die ausgegeben wird, wenn versucht wird, ein Konto zu registrieren, das kein Gastkonto ist. |
duplicateEmail | string | Fehlermeldung, die ausgegeben wird, wenn unter der angegebenen E-Mail-Adresse bereits ein Kundenkonto existiert. |
missingEmail | string | Fehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wird. |
missingPassword | string | Fehlermeldung, die ausgegeben wird, wenn kein Passwort für das neue Kundenkonto angegeben wurde. |
passwordMismatch | string | Fehlermeldung, die ausgegeben wird, wenn Passwort und Passwortbestätigung nicht übereinstimmen. |
passwordCheckFailed | string | Fehlermeldung, die ausgegeben wird, wenn das gewählte Passwort die Passwortregeln nicht erfüllt. |
createError | string | Fehlermeldung, die ausgegeben wird, wenn das Kundenkonto technisch nicht angelegt werden konnte. |
actions.directOrder - Direktbestellung
Mithilfe der Aktion directOrder werden die Fehlermeldungen für Direktbestellungen per Artikelnummer gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"invalidId": "Die eingegebene Artikelnummer ist ungültig.",
"missingId": "Bitte geben Sie eine Artikelnummer ein.",
"invalidQuantity": "Die angegebene Menge ist ungültig.",
"missingQuantity": "Bitte geben Sie eine Bestellmenge ein.",
"productHasNoVariants": "Für diesen Artikel können keine Varianten ausgewählt werden.",
"variantDoesNotExist": "Die gewählte Variante existiert nicht.",
"baseProductCanNotBeChosen": "Bitte wählen Sie eine konkrete Variante dieses Artikels."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
invalidId | string | Fehlermeldung, die ausgegeben wird, wenn die eingegebene Artikel-/Bestellnummer ungültig ist oder kein passender Artikel gefunden wird. |
missingId | string | Fehlermeldung, die ausgegeben wird, wenn keine Artikel-/Bestellnummer eingegeben wurde. |
invalidQuantity | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Menge ungültig ist. |
missingQuantity | string | Fehlermeldung, die ausgegeben wird, wenn keine Bestellmenge angegeben wurde. |
productHasNoVariants | string | Fehlermeldung, die ausgegeben wird, wenn für den gewählten Artikel keine Varianten vorhanden sind, aber eine Variante erwartet wurde. |
variantDoesNotExist | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Variante nicht existiert. |
baseProductCanNotBeChosen | string | Fehlermeldung, die ausgegeben wird, wenn das Basisprodukt nicht direkt gewählt werden kann und stattdessen eine Variante ausgewählt werden muss. |
actions.voucher* - Gutschein
actions.voucherAdd - Gutschein einlösen / hinzufügen
Mithilfe der Aktion voucherAdd werden die Fehlermeldungen beim Hinzufügen eines Gutscheins zum Warenkorb gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingId": "Bitte geben Sie einen Gutscheincode ein.",
"duplicateId": "Dieser Gutschein wurde bereits hinzugefügt.",
"invalidVoucherId": "Der eingegebene Gutscheincode ist ungültig.",
"deactivated": "Dieser Gutschein ist deaktiviert.",
"expired": "Dieser Gutschein ist abgelaufen.",
"notYetValid": "Dieser Gutschein ist noch nicht gültig.",
"maxCountExceeded": "Der Gutschein wurde bereits zu oft verwendet.",
"valueSpent": "Der Gutschein wurde bereits vollständig eingelöst.",
"insuffientAmount": "Der Gutscheinbetrag reicht für diese Bestellung nicht aus.",
"currencyMismatch": "Der Gutschein ist nur in einer anderen Währung gültig.",
"invalidCustomer": "Dieser Gutschein kann von diesem Kundenkonto nicht eingelöst werden.",
"invalidSubshop": "Dieser Gutschein ist in diesem Shop nicht gültig."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingId | string | Fehlermeldung, die ausgegeben wird, wenn kein Gutscheincode eingegeben wurde. |
duplicateId | string | Fehlermeldung, die ausgegeben wird, wenn derselbe Gutscheincode bereits im Warenkorb hinterlegt ist. |
invalidVoucherId | string | Fehlermeldung, die ausgegeben wird, wenn der Gutscheincode ungültig ist oder kein Gutschein gefunden werden kann. |
deactivated | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein im System deaktiviert wurde. |
expired | string | Fehlermeldung, die ausgegeben wird, wenn die Gültigkeitsdauer des Gutscheins abgelaufen ist. |
notYetValid | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein erst ab einem späteren Zeitpunkt gültig ist. |
maxCountExceeded | string | Fehlermeldung, die ausgegeben wird, wenn die maximale Anzahl an zulässigen Einlösungen überschritten wurde. |
valueSpent | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein bereits vollständig eingelöst wurde und kein Restwert mehr vorhanden ist. |
insuffientAmount | string | Fehlermeldung, die ausgegeben wird, wenn der Gutscheinwert für die aktuelle Bestellung nicht ausreicht. |
currencyMismatch | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein für eine andere Währung ausgestellt wurde als im aktuellen Warenkorb verwendet wird. |
invalidCustomer | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein an einen anderen Kunden gebunden ist als den aktuell eingeloggten. |
invalidSubshop | string | Fehlermeldung, die ausgegeben wird, wenn der Gutschein im aktuellen Subshop/Shop nicht eingelöst werden darf. |
actions.voucherDelete - Gutschein löschen
Mithilfe der Aktion voucherDelete werden die Fehlermeldungen beim Entfernen eines Gutscheins aus dem Warenkorb gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"invalidVoucherId": "Der angegebene Gutschein konnte nicht im Warenkorb gefunden werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
invalidVoucherId | string | Fehlermeldung, die ausgegeben wird, wenn der angegebene Gutschein im Warenkorb nicht gefunden oder nicht zugeordnet werden kann. |
actions.inventoryReserve - Reservierung im Warenkorb
Mithilfe der Aktion inventoryReserve werden die Fehlermeldungen beim Reservieren von Lagerbestand für Warenkorbpositionen gesteuert.
Beispielkonfiguration
{
"errorCodes": {
"missingBasketItemId": "Es wurde keine Warenkorbposition für die Reservierung ausgewählt.",
"invalidBasketItemId": "Die ausgewählte Warenkorbposition konnte nicht gefunden werden.",
"noReservationFound": "Es konnte keine passende Reservierung gefunden oder angelegt werden.",
"insufficientAmount": "Für diese Position ist nicht genügend Bestand verfügbar.",
"inventoryInactive": "Die Bestandsverwaltung ist derzeit deaktiviert. Es können keine Reservierungen vorgenommen werden.",
"setChildReserveActionInvalid": "Für Set-/Kind-Positionen kann in dieser Form keine Reservierung vorgenommen werden."
}
}
Parameterübersicht
| Parameter | Typ | Beschreibung |
|---|
errorCodes | object | Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden. |
missingBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn keine Warenkorbpositions-ID übermittelt wurde. |
invalidBasketItemId | string | Fehlermeldung, die ausgegeben wird, wenn die angegebene Warenkorbposition ungültig ist oder nicht gefunden werden kann. |
noReservationFound | string | Fehlermeldung, die ausgegeben wird, wenn keine passende Reservierung gefunden oder erzeugt werden kann. |
insufficientAmount | string | Fehlermeldung, die ausgegeben wird, wenn für die gewünschte Menge nicht genügend Bestand verfügbar ist. |
inventoryInactive | string | Fehlermeldung, die ausgegeben wird, wenn die Bestandsverwaltung bzw. Reservierungsfunktion im System deaktiviert ist. |
setChildReserveActionInvalid | string | Fehlermeldung, die ausgegeben wird, wenn für eine Set-/Kind-Position keine Reservierung in der angefragten Form zulässig ist. |