$wsCheckout
Mit dem $wsCheckout Modul können Sie alle Daten des Bestellvorgangs dynamisch im Frontend verwenden. Es enthält Informationen zu Zahlungs- und Versandarten, Rechnungs- und Lieferadressen, Bestellsummen sowie Validierungsergebnisse.
Inhaltsverzeichnis
- 1 Modulübersicht
- 2 Templates
- 3 Variablen
- 3.1 $wsCheckout.accountType
- 3.2 $wsCheckout.customerData
- 3.3 $wsCheckout.useAlternativeShippingAddress
- 3.4 $wsCheckout.selectedPayment
- 3.5 $wsCheckout.selectedShippingMethod
- 3.6 $wsCheckout.selectedBillAddress
- 3.7 $wsCheckout.draftBillAddressId
- 3.8 $wsCheckout.selectedShippingAddress
- 3.9 $wsCheckout.draftShippingAddressId
- 3.10 $wsCheckout.selectedStoreID
- 3.11 $wsCheckout.selectedPseudoCC
- 3.12 $wsCheckout.freeFields
- 3.12.1 $wsCheckout.freeFields[$i].checked
- 3.12.2 $wsCheckout.freeFields[$i].default
- 3.12.3 $wsCheckout.freeFields[$i].id
- 3.12.4 $wsCheckout.freeFields[$i].name
- 3.12.5 $wsCheckout.freeFields[$i].type
- 3.12.6 $wsCheckout.freeFields[$i].required
- 3.12.7 $wsCheckout.freeFields[$i].value
- 3.12.8 $wsCheckout.freeFields[$i].text
- 3.13 $wsCheckout.guestMail
- 3.14 $wsCheckout.isValid
- 3.15 $wsCheckout.isExpressCheckoutLocked
- 3.16 $wsCheckout.isPPCExpressCheckout
- 3.17 $wsCheckout.isPPCApplePayExpressCheckout
- 3.18 $wsCheckout.isPPCGooglePayExpressCheckout
- 3.19 $wsCheckout.verificationStatus
- 3.20 $wsCheckout.verificationStatusOptions
- 3.21 $wsCheckout.voucherAppliesPerItem
- 3.22 $wsCheckout.fieldStates
- 3.23 $wsCheckout.problems
- 3.23.1 $wsCheckout.problems.clearing
- 3.23.2 $wsCheckout.problems.general
- 3.23.3 Fehler-Codes in $wsCheckout.problems.*
- 3.23.4 $wsCheckout.problems.payment
- 3.23.5 $wsCheckout.problems.shippingMethod
- 3.23.6 $wsCheckout.problems.billAddress
- 3.23.7 $wsCheckout.problems.shippingAddress
- 3.23.8 $wsCheckout.problems.freeFields
- 3.24 $wsCheckout.sum
- 3.24.1 $wsCheckout.sum.total
- 3.24.2 $wsCheckout.sum.totalNet
- 3.24.3 $wsCheckout.sum.totalGross
- 3.24.4 $wsCheckout.sum.totalPreDeduction
- 3.24.5 $wsCheckout.sum.totalTax
- 3.24.6 $wsCheckout.sum.shippingCost
- 3.24.7 $wsCheckout.sum.totalVoucher
- 3.24.8 $wsCheckout.sum.currency
- 3.24.9 $wsCheckout.sum.paymentCost
- 3.24.10 $wsCheckout.sum.surchargeCost
- 3.24.11 $wsCheckout.sum.totalWeight
- 4 Methoden
- 4.1 $wsCheckout.isValidPayment()
- 4.2 $wsCheckout.isValidShippingMethod()
- 4.3 $wsCheckout.isValidBillAddress()
- 4.4 $wsCheckout.isValidShippingAddress()
- 4.5 $wsCheckout.isPending()
- 4.6 $wsCheckout.isFinished()
- 4.7 $wsCheckout.getAmountInSmallestUnit()
- 4.8 $wsCheckout.getShippingMethodDisabledErrors()
- 4.9 $wsCheckout.itemVoucherDiscount()
- 5 Aktionen
- 6 Beispiele für die Anzeige von Checkoutdaten
- 6.1.1 Kontotyp Prüfen
- 6.1.2 Prüfung auf neues Konto
- 6.1.3 Gastbesteller E-Mail Adresse
- 6.2 Rechnungsadresse
- 6.2.1 Gültigkeit der Adresse prüfen
- 6.2.2 Index der Rechnungsadresse
- 6.2.3 Fehler anzeigen
- 6.3 Lieferadresse
- 6.3.1 Abweichende Lieferadresse
- 6.3.2 Index der Lieferadresse
- 6.3.3 Lieferadresse Gültigkeit
- 6.3.4 Fehler anzeigen
- 6.4 Zahlung
- 6.4.1 Gewählte Zahlungsart
- 6.4.2 Zahlungsart Gültigkeit
- 6.4.3 Fehler anzeigen
- 6.5 Versand
- 6.5.1 Gewählte Versandart
- 6.5.2 Restbetrag bis zum kostenlosen Versand
- 6.5.3 Versandart Gültigkeit
- 6.5.4 Fehler anzeigen
- 6.6 Checkoutstatus
- 6.7 Free Fields (Freifelder)
- 6.8 Sum (Summe, Rabatte & Zusatzkosten)
- 6.8.1 Versandkosten
- 6.8.2 Total
- 6.8.3 Total Gross
- 6.8.4 Total Net
- 6.8.5 Total Tax
- 6.8.6 Total Voucher
- 7 Weiterführende Links
Modulübersicht
Beispiel / Ausschnitt über $wsCheckout
{{= $wsCheckout | json }}
JSON-Ausgabe
{
"accountType": "...",
"customerData": { },
"freeFields": [...],
"guestMail": "...",
"isExpressCheckoutLocked": false,
"isPPCExpressCheckout": false,
"isPPCApplePayExpressCheckout": false,
"isPPCGooglePayExpressCheckout": false,
"isValid": false,
"problems": {
"billAddress": [...],
"clearing": [...],
"freeFields": [...],
"general": [...],
"payment": [...],
"shippingAddress": [...],
"shippingMethod": [...]
},
"selectedBillAddress": "...",
"selectedPayment": "...",
"selectedPseudoCC": "...",
"selectedShippingAddress": "...",
"selectedShippingMethod": "...",
"selectedStoreId": 0,
"sum": {
"currency": "...",
"paymentCost": 0.0,
"shippingCost": 0.0,
"surchargeCost": 0.0,
"total": 0.0,
"totalPreDeduction": 0.0,
"totalGross": 0.0,
"totalNet": 0.0,
"totalTax": 0.0,
"totalVoucher": 0.0,
"totalWeight": 0.0
},
"useAlternativeShippingAddress": false,
"verificationStatus": 0,
"verificationStatusOptions": [...],
"voucherAppliesPerItem": false,
"fieldStates": {
"payment": "...",
"shippingMethod": "...",
"billAddress": "...",
"shippingAddress": "..."
},
"getAmountInSmallestUnit": "ƒ()",
"getShippingMethodDisabledErrors": "ƒ()",
"isFinished": "ƒ()",
"isPending": "ƒ()",
"isValidBillAddress": "ƒ()",
"isValidPayment": "ƒ()",
"isValidShippingAddress": "ƒ()",
"isValidShippingMethod": "ƒ()",
"itemVoucherDiscount": "ƒ()"
}Anmerkung: “f()” kennzeichnet eine Funktion.
Variablen und Methoden in der Übersicht
Name | Rückgabe-Typ | Beschreibung |
|---|---|---|
| string | Gibt den Typ des Kontos aus.
|
| map | Map mit Kundendaten-Feldern. |
| array | Gibt eine Liste der Feldgruppen innerhalb der Kundendaten aus. |
| bool | Gibt aus, ob eine Feldgruppe im Frontend ausgeblendet werden soll. |
| bool | Gibt aus, ob eine abweichende Lieferadresse aktiv ist. |
| string | Gibt die ID der gewählten Zahlungsart aus. |
| string | Gibt die ID der gewählten Versandart aus. |
| string | Gibt die ID der ausgewählten Rechnungsadresse aus. |
| string | Gibt die ID der temporären Rechnungsadresse aus, die nur für die aktuelle Session existiert und noch nicht im Kundenkonto gespeichert ist.. |
| string | Gibt die ID der ausgewählten Lieferadresse aus. |
| string | Gibt die ID der temporären Lieferadresse aus, die nur für die aktuelle Session existiert und noch nicht im Kundenkonto gespeichert ist. |
| string | Gibt den Pseudo-Kreditkarten-Token aus. |
| int | Gibt die ID der ausgewählten Filiale aus. |
| map | Gibt eine Map mit Informationen zu freien Checkout-Feldern aus. |
| string | Gibt den Standardwert des freien Checkout-Feldes aus. |
| string | Gibt die ID des freien Checkout-Feldes aus. |
| string | Gibt den technischen Namen des freien Checkout-Feldes aus. |
| string | Gibt den Typ des freien Checkout-Feldes aus. |
| string | Gibt aus, ob das freie Checkout-Feld ein Pflichtfeld ist. |
| string | Gibt den aktuellen Wert des freien Checkout-Feldes aus. |
| string | Gibt den konfigurierbaren Text zum freien Checkout-Feld aus. |
| bool | Gibt aus, ob die Checkbox des frei verfügbaren Felds angehakt ist. (Nur bei type |
| string | Gibt die E-Mail des Gastkontos aus. |
| bool | Gibt aus, ob die Bestellung ausgeführt werden kann. |
| bool | Gibt aus, ob der Express-Checkout gesperrt ist (z.B. nach PayPal-Zahlung). |
| bool | Gibt aus, ob der PayPal Commerce Platform Express Checkout aktiv ist. |
| bool | Gibt aus, ob der Apple Pay Express Checkout aktiv ist. |
| bool | Gibt aus, ob der Google Pay Express Checkout aktiv ist. |
| map | Gibt eine Map mit Checkout-Problemen aus, wenn |
| array | Gibt Probleme zur ausgewählten Zahlungsart aus. |
| string | Gibt den Fehlercode aus. |
| string | Gibt den Fehlertext aus der Konfiguration aus. |
| string | Gibt den Service-Namen des Checks aus. |
| array | Gibt Probleme zur ausgewählten Versandart aus. |
| string | Gibt den Fehlercode aus. |
| string | Gibt den Fehlertext aus der Konfiguration aus. |
| string | Gibt den Service-Namen des Checks aus. |
| array | Gibt Probleme zur ausgewählten Rechnungsadresse aus. |
| string | Gibt das Feld aus, zu dem der Fehler gehört. |
| string | Gibt den Fehlercode aus. |
| string | Gibt den Fehlertext aus der Konfiguration aus. |
| string | Gibt den Service-Namen des Checks aus. |
| array | Gibt Probleme zur ausgewählten Lieferadresse aus. |
| string | Gibt das Feld aus, zu dem der Fehler gehört. |
| string | Gibt den Fehlercode aus. |
| string | Gibt den Fehlertext aus der Konfiguration aus. |
| string | Gibt den Service-Namen des Checks aus. |
| array | Gibt Probleme zu freien Checkout-Feldern aus. |
| string | Gibt das Feld aus, zu dem der Fehler gehört. |
| string | Gibt den Fehlercode aus. |
| array | Gibt Probleme bei der Zahlungsabwicklung aus. |
| array | Gibt Allgemeine Checkout-Probleme aus. |
| map | Gibt eine Map mit Preisinformationen zum Checkout aus. |
| string | Gibt den Währungscode des Warenkorbs aus (z.B. |
| float | Gibt die Kosten der Zahlungsart aus, falls vorhanden. |
| float | Gibt Zusatzkosten Aufschläge aus, falls vorhanden. |
| float | Gibt das Gesamtgewicht der Bestellung aus. |
| float | Gibt den Gesamtbetrag des Warenkorbs aus. |
| float | Gibt den Nettobetrag des Warenkorbs aus. |
| float | Gibt den Bruttobetrag des Warenkorbs aus. |
| float | Gibt den Gesamtbetrag ohne Abzug der Steuer aus. |
| float | Gibt die gesamte Mehrwertsteuer des Warenkorbs aus. |
| float | Gibt die Versandkosten des Warenkorbs aus. |
| float | Gibt den Wert der eingelösten Gutscheine des Warenkorbs aus. |
| int | Gibt den Verifizierungsstatus der Bestellung aus. |
| array | Array mit verfügbaren Verifizierungsstatus-Optionen. |
| bool | Gibt aus, ob ein Gutschein für Artikel angewendet wird. |
| map | Gibt den aktuellen Zustand jedes Checkout-Feldes aus.
|
| string | Gibt den Zustand der gewählten Zahlungsart aus. |
| string | Gibt den Zustand der gewählten Versandart aus. |
| string | Gibt den Zustand der gewählten Rechnungsadresse aus. |
| string | Gibt den Zustand der gewählten Lieferadresse aus. |
| bool | Prüft, ob die Zahlungsart mit der angegebenen ID verfügbar ist. |
| bool | Prüft, ob die Versandart mit der angegebenen ID verfügbar ist. |
| bool | Prüft, ob die Adresse mit der angegebenen ID eine gültige Rechnungsadresse ist. |
| bool | Prüft, ob die Adresse mit der angegebenen ID eine gültige Lieferadresse ist. |
| bool | Prüft, ob ein Zahlungsvorgang noch aussteht. |
| bool | Prüft, ob eine Bestellung abgeschlossen wurde. |
| int | Gibt den Betrag in der kleinsten Währungseinheit zurück (z.B. Cent statt Euro). |
| array | Gibt zurück, warum eine Versandart deaktiviert ist. |
| float | Berechnet den Gutscheinrabatt für einen Artikel. |
Templates
Der Checkoutvorgang ist vollkommen flexibel, Sie können ihn frei gestalten. Er kann eine oder mehrere Shopseiten umfassen. Bei der Auswahl der Elemente ist die Reihenfolge beliebig.
Variablen
$wsCheckout.accountType
Gibt den Kontotyp aus: "guest" (Gast), "new" (neues Konto) oder "registered" (angemeldet).
{{ if $wsCheckout.accountType == "guest" }}
// Es handelt sich um ein Gastkonto
{{ /if }}
$wsCheckout.customerData
Gibt eine Map mit Kundendaten-Feldern aus.
{{ if $wsCheckout.customerData }}
// Kundendaten-Felder verfügbar
{{ /if }}
$wsCheckout.customerData.fieldGroups
Gibt eine Liste der Feldgruppen innerhalb der Kundendaten aus. Jede Gruppe fasst zusammengehörige Felder unter einem gemeinsamen Label zusammen.
{{ foreach $group in $wsCheckout.customerData.fieldGroups }}
{{= $group.label }}
{{ /foreach }}
$wsCheckout.customerData.fieldGroups[].hidden
Gibt aus, ob eine Feldgruppe im Frontend ausgeblendet werden soll. Damit lässt sich steuern, welche Gruppen dem Kunden angezeigt werden.
{{ foreach $group in $wsCheckout.customerData.fieldGroups }}
{{ if not $group.hidden }}
<fieldset>
<legend>{{= $group.label }}</legend>
...
</fieldset>
{{ /if }}
{{ /foreach }}$wsCheckout.useAlternativeShippingAddress
Gibt aus, ob eine abweichende Lieferadresse verwendet wird.
{{ if $wsCheckout.useAlternativeShippingAddress }}
// Abweichende Lieferadresse wird verwendet
{{ /if }}
$wsCheckout.selectedPayment
Gibt die ID der ausgewählten Zahlungsart aus.
{{ if $wsCheckout.selectedPayment == "stripe" }}
// Stripe ist ausgewählt
{{ /if }}