In diesem Abschnitt finden Sie alle Möglichkeiten, um auf die Daten von Gutscheinen zuzugreifen. Es werden die verfügbaren Variablen und Tags beschrieben, mit denen Sie die Gutscheindaten dynamisch im Frontend anzeigen können.

Inhaltsübersicht

1 Templates
2 Datenübersicht
- 2.1 Einzeln Gutschein laden
3 Beispiel für Anzeige von Gutscheindaten
4 Praxisbeispiele
5 Referenz

Templates

Gutscheindaten können grundsätzlich auf allen Templates geladen und angezeigt werden. Eine Eingabe bzw. Einlösung eines Gutscheincodes ist im gesamten Shop möglich. Am sinnvollsten erfolgt dies jedoch innerhalb des Bestellprozesses oder im Warenkorb.

Datenübersicht

Über das Modul $wsVoucher können die Daten aller sowie einzelner Gutscheine geladen und angezeigt werden. Dies ist hilfreich für das Debugging oder zum direkten Auslesen relevanter Gutscheininformationen.

Um auf die verfügbaren Gutscheindaten des Moduls $wsVoucher zuzugreifen, können diese in einem JSON-ähnlichen Format ausgegeben werden.

<!--
  {{= $wsVoucher | json }}
-->

In der Developer-Konsole des Browsers kann die Ausgabe beispielsweise wie folgt aussehen:
Dabei werden Informationen zum gesamten Gutscheinwert, dem bereits eingelösten Betrag sowie Details zum verwendeten Gutschein angezeigt.

{
  "load": "(Function)",
  "totalUsedValue": 0.0,
  "totalValue": 0.0,
  "vouchers": [
    {
      "currency": "EUR",
      "id": "MeinGutscheinCodeID",
      "taxId": "",
      "usedValue": 0.0,
      "value": 0.0
    }
  ]
}

Einzeln Gutschein laden

Die Funktion $wsVoucher.load() ermöglicht es, die Details eines einzelnen Gutscheins abzurufen. Als Argument wird dabei die entsprechende Gutscheinnummer übergeben. Das Abrufen der Daten erfolgt folgendermaßen (auskommentiert, damit die Ausgabe nicht direkt im Frontend angezeigt wird):

<!-- 
{{ 
  var $voucher = $wsVoucher.load("9S3J-45M4-5MV7-JTJL");
  print $voucher
}}
-->

Die Ausgabe in der Developer-Konsole des Browsers könnte dann wie folgt aussehen:

Diese Ausgabe enthält typische Gutscheininformationen wie den Gutscheincode, den Rabatt (prozentual oder absolut), die Gültigkeitsdauer, das Verfallsdatum sowie mögliche Einschränkungen wie einen Mindestbestellwert oder eine maximale Nutzungsanzahl.

<!--
{
	"taxId": "",
	"minOrderValue": 50.000000,
	"currency": "EUR",
	"value": 0.000000,
	"validUntil": "2025-03-31T22:00:00.000Z",
	"validFrom": "2025-02-11T23:00:00.000Z",
	"id": "5EUR"
}
-->

Beispiel für Anzeige von Gutscheindaten

Wert des Gutscheins

In diesem Beispiel wird der Wert des Gutscheins angezeigt.

Voucher Value: {{= $voucher.value }}

Gutschein-Typ: Prozentualer oder Festbetrag

In diesem Beispiel wird geprüft und angezeigt, ob der Gutschein einen prozentualen Rabatt oder einen festen Betrag gewährt.

PO 27/02/25 - Funktioniert bei mir noch nicht, weder im Warenkorb noch wenn frei platziert.

Rabatt Typ: {{= $voucher.percentValue | ifNull("Percentage Value is null")}} {{= $voucher.absoluteValue | ifNull("absolute value is nulll")}}

Gültigkeitsdatum des Gutscheins

In diesem Beispiel werden das Start- und Enddatum der Gültigkeit eines Gutscheins angezeigt.

Gültig ab: {{= $voucher.validFrom | dateFmt("%d.%m.%Y") }}
Gültig bis: {{= $voucher.validUntil | dateFmt("%d.%m.%Y") }}

Währung des Gutscheins

In diesem Beispiel wird die Währung angezeigt, in der der Gutschein ausgestellt wurde.

Gutscheinwert: {{= $voucher.value }}

Restbetrag eines Gutscheins anzeigen

In diesem Beispiel wird angezeigt, wie viel Restbetrag ein teilgenutzter Gutschein noch hat.

Restbetrag: {{= ($voucher.value - $voucher.usedValue) | currency }}

Gültigkeit eines Gutscheins prüfen

In diesem Beispiel wird überprüft, ob der Gutschein grundsätzlich gültig ist.

{{ if $voucherAddAction.success }}
  Gutschein erfolgreich in den Warenkorb gelegt.
{{ /if }}

Praxisbeispiele

Auf der Seite Gutscheine finden Sie anwendungsnahe Beispiele zur Nutzung und Anzeige der Modul-Daten sowie dem Einlösen von Gutscheinen im Bestellprozess.

Referenz

In der Modul-Referenz für $wsVoucher finden Sie eine Übersicht aller verfügbaren Eigenschaften und Parameter.

Für das Modul $wsVoucher stehen zudem Aktionen zur Verfügung, die es ermöglichen, mit den Modul-Daten zu interagieren. Diese Aktionen können über HTML-Formulare oder Ajax-Anfragen ausgeführt werden und erlauben z. B. das Ändern, Hinzufügen oder Löschen von Daten.

Die Konfigurationsmöglichkeiten des Moduls sind bei den Konfigurationsparameter beschrieben und können je nach Bedarf angepasst werden.

$wsVoucher - Gutscheine