Xsolla-logo
oder
Zum Kundenportal

Gutscheinaktionen erstellenServer-sideAdmin

post/v3/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 Klein- und Großbuchstaben, Ziffern, 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 type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

Bedingungen für die Validierung von Nutzerattributen. Steuert die Verfügbarkeit der Werbeaktion basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.

Array ([ 1 .. 100 ] items)
One of:
attribute
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Benutzerattributcode.

operator
required
string

Art der durchgeführten Operation nach Bedingung. Für den Attributtyp string.

Enum: Description
eq

Gleich

ne

Ungleich

value
required
string <= 255 characters

Bedingungswert, mit dem der Benutzerattributwert verglichen wird. Der Typ hängt vom Attributtyp ab.

type
required
string

Benutzerattributtyp.

Value: "string"
can_be_missing
boolean

Gibt an, dass die Bedingung erfüllt ist, auch wenn das Attribut in den Benutzerattributen fehlt. Übermitteln Sie true, um den Artikel den Nutzern anzuzeigen, die dieses Attribut nicht haben. Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt, sehen den Artikel nicht. false – Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt oder bei denen das Attribut fehlt, sehen den Artikel nicht.

Array of objects or null
Array
quantity
number
Default: 1

Artikelmenge.

sku
string
Default: "elven_shield"

Artikel-SKU.

Array of objects

Gültigkeitszeitraum der Werbeaktion. Wenn mehrere Zeiträume angegeben sind, sind sowohl date_from als auch date_until erforderlich.

Array
date_from
required
string <date-time>

Startdatum für die angegebene Werbeaktion.

date_until
string or null <date-time>

Enddatum für die angegebene Werbeaktion. Wenn null festgelegt ist, läuft die Werbeaktion unbefristet. Kann nur null sein, wenn ein einzelner Gültigkeitszeitraum angegeben ist.

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 Nutzer 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
{
  • "attribute_conditions": [
    ],
  • "bonus": [
    ],
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "promotion_periods": [
    ],
  • "redeem_code_limit": 1,
  • "redeem_total_limit": 100,
  • "redeem_user_limit": 1
}
Response samples
application/json
{
  • "external_id": "coupon_external_id"
}