Entwickler-API

Gutschein bearbeiten

Diese API dient dazu, Informationen eines bereits erstellten Coupons zu bearbeiten.
Wurde der Coupon jedoch bereits verwendet, kann nur das Feld „Memo“ geändert werden; alle anderen Felder sind gesperrt.

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

Http Header

PUT /api/coupon/v1/update
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": ""
}

Felder	Feldbeschreibungen	Beschreibung	Typ
cpnNo	Gutscheincode	Der Gutscheincode, der geändert werden soll. Bitte ohne das Zeichen „-“ eingeben.	string
grpIdx	Gutschein-Gruppe	Gruppen dienen zur Verwaltung und Kategorisierung von Gutscheinen. Bei Konflikten zwischen Gruppen- und Gutschein-Einstellungen haben die Gruppen-Einstellungen Vorrang. Die Gruppen-ID kann im Gutschein-Gruppenbereich des Dashboards eingesehen werden. Standardwert: 0	int
tmplIdx	Gutschein-Vorlage	Vorlagen geben Nutzern Informationen wie Beschreibung, Gültigkeit, Einlösungsort und Hinweise. Die Vorlage-ID kann im Vorlagenbereich des Dashboards eingesehen werden. Standardwert: 0	int
nm	Gutscheinname	Der Name des Gutscheins, der auf der Gutscheindetailseite angezeigt wird.	string
discTypeIdx	Rabatt-Typ	Legt fest, ob es sich um einen prozentualen oder festen Rabatt handelt. 457: Prozentualer Rabatt (%), 458: Fester Betrag Prozentual: z. B. 10 % Rabatt Betrag: z. B. 5 € Rabatt	int
disc	Rabattwert	Bei Prozent-Rabatt (457): Wert zwischen 1 % und 100 % eingeben. Bei Betrags-Rabatt (458): Rabattbetrag eingeben.	double
discCurrency	Währung	Gültig nur bei Betrags-Rabatt (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Standardwert: KRW	string
strtYmd	Gültig ab	Startdatum der Gutschein-Gültigkeit. Datumsformat: yyyy-mm-dd (z. B. 2024-10-01)	date
endYmd	Gültig bis	Ablaufdatum des Gutscheins. Datumsformat: yyyy-mm-dd (z. B. 2024-12-31)	date
onsiteYn	Vor-Ort-Gutschein	Wenn auf „Y“ gesetzt, erscheint ein Button „Gutschein verwenden“ auf der Seite. Der Kunde zeigt den Gutschein dem Personal, das ihn einlöst – ideal für stationäre Geschäfte.	Y oder N
onsitePwd	Vor-Ort Passwort	Wird ein Passwort gesetzt, muss das Personal dieses eingeben, um den Gutschein als verwendet zu markieren. So wird verhindert, dass Kunden den Gutschein eigenständig einlösen.	string
memo	Notiz	Für interne Verwaltung gedacht. Diese Notiz ist für den Nutzer nicht sichtbar.	string
url	URL	Wenn eine URL angegeben ist, erscheint ein Button „Zum Gutschein nutzen“ auf der Seite. Wenn ein Bild hochgeladen wurde, kann auch darüber zur URL weitergeleitet werden.	string
useLimit	Verwendungslimit pro Person	Definiert, wie oft ein Benutzer diesen Gutschein verwenden darf. Bei Werten zwischen 2–5 ist die Nutzung der REST API von Vivoldi erforderlich und eine Benutzer-ID muss übergeben werden. Bei manueller Verwaltung im Dashboard ist nur „Unbegrenzt“ oder „1-mal“ erlaubt. 0: Unbegrenzt, 1: 1-mal, 2: 2-mal, 3: 3-mal, 4: 4-mal, 5: 5-mal	int
color	Textfarbe	Definiert die Farbe des Textes auf der Gutscheinseite. Im HEX-Format (z. B. #4F4F4FFF, inkl. Transparenz). Standardwert: #4F4F4FFF	string
background	Hintergrundfarbe	Legt die Hintergrundfarbe des Gutscheins auf der Seite fest. Im HEX-Format (z. B. #FFFFFFFF, inkl. Transparenz). Standardwert: #FFFFFFFF	string
userId	Benutzer-ID	Identifiziert, wem der Gutschein ausgestellt und von wem er verwendet wurde. Bei Verwendungslimit 2–5 Pflichtfeld. In der Regel ist dies die Login-ID des Nutzers auf Ihrer Website.	string
userNm	Name des Benutzers	Wenn bekannt ist, wer den Gutschein nutzen wird, kann hier der Name angegeben werden. Dient zur Nachverfolgung von Ausstellung und Nutzung.	string
userPhnno	Telefonnummer des Benutzers	Telefonnummer der Person, die den Gutschein nutzen wird.	string
userEml	E-Mail des Benutzers	E-Mail-Adresse der Person, die den Gutschein nutzen wird.	string
userEtc1	Zusätzliche Info 1	Dient zur Speicherung interner Zusatzinformationen über den Benutzer.	string
userEtc2	Zusätzliche Info 2	Dient zur Speicherung weiterer interner Zusatzinformationen über den Benutzer.	string

Response

{
	"code": 0,
	"message": "",
	"result": "ZJLF0399WQBEQZJM"
}

Felder	Beschreibung	Typ
code	Antwortcode (0:Erfolg)	int
message	Die Antwortnachricht oder eine zugehörige Nachricht, wenn der Antwortcode ungleich Null ist.	string