actions - Warenkorb & Checkout - WEBSALE Dokumentation

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": {
    "accountNotVerified": "<Textbaustein>",
    "missingProductId": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "invalidProductId": "<Textbaustein>",
    "invalidVariantId": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "quantityExceeded": "<Textbaustein>",
    "childProductOnly": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "noVariantFound": "<Textbaustein>",
    "invalidStore": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`accountNotVerified`	string	Fehlermeldung, die ausgegeben wird, wenn das Kundenkonto noch nicht verifiziert wurde.
`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": {
    "accountNotVerified": "<Textbaustein>",
    "missingBasketItemId": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "basketItemIsSetChild": "<Textbaustein>",
    "itemNotRemovable": "<Textbaustein>",
    "internalError": "<Textbaustein>",
    "invalidChildItem": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`accountNotVerified`	string	Fehlermeldung, die ausgegeben wird, wenn das Kundenkonto noch nicht verifiziert wurde.
`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": {
    "accountNotVerified": "<Textbaustein>",
    "missingBasketItemId": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "invalidProductId": "<Textbaustein>",
    "invalidVariantId": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "quantityExceeded": "<Textbaustein>",
    "childProductOnly": "<Textbaustein>",
    "itemNotChangeable": "<Textbaustein>",
    "internalError": "<Textbaustein>",
    "invalidChildItem": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "noVariantFound": "<Textbaustein>"
  }
}

Parameterübersicht

Parameter	Typ	Beschreibung
`errorCodes`	object	Konfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
`accountNotVerified`	string	Fehlermeldung, die ausgegeben wird, wenn das Kundenkonto noch nicht verifiziert wurde.
`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 Bestellung im Checkout gesteuert.

Beispielkonfiguration

{
  "errorCodes": {
    "missingAccountType": "<Textbaustein>",
    "invalidAccountType": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>",
    "invalidBillAddress": "<Textbaustein>"
  }
}

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": {
    "accountNotVerified": "<Textbaustein>",
    "invalid": "<Textbaustein>",
    "requiredCheckboxUnchecked": "<Textbaustein>",
    "requiredTextfieldEmpty": "<Textbaustein>",
    "voucherGenerateError": "<Textbaustein>",
    "clearingFailed": "<Textbaustein>",
    "invalidVoucherId": "<Textbaustein>",
    "voucherDeactivated": "<Textbaustein>",
    "voucherExpired": "<Textbaustein>",
    "voucherNotYetValid": "<Textbaustein>",
    "voucherValueSpent": "<Textbaustein>",
    "voucherInsuffientAmount": "<Textbaustein>",
    "voucherCurrencyMismatch": "<Textbaustein>",
    "voucherInvalidCustomer": "<Textbaustein>",
    "voucherInvalidSubshop": "<Textbaustein>",
    "checkoutCompletedError": "<Textbaustein>",
    "itemsExpired": "<Textbaustein>",
    "expiredReservation": "<Textbaustein>",
    "guestAccountsDisabled": "<Textbaustein>"
  }
}

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
`customerEmail.attachments`	array (object)	Liste von Dateianhängen, die der Bestellbestätigungs-E-Mail beigefügt werden (z.B. AGB als PDF). Je Anhang sind `name` (angezeigter Dateiname) und `file` (Pfad zur Datei im Shop) anzugeben. Siehe auch 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.
`accountNotVerified`	string	Fehlermeldung, die ausgegeben wird, wenn das Kundenkonto noch nicht verifiziert wurde.
`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": "<Textbaustein>",
    "inactivePayment": "<Textbaustein>",
    "invalidPaymentId": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "missingPseudoId": "<Textbaustein>",
    "notAllowed": "<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 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": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "invalidGuestEmail": "<Textbaustein>",
    "guestEmailAlreadyUsed": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "invalidAddressId": "<Textbaustein>",
    "expressCheckoutNotAllowed": "<Textbaustein>",
    "invalidShippingAddress": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "inactiveShippingMethodId": "<Textbaustein>",
    "invalidShippingMethodId": "<Textbaustein>",
    "reservationFailed": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "duplicateEmail": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "createError": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "missingId": "<Textbaustein>",
    "invalidQuantity": "<Textbaustein>",
    "missingQuantity": "<Textbaustein>",
    "productHasNoVariants": "<Textbaustein>",
    "variantDoesNotExist": "<Textbaustein>",
    "baseProductCanNotBeChosen": "<Textbaustein>"
  }
}

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": "<Textbaustein>",
    "duplicateId": "<Textbaustein>",
    "invalidVoucherId": "<Textbaustein>",
    "deactivated": "<Textbaustein>",
    "expired": "<Textbaustein>",
    "notYetValid": "<Textbaustein>",
    "maxCountExceeded": "<Textbaustein>",
    "valueSpent": "<Textbaustein>",
    "insuffientAmount": "<Textbaustein>",
    "currencyMismatch": "<Textbaustein>",
    "invalidCustomer": "<Textbaustein>",
    "invalidSubshop": "<Textbaustein>"
  }
}

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

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": "<Textbaustein>",
    "invalidBasketItemId": "<Textbaustein>",
    "noReservationFound": "<Textbaustein>",
    "insufficientAmount": "<Textbaustein>",
    "inventoryInactive": "<Textbaustein>",
    "setChildReserveActionInvalid": "<Textbaustein>"
  }
}

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.

actions - Testmodus accounts - Benutzerkonten

⌘I

​Übersicht der Aktionen

​Auszug der Grundstruktur actions

​Aktionsübersicht

​actions.basketItem* - Warenkorbposition

​actions.basketItemAdd - Warenkorbposition hinzufügen

​Beispielkonfiguration

​Parameterübersicht

​actions.basketItemDelete - Warenkorbposition löschen

​Beispielkonfiguration

​Parameterübersicht

​actions.basketItemUpdate - Warenkorbposition ändern

​Beispielkonfiguration

​Parameterübersicht

​actions.checkout* - Bestellablauf

​actions.checkoutAccountTypeSelect - Kontotyp auswählen

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutBillAddressSelect - Rechnungsadresse wählen

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutConfirm - Bestellung abschließen

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutPaymentUpdate - Zahlungsart ändern

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutPseudoCCSelect - Kreditkarte wählen

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutSetFreeFields - Freitextfelder im Checkout

​Beispielkonfiguration actions.checkoutSetFreeFields

​Parameterübersicht

​actions.checkoutSetGuestEmail - Gastbestellung

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutShippingAddressSelect - Lieferadresse wählen

​Beispielkonfiguration

​Parameterübersicht

​actions.checkoutShippingMethodUpdate - Versandart wählen / ändern

​Beispielkonfiguration

​Parameterübersicht

​actions.guestRegister - Anmeldung nach Gastbestellung

​Beispielkonfiguration

​Parameterübersicht

​actions.directOrder - Direktbestellung

​Beispielkonfiguration

​Parameterübersicht

​actions.voucher* - Gutschein

​actions.voucherAdd - Gutschein einlösen / hinzufügen

​Beispielkonfiguration

​Parameterübersicht

​actions.voucherDelete - Gutschein löschen

​Beispielkonfiguration

​Parameterübersicht

​actions.inventoryReserve - Reservierung im Warenkorb

​Beispielkonfiguration

​Parameterübersicht

Übersicht der Aktionen

Auszug der Grundstruktur `actions`

Aktionsübersicht

`actions.basketItem*` - Warenkorbposition

`actions.basketItemAdd` - Warenkorbposition hinzufügen

Beispielkonfiguration

Parameterübersicht

`actions.basketItemDelete` - Warenkorbposition löschen

Beispielkonfiguration

Parameterübersicht

`actions.basketItemUpdate` - Warenkorbposition ändern

Beispielkonfiguration

Parameterübersicht

`actions.checkout*` - Bestellablauf

`actions.checkoutAccountTypeSelect` - Kontotyp auswählen

Beispielkonfiguration

Parameterübersicht

`actions.checkoutBillAddressSelect` - Rechnungsadresse wählen

Beispielkonfiguration

Parameterübersicht

`actions.checkoutConfirm` - Bestellung abschließen

Beispielkonfiguration

Parameterübersicht

`actions.checkoutPaymentUpdate` - Zahlungsart ändern

Beispielkonfiguration

Parameterübersicht

`actions.checkoutPseudoCCSelect` - Kreditkarte wählen

Beispielkonfiguration

Parameterübersicht

`actions.checkoutSetFreeFields` - Freitextfelder im Checkout

Beispielkonfiguration `actions.checkoutSetFreeFields`

Parameterübersicht

`actions.checkoutSetGuestEmail` - Gastbestellung

Beispielkonfiguration

Parameterübersicht

`actions.checkoutShippingAddressSelect` - Lieferadresse wählen

Beispielkonfiguration

Parameterübersicht

`actions.checkoutShippingMethodUpdate` - Versandart wählen / ändern

Beispielkonfiguration

Parameterübersicht

`actions.guestRegister` - Anmeldung nach Gastbestellung

Beispielkonfiguration

Parameterübersicht

`actions.directOrder` - Direktbestellung

Beispielkonfiguration

Parameterübersicht

`actions.voucher*` - Gutschein

`actions.voucherAdd` - Gutschein einlösen / hinzufügen

Beispielkonfiguration

Parameterübersicht

`actions.voucherDelete` - Gutschein löschen

Beispielkonfiguration

Parameterübersicht

`actions.inventoryReserve` - Reservierung im Warenkorb

Beispielkonfiguration

Parameterübersicht