Gutscheinaktionen erstellen

Gutscheinaktionen erstellenServer-sideAdmin

post/v2/project/{project_id}/admin/coupon

Erstellt eine Gutscheinaktion.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.

property name*

additional property

string

Array of objects or null

Array

quantity	number Default: 1 Artikelmenge.
sku	string Default: "elven_shield" Artikel-SKU.

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Datum, an dem Ihre Werbeaktion endet. Möglich ist null. Wenn für date_end der Wert null festgelegt ist, läuft die Werbeaktion zeitlich unbegrenzt.

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Datum, an dem Ihre Werbeaktion beginnt.

redeem_code_limit

integer or null

Default: 10

Anzahl der Einlösungen pro Code.

redeem_total_limit

integer or null

Default: 10

Begrenzt die Gesamtzahl der Gutscheine.

redeem_user_limit

integer or null

Default: 10

Begrenzt, wie oft ein einzelner Benutzer Gutscheine einlösen darf.

Responses

201

Gutschein wurde erfolgreich erstellt.

401

Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.

422

Ungültige Anfrage.

Request samples

application/json

{"bonus": [{"quantity": 1,
"sku": "elven_shield"
}
],
"date_end": "2020-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_external_id",
"name": {"de-DE": "Gutscheintitel",
"en-US": "Coupon title"
},
"redeem_code_limit": 10,
"redeem_total_limit": 10,
"redeem_user_limit": 10
}

Response samples

application/json

{"coupon_id": "coupon_external_id"
}