Startseite
Service-Info
Entwickler-API
Preise · Tarife
Online-Gutscheine
Über Webpush

Gutschein erstellen

Diese API ermöglicht das Erstellen von Rabattcoupons.
Um mehrere Coupons gleichzeitig zu erstellen, verwenden Sie bitte das Dashboard.

Das Hochladen von Coupon-Bildern ist über die API nicht möglich.
Wenn Sie Bilder benötigen, erstellen Sie zunächst eine Coupon-Gruppe im Dashboard und laden Sie das Bild dort hoch. Geben Sie dann die Gruppe beim Erstellen des Coupons an.

Wenn eine Coupon-Gruppe angegeben ist, werden einige Einstellungen des Coupons durch die Gruppeneinstellungen überschrieben.

Diese API ist ab dem Personal-Tarif verfügbar.

Http Header 
POST /api/coupon/v1/create
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request 
{
	"cpnNo": "",  // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
	"grpIdx": 271,
	"tmplIdx": 0,
	"nm": "$5 discount coupon",
	"discTypeIdx": 458,
	"disc": 5,
	"strtYmd": "2025-01-01",
	"endYmd": "2025-12-31",
	"onsiteYn": "Y",
	"onsitePwd": "123456",
	"memo": "New Member Registration, IP: 211.111.222.33",
	"url": "https://bestshop.com",
	"useLimit": 1,
	"userId": "att78z",
	"userNm": "Brown Smith",
	"userPhnno": "+1 123-4567-8900",
	"userEml": "",
	"userEtc1": "Gold rating",
	"userEtc2": ""
}
FelderFeldbeschreibungenBeschreibungErforderlichTyp
cpnNo Eine 8 bis 16-stellige Gutscheinnummer aus Großbuchstaben und Zahlen. Sonderzeichen sind nicht erlaubt.
Wenn kein Wert eingegeben wird, wird die Gutscheinnummer vom System automatisch generiert. 		string
grpIdx Gruppencoupons werden zur Verwaltung und Kategorisierung von Gutscheinen verwendet. Bei Überschneidung hat die Einstellung des Coupons Vorrang.
Die Gruppen-ID findest du auf der Gutschein-Gruppen-Seite im Dashboard.
Standardwert: 0 		int
tmplIdx Vorlagen geben an, wofür der Gutschein ist, wie er verwendet wird und welche Hinweise gelten.
Die Template-ID findest du auf der Vorlagenseite für Gutscheine im Dashboard.
Standardwert: 0 		int
nm Der Name des Gutscheins wird auf der Gutscheinseite angezeigt. string
discTypeIdx Lege den Rabatt-Typ (Prozentsatz oder Betrag) fest.
457: Prozent-Rabatt (%), 458: Betrag-Rabatt
Prozent-Rabatt: für prozentuale Rabatte.
Betrag-Rabatt: für Rabatte mit festen Beträgen. 		int
disc Gib bei Prozent-Rabatt (457) einen Wert zwischen 1% und 100% ein.
Gib bei Betrag-Rabatt (458) den Rabattbetrag ein. 		double
discCurrency Lege die Währung fest, wenn du einen Betrag-Rabatt (458) verwendest.
KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD
Standardwert: KRW 		string
strtYmd Lege das Startdatum für die Gültigkeit des Gutscheins fest.
10-stelliges Datum im Format jjjj-mm-tt.
Beispiel: 2024-10-01 		date
endYmd Lege das Ablaufdatum des Gutscheins fest.
10-stelliges Datum im Format jjjj-mm-tt.
Beispiel: 2024-12-31 		date
onsiteYn Wenn der Wert Y ist, wird auf der Gutscheinseite ein Button zum Einlösen angezeigt.
Der Nutzer zeigt den Gutschein im Laden vor und das Personal löst ihn ein.
Ideal für Filialgeschäfte.
Standardwert: N 		Y or N
onsitePwd Wenn du ein Passwort festlegst, muss das Personal dieses beim Einlösen eingeben.
Der Nutzer kann den Gutschein nicht selbst einlösen. 		string
memo Für interne Verwaltung der Gutscheine verwendbar.
Nicht für Nutzer sichtbar. 		string
url Nach Eingabe einer URL erscheint auf der Gutscheinseite der Button „Gutschein einlösen“, der auf die hinterlegte URL verweist.
Ist ein Gutscheinbild hinterlegt, führt auch ein Klick auf das Bild zur URL. 		string
useLimit Lege die maximale Anzahl Einlösungen pro Person fest.
Bei Nutzung der REST API von Vivoldi ist für Werte zwischen 2 und 5 die Nutzer-ID Pflicht.
Im Dashboard kannst du „Unbegrenzt“ oder „1-mal“ wählen.
Bei „Unbegrenzt“ kann der Gutschein beliebig oft eingelöst werden.
0: Unbegrenzt, 1: 1-mal, 2: 2-mal, 3: 3-mal, 4: 4-mal, 5: 5-mal 		int
color Farbe des Gutscheintextes auf der Seite.
HEX-Wert mit bis zu 9 Stellen inkl. Transparenz.
Standardwert: #4F4F4FFF 		string
background Hintergrundfarbe des Gutscheins auf der Seite.
HEX-Wert mit bis zu 9 Stellen inkl. Transparenz.
Standardwert: #FFFFFFFF 		string
userId Dient zur Verwaltung, wer Gutscheine ausgestellt und eingelöst hat.
Bei einer Begrenzung von 2 bis 5 ist die Nutzer-ID Pflicht.
Meist ist das die Login-ID des Nutzers. 		string
userNm Wenn der Empfänger des Gutscheins bekannt ist, gib hier den Namen an.
Dient zur Nachverfolgung von Ausgabe und Einlösung. 		string
userPhnno Kontakt des Nutzers, der den Gutschein einlöst. string
userEml E-Mail-Adresse des Nutzers, der den Gutschein einlöst. string
userEtc1 Zusätzliche Nutzerinformationen für die interne Verwaltung. string
userEtc2 Zusätzliche Nutzerinformationen für die interne Verwaltung. string
 
Response 
{
	"code": 0,
	"message": "",
	"result": "ZJLF0399WQBEQZJM"
}
FelderBeschreibungTyp
codeAntwortcode (0:Erfolg)int
messageDie Antwortnachricht oder eine zugehörige Nachricht, wenn der Antwortcode ungleich Null ist.string
resultAntwortwert (Coupon-Nummer)string