Use this file to discover all available pages before exploring further.
Der Endpunkt vouchers/ stellt Ihnen eine Schnittstelle zur Verfügung mit der Sie Gutscheine in unserem Shop-System verwalten können. Mit dieser Schnittstelle können Sie Gutscheine erzeugen, löschen, Vorlagen erstellen und und vorhandene Gutscheine einsehen.
In diesem Abschnitt werden alle Endpunkte zur Verwaltung einzelner Gutscheine beschrieben. Über die Schnittstelle können Gutscheine erstellt, aktualisiert, gelöscht und abgerufen werden. Die Verwaltung von Gutschein-Chargen wird in einem eigenen Abschnitt separat behandelt.Für alle Operationen sind entsprechende Lese-, Schreib-, Erstell- oder Löschberechtigungen erforderlich.
Diese Methode liefert eine paginierte Liste aller im System vorhandenen Gutscheine.Über Filter- und Sortierparameter können die Ergebnisse gezielt eingeschränkt und geordnet werden. Die zurückgegebenen Gutscheindaten umfassen Informationen zu Aktivität, Gültigkeit, Einlösebedingungen und Wertangaben.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode aktualisiert die Eigenschaften eines bestehenden Gutscheins anhand seiner eindeutigen ID. Über den Request-Body können verschiedene Felder wie Aktivierungsstatus, Gültigkeitszeiträume, Werte oder Einlösebedingungen geändert werden. Nach erfolgreicher Aktualisierung wird eine Bestätigung zurückgegeben.Schreibberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode ist derzeit noch nicht implementiert und für eine zukünftige Version geplant.
Diese Methode erstellt einen oder mehrere neue Gutscheine. Die Gutscheine können entweder einer neuen Charge zugeordnet oder an eine bestehende Charge angehängt werden. Damit eine neue Charge erstellt wird, muss das Feld chargeId im Request Body leer sein.Pro Anfrage können maximal 10.000 Gutscheine erstellt werden. Nach erfolgreicher Erstellung werden die zugehörige Charge-ID sowie die Anzahl der erzeugten Gutscheine zurückgegeben.Erstellberechtigungen für Gutschein-Daten sind erforderlich.
Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Erstellen von Gutschein-Daten.
400 Bad Request
Request body konnte nicht geladen werden.
400 Bad Request
”invalidFormat”
count ist keine Zahl. data ist kein Objekt.
400 Bad Request
”missing”
data fehlt. appendToCharge ist true, und chargeId fehlt.
400 Bad Request
”invalidValue”
count ∉ [1;10000]
400 Bad Request
”invalidCombination”
count ≠ 1 und voucherId ist nicht leer. Beim Erstellen von mehreren Gutscheinen wird die Id automatisch generiert und kann nicht manuell gesetzt werden. newCustomersOnly und existingCustomersOnly sind gesetzt.
400 Bad Request
”duplicateEntry”
voucherId oder chargeId existieren bereits.
400 Bad Request
”unknownDataField”
Ein unbekanntes Feld wurde im Request Body übergeben.
Diese Methode löscht einen bestehenden Gutschein anhand seiner eindeutigen ID.Nach erfolgreicher Löschung wird die ID des entfernten Gutscheins als Bestätigung zurückgegeben.Für die Ausführung sind Löschberechtigungen für Gutschein-Daten erforderlich.
Diese Methode ermöglicht das Erstellen oder Aktualisieren mehrerer Gutscheine in einem einzigen Request (Massenimport). Der Request Body muss ein JSON-Array enthalten, in dem jedes Element ein Objekt mit einem data-Feld ist, das die Gutscheindaten enthält.Pro Anfrage können maximal 10.000 Einträge übergeben werden. Ungültige Einträge werden übersprungen und in der Antwort unter skippedLines aufgeführt.Falls ein Gutschein mit derselben ID bereits existiert, wird geprüft, ob die Daten kompatibel sind. Mit dem Query-Parameter ?force kann ein Update erzwungen werden.Erstellberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode ermöglicht das Löschen mehrerer Gutscheine in einem einzigen Request. Der Request Body muss ein JSON-Array enthalten, in dem jedes Element ein Objekt mit der id des zu löschenden Gutscheins ist.Pro Anfrage können maximal 10.000 Einträge übergeben werden. Ungültige Einträge werden übersprungen und in der Antwort unter skippedItems aufgeführt.Löschberechtigungen für Gutschein-Daten sind erforderlich.
In diesem Abschnitt werden alle Endpunkte zur Verwaltung von Gutschein-Chargen beschrieben. Eine Gutschein-Charge ist eine Gruppe von Gutscheinen, die gemeinsam erstellt und verwaltet werden können.Über die Schnittstelle können Chargen aufgelistet, gefiltert, erstellt, aktualisiert, exportiert und gelöscht werden. Zudem können Ersteller-Informationen und Labels von bestehenden Chargen abgerufen werden.Für alle Operationen sind entsprechende Lese-, Schreib-, Erstell- oder Löschberechtigungen erforderlich.
Diese Methode liefert eine paginierte Liste aller im System vorhandenen Gutschein-Chargen.Über Filter- und Sortierparameter kann die Liste nach verschiedenen Kriterien eingeschränkt und geordnet werden. Die zurückgegebenen Daten enthalten Informationen zur Charge selbst sowie zu den zugehörigen Gutschein-Einstellungen.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode liefert eine Liste der Benutzerkonten mit Ids und E-Mails, die Gutschein-Chargen erstellt haben. Bei manuell angelegten Chargen entspricht der Name der E-Mail-Adresse des Benutzerkontos, bei importierten Chargen wird stattdessen “Import” angezeigt.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode liefert eine Liste aller vergebenen Labels für Gutschein-Chargen. Labels dienen der Kategorisierung von Chargen und werden bei der Volltextsuche berücksichtigt.Der Zugriff auf diese Informationen setzt Leseberechtigungen für Gutschein-Daten voraus.
Diese Methode aktualisiert die Eigenschaften einer bestehenden Gutschein-Charge anhand ihrer eindeutigen ID. Über den Request-Body können Felder wie Name, Beschreibung oder zusätzliche Labels geändert werden. Nach erfolgreicher Aktualisierung wird eine Bestätigung zurückgegeben.Schreibberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode ist derzeit noch nicht implementiert und für eine zukünftige Version geplant.
Diese Methode löscht eine bestehende Gutschein-Charge samt aller darin enthaltenen Gutscheine anhand der angegebenen Charge-ID. Nach erfolgreicher Löschung wird die ID der entfernten Charge als Bestätigung zurückgegeben.Für die Ausführung sind Löschberechtigungen für Gutschein-Daten erforderlich.
In diesem Abschnitt werden alle Endpunkte zur Verwaltung von Gutschein-Blaupausen (Templates) beschrieben. Gutschein-Blaupausen definieren vordefinierte Konfigurationen wie Rabatttypen, Gültigkeitszeiträume, Werte und weitere Bedingungen für Gutscheine. Über die Schnittstelle können Blaupausen erstellt, aktualisiert, abgerufen, gelöscht und mit Labels organisiert werden.Hinweis: Das Feld templateId entspricht intern der Spalte name in der Datenbank. Trotz dieser Zuordnung darf im Rahmen der API jedoch nicht nach name sortiert, gefiltert oder der Wert explizit abgefragt oder gesetzt werden. Alle Vorgänge erfolgen ausschließlich über templateId.Für alle Operationen sind entsprechende Lese-, Schreib-, Erstell- oder Löschberechtigungen erforderlich.
Diese Methode liefert eine paginierte Liste aller vorhandenen Gutschein-Blaupausen (Templates). Über Filter- und Sortierparameter kann die Liste eingeschränkt und geordnet werden. Die Blaupausen definieren Standardwerte für Gutscheine oder Gutschein-Chargen, die später auf Basis dieser Blaupausen erstellt werden können.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode liefert eine Liste aller vergebenen Labels, die bei Gutschein-Blaupausen (Templates) verwendet wurden. Labels dienen der Kategorisierung von Blaupausen und werden bei der Volltextsuche berücksichtigt.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode aktualisiert die Eigenschaften einer bestehenden Gutschein-Blaupausen (Template) anhand ihrer eindeutigen ID, wobei die ID dem Namen der Blaupause entspricht.Über den Request-Body können Felder wie Name, Status, Werte, Typen oder Labels angepasst werden. Nach erfolgreicher Aktualisierung wird die templateId der bearbeitete Blaupause zurückgegeben.Schreibberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode erstellt eine neue Gutschein-Blaupause (Template) anhand der übermittelten Konfigurationsdaten.Der Request-Body muss eine eindeutige templateId sowie ein data-Objekt mit den relevanten Gutscheineinstellungen enthalten. Nach erfolgreicher Erstellung wird die ID der neuen Blaupause zurückgegeben.Erstellberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode löscht eine bestehende Gutschein-Blaupause (Template) anhand ihrer eindeutigen ID, wobei die ID dem Namen der Blaupause entspricht. Nach erfolgreicher Löschung wird die templateId der entfernten Blaupause als Bestätigung zurückgegeben.Für die Ausführung sind Löschberechtigungen für Gutschein-Daten erforderlich.
In diesem Abschnitt werden alle Endpunkte zur Verwaltung von Gutschein-Vorlagen beschrieben.Im Gegensatz zu Gutschein-Blaupausen, die flexibel durch Benutzer erstellt und angepasst werden können, handelt es sich bei Gutschein-Vorlagen um standardisierte Strukturen, die bestimmte Typen oder Eigenschaften von Gutscheinen definieren. Vorlagen dienen als Basis für die Erstellung neuer Gutscheine nach festen Vorgaben und sind oft enger an das System gekoppelt.Über die Schnittstelle können diese Vorlagen abgerufen und bei Bedarf angepasst werden. Für alle Operationen sind entsprechende Lese- und Schreibberechtigungen erforderlich.Hinweis: Das Feld presetId entspricht intern der Spalte name in der Datenbank. Trotz dieser Zuordnung darf im Rahmen der API jedoch nicht nach name sortiert, gefiltert oder der Wert direkt abgefragt oder gesetzt werden. Alle Vorgänge erfolgen ausschließlich über presetId.
Diese Methode liefert eine paginierte Liste aller vorhandenen Gutschein-Vorlagen (Presets).Über Filter- und Sortierparameter kann die Liste nach Eigenschaften wie Systemstatus oder Erstellungsdatum eingeschränkt und geordnet werden.Die Vorlagen enthalten vordefinierte Einstellungen für die Erstellung neuer Gutscheine.Für den Zugriff sind Leseberechtigungen erforderlich.
Diese Methode liefert eine Liste aller vergebenen Labels, die bei Gutschein-Vorlagen (Presets) verwendet wurden. Labels dienen der Kategorisierung von Vorlagen und werden bei der Volltextsuche berücksichtigt.Für den Zugriff auf diese Informationen sind Leseberechtigungen erforderlich.
Diese Methode aktualisiert die Eigenschaften einer bestehenden Gutschein-Vorlage (Preset) anhand ihrer eindeutigen ID, wobei die ID dem Namen der Vorlage entspricht.Über den Request-Body werden die neuen Einstellungen der Vorlage übergeben, darunter Rabatttypen, Werte, Nutzungsbedingungen und weitere Attribute. Nach erfolgreicher Aktualisierung wird die ID der geänderten Vorlage zurückgegeben.Schreibberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode erstellt eine neue Gutschein-Vorlage (Preset) anhand der übermittelten Konfigurationsdaten.Der Request-Body muss eine eindeutige presetId sowie ein data-Objekt mit den relevanten Gutscheineinstellungen enthalten. Nach erfolgreicher Erstellung wird die ID der neuen Vorlage zurückgegeben.Erstellberechtigungen für Gutschein-Daten sind erforderlich.
Diese Methode löscht eine bestehende Gutschein-Vorlage (Preset) anhand ihrer eindeutigen ID, wobei die ID dem Namen der Vorlage entspricht. Nach erfolgreicher Löschung wird die ID der entfernten Vorlage als Bestätigung zurückgegeben.Für die Ausführung sind Löschberechtigungen für Gutschein-Daten erforderlich.
Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum KundenportalBitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.
