Promocode-Aktion erstellen

Promocode-Aktion erstellenServer-sideAdmin

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

Erstellt eine Promocode-Aktion.

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 type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

Bedingungen, die mit Benutzerattributwerten verglichen werden. Alle Bedingungen müssen erfüllt sein, damit die Aktion greift.

One of:

Bedingungen, die mit Benutzerattributwerten verglichen werden. Alle Bedingungen müssen erfüllt sein, damit die Aktion greift.

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

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.

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.

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

Array of objects with conditions that set the price range for applying the promotion to certain items in the cart.
The price of each item in the user's cart is compared with the price range specified in the condition. Bonuses and discounts are applied only to those items in the cart whose price meets the condition.
If you pass this array, set the value of the discounted_items array to null.

Array

operator

required

string

Comparison operator for setting the price range for applying the promotion.

Enum:	Description
eq	Gleich
ge	Greater or equal
gt	Greater than
le	Less or equal
lt	Less than
ne	Ungleich

value

required

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

Value for determining the price range for applying the promotion.

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion to the entire cart.
The total price of all items in the user's cart is compared with the price range specified in the condition. Bonuses and discounts are applied to all items in the cart if the price of the cart meets the specified condition.
If you pass this array, set the value of the discounted_items array to null.

Array

operator

required

string

Comparison operator for setting the price range for applying the promotion.

Enum:	Description
eq	Gleich
ge	Greater or equal
gt	Greater than
le	Less or equal
lt	Less than
ne	Ungleich

value

required

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

Value for determining the price range for applying the promotion.

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

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"
}