$wsCheckout

$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


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

Name

Rückgabe-Typ

Beschreibung

accountType

string

Gibt den Typ des Kontos aus.

Mögliche Werte:

  • guest - Gastkonto

  • new - Neues Konto

  • registered - Registriertes Konto

customerData

map

Map mit Kundendaten-Feldern.

fieldGroups

array

Gibt eine Liste der Feldgruppen innerhalb der Kundendaten aus.

[].hidden

bool

Gibt aus, ob eine Feldgruppe im Frontend ausgeblendet werden soll.

useAlternativeShippingAddress

bool

Gibt aus, ob eine abweichende Lieferadresse aktiv ist.

selectedPayment

string

Gibt die ID der gewählten Zahlungsart aus.

selectedShippingMethod

string

Gibt die ID der gewählten Versandart aus.

selectedBillAddress

string

Gibt die ID der ausgewählten Rechnungsadresse aus.

draftBillAddressId

string

Gibt die ID der temporären Rechnungsadresse aus, die nur für die aktuelle Session existiert und noch nicht im Kundenkonto gespeichert ist..

selectedShippingAddress

string

Gibt die ID der ausgewählten Lieferadresse aus.

draftShippingAddressId

string

Gibt die ID der temporären Lieferadresse aus, die nur für die aktuelle Session existiert und noch nicht im Kundenkonto gespeichert ist.

selectedPseudoCC

string

Gibt den Pseudo-Kreditkarten-Token aus.

selectedStoreId

int

Gibt die ID der ausgewählten Filiale aus.

freeFields

map

Gibt eine Map mit Informationen zu freien Checkout-Feldern aus.

[$i].default

string

Gibt den Standardwert des freien Checkout-Feldes aus.

[$i].id

string

Gibt die ID des freien Checkout-Feldes aus.

[$i].name

string

Gibt den technischen Namen des freien Checkout-Feldes aus.

[$i].type

string

Gibt den Typ des freien Checkout-Feldes aus.

[$i].required

string

Gibt aus, ob das freie Checkout-Feld ein Pflichtfeld ist.

[$i].value

string

Gibt den aktuellen Wert des freien Checkout-Feldes aus.

[$i].text

string

Gibt den konfigurierbaren Text zum freien Checkout-Feld aus.

[$i].checked

bool

Gibt aus, ob die Checkbox des frei verfügbaren Felds angehakt ist. (Nur bei type “checkbox”).

guestMail

string

Gibt die E-Mail des Gastkontos aus.

isValid

bool

Gibt aus, ob die Bestellung ausgeführt werden kann.

isExpressCheckoutLocked

bool

Gibt aus, ob der Express-Checkout gesperrt ist (z.B. nach PayPal-Zahlung).

isPPCExpressCheckout

bool

Gibt aus, ob der PayPal Commerce Platform Express Checkout aktiv ist.

isPPCApplePayExpressCheckout

bool

Gibt aus, ob der Apple Pay Express Checkout aktiv ist.

isPPCGooglePayExpressCheckout

bool

Gibt aus, ob der Google Pay Express Checkout aktiv ist.

problems

map

Gibt eine Map mit Checkout-Problemen aus, wenn isValid den Wert false hat.

payment

array

Gibt Probleme zur ausgewählten Zahlungsart aus.

[$i].code

string

Gibt den Fehlercode aus.

[$i].text

string

Gibt den Fehlertext aus der Konfiguration aus.

[$i].check

string

Gibt den Service-Namen des Checks aus.

shippingMethod

array

Gibt Probleme zur ausgewählten Versandart aus.

[$i].code

string

Gibt den Fehlercode aus.

[$i].text

string

Gibt den Fehlertext aus der Konfiguration aus.

[$i].check

string

Gibt den Service-Namen des Checks aus.

billAddress

array

Gibt Probleme zur ausgewählten Rechnungsadresse aus.

[$i].field

string

Gibt das Feld aus, zu dem der Fehler gehört.

[$i].code

string

Gibt den Fehlercode aus.

[$i].text

string

Gibt den Fehlertext aus der Konfiguration aus.

[$i].check

string

Gibt den Service-Namen des Checks aus.

shippingAddress

array

Gibt Probleme zur ausgewählten Lieferadresse aus.

[$i].field

string

Gibt das Feld aus, zu dem der Fehler gehört.

[$i].code

string

Gibt den Fehlercode aus.

[$i].text

string

Gibt den Fehlertext aus der Konfiguration aus.

[$i].check

string

Gibt den Service-Namen des Checks aus.

freeFields

array

Gibt Probleme zu freien Checkout-Feldern aus.

[$i].field

string

Gibt das Feld aus, zu dem der Fehler gehört.

[$i].code

string

Gibt den Fehlercode aus.

clearing

array

Gibt Probleme bei der Zahlungsabwicklung aus.

general

array

Gibt Allgemeine Checkout-Probleme aus.

sum

map

Gibt eine Map mit Preisinformationen zum Checkout aus.

currency

string

Gibt den Währungscode des Warenkorbs aus (z.B. “EUR”).

paymentCost

float

Gibt die Kosten der Zahlungsart aus, falls vorhanden.

surchargeCost

float

Gibt Zusatzkosten Aufschläge aus, falls vorhanden.

totalWeight

float

Gibt das Gesamtgewicht der Bestellung aus.

total

float

Gibt den Gesamtbetrag des Warenkorbs aus.

totalNet

float

Gibt den Nettobetrag des Warenkorbs aus.

totalGross

float

Gibt den Bruttobetrag des Warenkorbs aus.

totalPreDeduction

float

Gibt den Gesamtbetrag ohne Abzug der Steuer aus.

totalTax

float

Gibt die gesamte Mehrwertsteuer des Warenkorbs aus.

shippingCost

float

Gibt die Versandkosten des Warenkorbs aus.

totalVoucher

float

Gibt den Wert der eingelösten Gutscheine des Warenkorbs aus.

verificationStatus

int

Gibt den Verifizierungsstatus der Bestellung aus.

verificationStatusOptions

array

Array mit verfügbaren Verifizierungsstatus-Optionen.

voucherAppliesPerItem

bool

Gibt aus, ob ein Gutschein für Artikel angewendet wird.

fieldStates

map

Gibt den aktuellen Zustand jedes Checkout-Feldes aus.
Mögliche Werte:

  • “untouched”, “empty”, “invalid”, “incompatible”, “valid”

payment

string

Gibt den Zustand der gewählten Zahlungsart aus.

shippingMethod

string

Gibt den Zustand der gewählten Versandart aus.

billAddress

string

Gibt den Zustand der gewählten Rechnungsadresse aus.

shippingAddress

string

Gibt den Zustand der gewählten Lieferadresse aus.

isValidPayment()

bool

Prüft, ob die Zahlungsart mit der angegebenen ID verfügbar ist.

isValidShippingMethod()

bool

Prüft, ob die Versandart mit der angegebenen ID verfügbar ist.

isValidBillAddress()

bool

Prüft, ob die Adresse mit der angegebenen ID eine gültige Rechnungsadresse ist.

isValidShippingAddress()

bool

Prüft, ob die Adresse mit der angegebenen ID eine gültige Lieferadresse ist.

isPending()

bool

Prüft, ob ein Zahlungsvorgang noch aussteht.

isFinished()

bool

Prüft, ob eine Bestellung abgeschlossen wurde.

getAmountInSmallestUnit()

int

Gibt den Betrag in der kleinsten Währungseinheit zurück (z.B. Cent statt Euro).

getShippingMethodDisabledErrors()

array

Gibt zurück, warum eine Versandart deaktiviert ist.

itemVoucherDiscount

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 }}