Promocode-Aktion erstellen

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.

object or null

percent

string or null

Default: "10.00"

Prozentualer Rabatt. Der Preis des Warenkorbs wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.

Array of objects or null

Liste der Artikel, die durch einen Promocode rabattiert werden.

Array

sku

required

string

Default: "elven_shield"

Artikel-SKU.

required

object

percent

required

string

Default: "10.00"

Prozentualer Rabatt.

Der Preis des Artikels im Warenkorb wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.

excluded_promotions

Array of integers

Liste der IDs der Werbeaktionen, die bei der Anwendung dieser Werbeaktion ausgeschlossen werden sollen.
Example: [12, 789]

Array of objects or null

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf bestimmte Artikel im Warenkorb angewandt wird.
Der Preis der einzelnen Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden nur auf die Artikel im Warenkorb angewendet, deren Preis die Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items auf null setzen.

Array

operator

required

string

Vergleichsoperator zum Festlegen der Preisspanne für die Anwendung der Werbeaktion.

Enum:	Description
eq	Gleich
ge	Größer oder gleich
gt	Größer als
le	Kleiner oder gleich
lt	Kleiner als
ne	Ungleich

value

required

string^\d+(\.\d{1,4})?$

Wert zur Bestimmung der Preisspanne für die Anwendung der Werbeaktion.

Array of objects or null

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion auf den gesamten Warenkorb angewandt wird.
Der Gesamtpreis aller Artikel im Warenkorb des Nutzers wird mit der in der Bedingung angegebenen Preisspanne verglichen. Boni und Rabatte werden auf alle Artikel im Warenkorb angewandt, wenn die Warenkorbsumme die festgelegte Bedingung erfüllt.
Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Arrays discounted_items auf null setzen.

Array

operator

required

string

Vergleichsoperator zum Festlegen der Preisspanne für die Anwendung der Werbeaktion.

Enum:	Description
eq	Gleich
ge	Größer oder gleich
gt	Größer als
le	Kleiner oder gleich
lt	Kleiner als
ne	Ungleich

value

required

string^\d+(\.\d{1,4})?$

Wert zur Bestimmung der Preisspanne für die Anwendung der Werbeaktion.

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

Promocode 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

Response samples

application/json

{"external_id": "coupon_external_id"
}