Gutscheine

Beschreibung

Importieren von Gutscheinen zu einem vorher angelegten Gutschein im Backend.

Beim übermitteln wird der jeweilige Kundengutschein direkt dem Kunden zugestellt. Bedeutet das auch eine aktivierte Push-Nachricht in diesem Moment versendet wird.

Aufruf

URL: {$BASE-URL}/import/coupons
Methode: POST

Body

{
	"couponId": 1, // Pflichtfeld - Gutschein-ID aus gates Backend
	"coupons": [ // Pflichtfeld 
		{
			"number": 100001, // Pflichtfeld - Kundennummer
			"barcode": "1234567890", // Optional - Barcode-Inhalt
			"balance": 1.00, // Optional - Wert in EUR (Float)
			"validTill": "2024-12-31 23:59:59", // Optional - Gültig bis
			"externalId": 1, // Optional - Externe eindeutige Bezeichnung als INT
			"externalString": "0191de0b-a372-797d-94b0-55971cd0d9fc" // Optional - Externe eindeutige Bezeichnung als STRING
		}
	] 
}

validTill

Das optionale Feld "validTill" beeinflusst, wann der Gutschein für den jeweiligen Kunden ungültig wird. Ist das angegebene Datum später als das in der Gutscheindefinition festgelegte, wird der Gutschein beim Kunden gemäß der Gutscheindefinition deaktiviert.

externalId & externalString

Die optionalen Felder "externalId" oder "externalString" können übermittelt werden, um eine mehrfache Verteilung eines Gutscheins zu verhindern. Wird eine dieser Angaben gemacht, wird sie im System hinterlegt. Bei erneuter Übermittlung derselben Id oder desselben Strings wird kein neuer Kundengutschein erstellt, sondern der Vorgang übersprungen.

Antwort

HTTP-Code: 201

{
	"status": true,
	"date": "2024-01-01 23:59:59",
	"result": "Coupons imported"
}

Nicht gefundene Kunden oder nicht erstellte Gutscheine durch eine “externalId” oder eines “externalString” werden nicht zurück gemeldet. Die Verteilung wird im Hintergrund verarbeitet um eine schnelle Antwort der API zu erreichen.