Gutschein erstellen

Diese API ermöglicht das Erstellen von Rabattcoupons.

Um mehrere Coupons gleichzeitig zu erstellen, verwenden Sie bitte das Dashboard.

Coupon-Bilder können nicht über die API hochgeladen werden.
Wenn ein Bild benötigt wird, erstellen Sie zuerst eine Coupon-Gruppe im Dashboard, laden Sie dort das Bild hoch und ordnen Sie die Gruppe dann bei der Erstellung des Coupons zu.

Diese API ist in Personal-Tarifen oder höher verfügbar.

POST

/api/coupon/v1/create 

{
    "cpnNo": "",  // If left empty, a 16-character code will be generated automatically by the system.
    "nm": "$5 discount coupon",
    "discTypeIdx": 458,
    "disc": 5,
    "discCurrency": "USD",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "useLimit": 1,
    "grpIdx": 271,
    "tmplIdx": 0,
    "onsiteYn": "Y",
    "onsitePwd": "123456",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "url": "https://bestshop.com",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cpnNostring
Coupon-Nummer. 8–16 alphanumerische Zeichen. Wenn kein Wert angegeben ist, wird sie automatisch vom System generiert. Sonderzeichen sind nicht erlaubt.
Beispiel: V5H8GR5T
nmstringrequired
Coupon-Name.
discTypeIdxintegerrequired
Rabatt-Typ. (457: Prozentsatz %, 458: Fester Betrag)
discdoublerequired
Für Prozentsatz (457): Bereich von 1–100%. Für festen Betrag (458): Betrag eingeben.
discCurrencystring
Währungseinheit. Pflichtfeld bei Verwendung eines festen Betragsrabattes (discTypeIdx:458).
strtYmddaterequired
Startdatum der Coupon-Gültigkeit. Beispiel: 2024-10-01
endYmddaterequired
Ablaufdatum des Coupons. Beispiel: 2024-12-31
Das Ablaufdatum kann nur bis zum 31. Dezember des folgenden Jahres festgelegt werden.
useLimitintegerrequired
Nutzungsbeschränkung für den Coupon. (0: Unbegrenzt, 1–5: Nutzungsanzahl)
Wenn 2 oder mehr angegeben sind, muss userId zwingend angegeben werden.
grpIdxinteger
Coupon-Gruppe. Wird verwendet, um Coupons in Gruppen zu verwalten. Die Gruppen-ID (IDX) kann im Dashboard eingesehen werden.
Wenn Gruppeneinstellungen und Coupon-Einstellungen überschneiden, haben die Gruppeneinstellungen Vorrang.
tmplIdxinteger
Coupon-Vorlage. Wird beim Erstellen eines Coupons als Referenz verwendet. Die Vorlagen-ID (IDX) kann im Dashboard eingesehen werden.
onsiteYnstring
Vor-Ort-Coupon. Zeigt die Schaltfläche „Coupon einlösen“ auf der Coupon-Seite an.
Erforderlich, wenn Mitarbeiter in einem Offline-Shop den Coupon einlösen.
onsitePwdstring
Passwort für Vor-Ort-Coupon. Erforderlich bei der Nutzung des Coupons.
memostring
Interne Notiz für Referenzzwecke.
urlstring
Wenn eine URL eingegeben wird, erscheint auf der Coupon-Seite eine Schaltfläche „Zum Einlösen gehen“.
Beim Klicken auf die Schaltfläche oder das Bild wird auf die URL weitergeleitet.
colorstring
Schriftfarbe des Coupons. HEX-Wert eingeben. Beispiel: #4F4F4F
backgroundstring
Hintergrundfarbe des Coupons. HEX-Wert eingeben. Beispiel: #FFFFFF
userIdstring
Wird verwendet, um den Empfänger des Coupons zu verwalten.
Pflichtfeld, wenn die Nutzungsbeschränkung auf 2–5 festgelegt ist. Normalerweise die Login-ID oder der Name des Benutzers.
userNmstring
Name des Coupon-Nutzers. Für interne Verwaltung.
userPhnnostring
Telefonnummer des Coupon-Nutzers. Für interne Verwaltung.
userEmlstring
E-Mail des Coupon-Nutzers. Für interne Verwaltung.
userEtc1string
Zusätzliches internes Verwaltungsfeld.
userEtc2string
Zusätzliches internes Verwaltungsfeld. 
{
    "code": 0,
    "message": "",
    "result": "ZJLF0399WQBEQZJM"
}

Response Parameters

codeinteger
Antwortcode: 0 = Erfolg, andere Werte = Fehler
messagestring
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
resultstring
Antwortwert. Die generierte Coupon-Nummer wird zurückgegeben.
Beispiel: ZJLF0399WQBEQZJM