Promocode-Aktion aktualisieren

Promocode-Aktion aktualisierenServer-sideAdmin

put/v2/project/{project_id}/admin/promocode/{external_id}

Aktualisiert eine Promocode-Aktion.

SecuritybasicAuth

Request

path Parameters

project_id required	integer Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt. Example: 44056
external_id required	integer Promotion external ID. Unique promotion identifier within the project. Example: coupon_44056_1

Request Body schema: application/json

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 von Objekten 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

Array von Objekten 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.

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

204

Promocode wurde erfolgreich aktualisiert.

401

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

404

Promocode nicht gefunden. Stellen Sie sicher, dass die external_id korrekt ist.

422

Ungültige Anfrage.

Request samples

Response samples

application/json

{"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"statusCode": 401
}