Aktionen im Überblick
| Aktion | Beschreibung |
|---|---|
CheckoutAccountTypeSelect | Legt den Kontotyp für den aktuellen Bestellvorgang fest. |
CheckoutBillAddressSelect | Setzt eine gespeicherte Adresse als aktive Rechnungsadresse. |
CheckoutShippingAddressSelect | Setzt eine gespeicherte Adresse als aktive Lieferadresse. |
CheckoutSetDraftAddress | Speichert eine Adresse temporär als Entwurf (ohne Validierung). |
CheckoutCommitDraftAddress | Übernimmt einen Adressentwurf als verbindliche Checkout-Adresse (mit Validierung). |
CheckoutUseSameShippingAddress | Setzt die Lieferadresse gleich der Rechnungsadresse. |
CheckoutUseDifferentShippingAddress | Aktiviert eine abweichende Lieferadresse. |
CheckoutSetGuestEmail | Setzt die E-Mail-Adresse für eine Gastbestellung. |
CheckoutPaymentUpdate | Setzt die Zahlungsart für den aktuellen Bestellvorgang. |
CheckoutShippingMethodUpdate | Setzt die Versandart für den aktuellen Bestellvorgang. |
CheckoutConfirm | Schickt die Bestellung verbindlich ab. |
CheckoutSetFreeFields | Setzt die freien Checkout-Felder, z.B. AGB-Zustimmung. |
CheckoutSetCustomerData | Setzt Kundendaten im Checkout. |
CheckoutPseudoCCSelect | Wählt eine gespeicherte Pseudo-Kreditkarte aus. |
CheckoutNewsletterSubscribe | Meldet den Kunden während des Checkouts zum Newsletter an. |
CheckoutSetVerificationStatus | Setzt den Verifizierungsstatus der Bestellung. (Doku folgt) |
CheckoutStoreIdSelect | Setzt einen Markt als Abholort für den aktuellen Bestellvorgang. |
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
| Name | Beschreibung |
|---|---|
addressId | Die ID der Adresse, die als Rechnungsadresse gesetzt werden soll. |
| Fehlercode | Beschreibung |
|---|---|
missingAddressId | Parameter addressId fehlt, |
invalidAddressId | Die angegebene Adresse existiert nicht oder gehört nicht zu diesem Kundenkonto. |
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
| Name | Beschreibung |
|---|---|
addressId | Die ID der Adresse, die als Lieferadresse gesetzt werden soll. |
| Fehlercode | Beschreibung |
|---|---|
missingAddressId | Parameter addressId fehlt. |
invalidAddressId | Die angegebene Adresse existiert nicht oder gehört nicht zu diesem Kundenkonto. |
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
| Name | Beschreibung |
|---|---|
address.(fieldname) | Die einzelnen Felder der Adresse, z.B. address.firstName, address.street etc. |
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
| Name | Beschreibung |
|---|---|
address.(fieldname) | Die einzelnen Felder der Adresse, z.B. address.firstName, address.street etc. |
| Fehlercode | Beschreibung |
|---|---|
addressCheckFailed | Fehler in den Adressedaten. Wird über Sub-Codes konkretisiert: - minlen = zu wenig Zeichen - maxlen = zu viele Zeichen - numeric = ungültige Zeichen - country = Land nicht konfiguriert - zip = Postleitzahl fehlerhaft |
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
| Name | Beschreibung |
|---|---|
accountType | Der gewünschte Kontotyp. Mögliche Werte: - guest - Gastkonto - new - Neues Kundenkonto - registered - Registrierter Kunde |
| Fehlercode | Beschreibung |
|---|---|
invalidAccountType | Der angegebene Kontotyp ist ungültig. |
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
| Name | Beschreibung |
|---|---|
guestEmail | Die E-Mail-Adresse des Gastkunden. |
| Code | Beschreibung |
|---|---|
missingEmail | Parameter guestEmail fehlt. |
emailCheckFailed | Parameter guestEmail enthält keine gültige E-Mail-Adresse. |
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
| Name | Beschreibung |
|---|---|
shippingMethodId | Die ID der Versandart, die ausgewählt werden soll. |
| Fehlercode | Beschreibung |
|---|---|
missingShippingMethodId | Parameter shippingMethodId fehlt. |
invalidShippingMethodId | Die angegebene Versandart ist nicht verfügbar. |
- $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
| Fehlercode | Beschreibung |
|---|---|
notLoggedIn | Der Benutzer ist nicht eingeloggt und es ist keine Gast-E-Mail vorhanden. |
invalidCheckout | Der Checkout ist nicht vollständig oder enthält ungültige Angaben. |
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
| Name | Beschreibung |
|---|---|
freeFields.(id).value | Der Wert des freien Felds, z.B. freeFields.agb.value für die AGB-Checkbox. |
| Fehlercode | Beschreibung |
|---|---|
missingRequiredField | Ein Pflichtfeld wurde nicht ausgefüllt. |
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
| Name | Beschreibung |
|---|---|
(dynamisch) | Die Felder werden aus $wsCheckout.customerData geladen und variieren je nach Shop-Konfiguration. |
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
| Name | Beschreibung |
|---|---|
pseudoCCId | Die ID der gespeicherten Pseudo-Kreditkarte. Der Wert 0 wählt keine Karte aus. |
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
| Name | Beschreibung |
|---|---|
email | Die E-Mail-Adresse, die für den Newsletter angemeldet werden soll. |
targetGroupId.(id) | Optionale Zielgruppen-ID, für die der Kunde angemeldet werden soll. |
| Fehlercode | Beschreibung |
|---|---|
missingEmail | Parameter email fehlt. |
emailCheckFailed | Die angegebene E-Mail-Adresse ist ungültig. |
accountAlreadyExists | Die E-Mail-Adresse ist bereits für den Newsletter angemeldet. |
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
| Fehlercode | Beschreibung |
|---|---|
reservationFailed | Die Artikel sind im gewählten Markt nicht verfügbar. Details zum betroffenen Produkt werden über error.details.productId zurückgegeben. |
- $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.
