Aktionen im Überblick
Aktionen
CheckoutBillAddressSelect
Mit dieser Aktion wählt der Kunde eine seiner bereits gespeicherten Adressen als Rechnungsadresse für den aktuellen Bestellvorgang aus. Die Auswahl wird sofort übernommen, es ist keine weitere Bestätigung nötig. AnwendungsbeispielNutzbar, um z.B. eingeloggten Kunden im Checkout ein Dropdown mit ihren gespeicherten Adressen anzuzeigen, sodass sie eine Rechnungsadresse mit einem Klick auswählen können, ohne erneute Eingabe. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie eingeloggten Kunden ein Dropdown mit ihren gespeicherten Adressen angezeigt wird, über das sie eine Rechnungsadresse auswählen können.
CheckoutShippingAddressSelect
Mit dieser Aktion wählt der Kunde eine seiner bereits gespeicherten Adressen als Lieferadresse für den aktuellen Bestellvorgang aus. Die Aktion ist nur relevant, wenn der Kunde eine abweichende Lieferadresse angeben möchte. AnwendungsbeispielNutzbar, wenn ein Kunde eine Bestellung an eine andere Adresse schicken möchte. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie eingeloggten Kunden ein Dropdown mit ihren gespeicherten Adressen angezeigt wird, über das sie eine Lieferadresse auswählen können.
CheckoutSetDraftAddress
Mit dieser Aktion wird eine vom Kunden eingegebene Adresse vorläufig gespeichert, ohne dass die Eingaben sofort auf Vollständigkeit oder Korrektheit geprüft werden. Die Draft-Adresse wirkt sich dabei bereits auf die verfügbaren Versand- und Zahlungsarten aus, die auf Basis der Eingaben angepasst werden (relevant für den OnePage-Checkout). Die Adresse gilt zunächst als Entwurf und wird erst durch CheckoutCommitDraftAddress als verbindliche Checkout-Adresse übernommen. Der Adresstyp wird direkt im Aktionsnamen angegeben (bill oder shipping).
AnwendungsbeispielNutzbar im OnePage-Checkout, um die eingegebene Adresse laufend zwischenzuspeichern, ohne den Kunden sofort mit Validierungsfehlern zu konfrontieren. Die eigentliche Prüfung der Adresse erfolgt erst beim Klick auf “Jetzt kaufen” über CheckoutCommitDraftAddress. Parameter
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie eine Rechnungsadresse als Entwurf zwischengespeichert wird, ohne sie sofort zu validieren.
CheckoutCommitDraftAddress
Mit dieser Aktion wird ein zuvor per CheckoutSetDraftAddress gespeicherter Adressentwurf validiert und als Checkout-Adresse übernommen. Das Verhalten unterscheidet sich je nach Bestelltyp:- Gastbestellung - die eingegebene Adresse wird geprüft und, sofern gültig, direkt für den Checkout übernommen.
- Bestellung mit Kundenkonto - die eingegebene Adresse wird geprüft und, sofern gültig, als neue Adresse im Kundenkonto angelegt und gleichzeitig für den aktuellen Checkout ausgewählt.
bill oder shipping).
Diese Aktion bildet zusammen mit CheckoutSetDraftAddress den typischen Adress-Workflow im OnePage-Checkout:CheckoutSetDraftAddress speichert die Eingaben laufend zwischen (ohne Validierung),
CheckoutCommitDraftAddress schließt den Prozess ab.
AnwendungsbeispielNutzbar als abschließender Schritt im OnePage-Checkout. Der Kunde hat seine Adresse bereits eingegeben und erst beim Klick auf “Jetzt kaufen” wird geprüft, ob alle Angaben korrekt und vollständig sind. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie ein Rechnungsadress-Entwurf validiert und als verbindliche Checkout-Adresse übernommen wird. Bei fehlerhaften Eingaben bleibt der Entwurf erhalten und Fehler werden ausgegeben.
CheckoutUseSameShippingAddress
Mit dieser Aktion wird festgelegt, dass die Lieferung an dieselbe Adresse wie die Rechnungsadresse erfolgen soll. Eine zuvor eingegebene oder ausgewählte abweichende Lieferadresse wird dadurch nicht gelöscht, aber für den Checkout nicht mehr berücksichtigt. AnwendungsbeispielNutzbar, um dem Kunden z.B. per Checkbox die Möglichkeit zu geben, Rechnungs- und Lieferadresse mit einem Klick gleichzusetzen, ohne erneute Eingabe. Zugehörige Module, Variablen & Methoden Beispiel das zeigt, wie die Aktion über ein verstecktes Formular ausgelöst wird, das per JavaScript an eine Checkbox gekoppelt werden kann.
CheckoutUseDifferentShippingAddress
Mit dieser Aktion wird eine abweichende Lieferadresse für den Checkout aktiviert. Sobald sie ausgelöst wurde, wird der Bereich zur Auswahl oder Eingabe einer separaten Lieferadresse relevant. Die Aktion kehrt den Effekt von CheckoutUseSameShippingAddress um. AnwendungsbeispielNutzbar, wenn der Kunde eine Bestellung an eine andere Adresse liefern lassen möchte, z.B. direkt in an eine Filiale. Zugehörige Module, Variablen & Methoden Beispiel das zeigt, wie die Aktion über ein verstecktes Formular ausgelöst wird, das per JavaScript an eine Checkbox gekoppelt werden kann.
CheckoutAccountTypeSelect
Mit dieser Aktion wird der Kontotyp für den aktuellen Bestellvorgang festgelegt. Der gewählte Typ bestimmt, welche Schritte im Checkout-Prozess angezeigt werden. AnwendungsbeispielNutzbar auf der Login-Seite im Checkout-Kontext, um dem Kunden die Möglichkeit zu geben, als Gast zu bestellen, ohne ein Konto anlegen zu müssen. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie der Kontotyp auf “
guest” gesetzt wird, um eine Gastbestellung zu ermöglichen.
CheckoutSetGuestEmail
Mit dieser Aktion wird die E-Mail-Adresse für eine Gastbestellung gesetzt. Sie ist nur relevant, wenn der Kontotyp auf “guest” gesetzt wurde.
AnwendungsbeispielNutzbar im Checkout, wenn ein Kunde als Gast bestellen möchte und dafür seine E-Mail-Adresse angeben muss. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie ein Gastkunde seine E-Mail-Adresse im Checkout eingibt, inklusive Fehlerausgabe bei ungültiger Eingabe.
CheckoutShippingMethodUpdate
Mit dieser Aktion wird die Versandart für den aktuellen Bestellvorgang gesetzt. AnwendungsbeispielNutzbar im Checkout, um dem Kunden eine Liste der verfügbaren Versandarten anzuzeigen, aus der er eine auswählen kann. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
- $wsCheckout
- $wsCheckout.selectedShippingMethod
- $wsCheckout.isValidShippingMethod()
- $wsCheckout.problems.shippingMethod
CheckoutConfirm
Mit dieser Aktion wird die Bestellung verbindlich abgeschickt. Sie ist der abschließende Schritt im Checkout-Prozess und setzt voraus, dass alle erforderlichen Angaben - Adresse, Zahlungsart und Versandart - vollständig und gültig sind. AnwendungsbeispielNutzbar als “Jetzt kaufen”-Button auf der Bestellübersichtsseite, über den der Kunde die Bestellung verbindlich aufgibt. Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie die Bestellung über einen Button verbindlich abgeschickt wird, sofern der Kunde eingeloggt oder als Gast identifiziert ist.
CheckoutSetFreeFields
Mit dieser Aktion werden die freien Checkout-Felder gesetzt, z.B. die Zustimmung zu den AGB oder ein Kommentarfeld. Die Aktion wird typischerweise zusammen mitCheckoutConfirm auf der Bestellübersichtsseite eingesetzt.
AnwendungsbeispielNutzbar auf der Bestellübersichtsseite, um dem Kunden z.B. eine Checkbox zur Zustimmung der AGB anzuzeigen, die vor dem Abschicken der Bestellung akzeptiert werden muss. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie eine AGB-Checkbox als freies Checkout-Feld eingebunden wird.
CheckoutSetCustomerData
Mit dieser Aktion werden zusätzliche Kundendaten im Checkout gesetzt. Die Felder werden dynamisch aus der Konfiguration geladen und können gruppiert oder ungruppiert vorliegen. AnwendungsbeispielNutzbar im Checkout, um konfigurierte Kundendaten-Felder (z.B. Firmenname, Telefon) abzufragen, die über die Standardadresse hinausgehen. Parameter
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie gruppierte Kundendaten-Felder dynamisch gerendert und Fehler feldspezifisch ausgegeben werden:
CheckoutPseudoCCSelect
Mit dieser Aktion wählt der Kunde eine seiner gespeicherten Pseudo-Kreditkarten für den aktuellen Bestellvorgang aus. Die Aktion ist ausschließlich für die Computop-Kreditkarten-Integration relevant. AnwendungsbeispielNutzbar im Checkout, wenn der Kunde eine zuvor hinterlegte Kreditkarte verwenden möchte, ohne die Kartendaten erneut einzugeben. Der Wert
0 steht für “keine gespeicherte Karte verwenden”.
Parameter
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie gespeicherte Kreditkarten zur Auswahl angezeigt werden, inklusive der Option, keine Karte zu verwenden.
CheckoutNewsletterSubscribe
Mit dieser Aktion wird ein Kunde während des Bestellvorgangs für den Newsletter angemeldet. Sie funktioniert analog zur Aktion NewsletterSubscribe - Parameter, Fehlercodes und das Feldübergabe-Verhalten sind identisch. AnwendungsbeispielNutzbar im Checkout, um Kunden während des Bestellvorgangs die Möglichkeit zu geben, sich für den Newsletter anzumelden, beispielsweise über eine Checkbox auf der Bestellübersichtsseite. Parameter
Fehlercodes
Zugehörige Module, Variablen & Methoden
Beispiel das zeigt, wie ein Kunde im Checkout eine Zielgruppe auswählt und sich für den Newsletter anmeldet.
CheckoutStoreIdSelect
Mit dieser Aktion wählt der Kunde einen Markt als Abholort für den aktuellen Bestellvorgang aus. Die Aktion ist nur relevant, wenn eine Versandart vom Typpickup ausgewählt wurde. Bei der Auswahl wird geprüft, ob alle Produkte im gewählten Markt verfügbar sind. Ist das nicht der Fall, wird die Aktion nicht ausgeführt und es wird ein Fehler zurückgegeben.Wurde kein Markt ausgewählt, wird standardmäßig der Markt aus der allgemeinen Session-Auswahl verwendet. Anwendungsbeispiel
Nutzbar, wenn der Kunde eine Bestellung direkt in einem Markt abholen möchte und im Checkout aus den verfügbaren Click & Collect-Märkten wählen soll. Fehlercodes
Zugehörige Module, Variablen & Methoden
- $wsCheckout
- $wsCheckout.selectedStoreID
- $wsCheckout.selectedShippingMethod
- $wsStores
- $wsStores.loadAllStores()
- $wsConfig.shippingMethods
pickup ein Dropdown mit allen Click & Collect-fähigen Märkten zeigt. Es setzt den gewählten Markt per CheckoutStoreIdSelect als Abholort, inklusive Fehlerbehandlung bei nicht verfügbaren Artikeln im gewählten Markt.
