Angebotskette erstellen

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

date_start

required

string <date-time>

Datum, an dem die Angebotskette beginnt.

required

Array of objects

Array

step_number

required

integer >= 1

Schrittnummer.

is_free

required

boolean

Gibt an, ob der Angebotskettenschritt kostenlos ist:

Wenntrue festgelegt ist, muss der Schritt mit dem Aufruf Kostenlosen Angebotskettenschritt sichern in Anspruch genommen werden.
Wenn false festgelegt ist, muss er über den Aufruf Bestellung für kostenpflichtigen Angebotskettenschritt anlegen erworben werden.

required

Array of objects non-empty

Array (non-empty)

sku required	string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$ Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
quantity required	integer >= 1 Menge der Belohnungsartikel für diesen Kettenschritt.
order	integer or null >= 0 Belohnungsreihenfolge für den Angebotskettenschritt.

is_enabled

required

boolean

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 Kette 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.

date_end

string or null <date-time>

Datum, an dem die Angebotskette endet. Kann null sein. Wenn für date_end der Wert null festgelegt ist, ist die Angebotskette zeitlich unbegrenzt.

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

is_always_visible

boolean

Default: true

Ob die Kette für alle Nutzer sichtbar ist:

Wenn true festgelegt ist, wird die Kette immer angezeigt, unabhängig vom Authentifizierungsstatus oder den Attributen des Nutzers.
Wenn false festgelegt ist, wird die Kette nur dann angezeigt, wenn keine personalisierte Kette gefunden wird. Zum Beispiel, wenn der Nutzer nicht authentifiziert ist oder für seine Attribute keine personalisierte Kette vorliegt.

Gilt nur im Rahmen personalisierter Ketten und kommt zum Einsatz, wenn das Array attribute_conditions nicht übermittelt wird.

order

integer

Definiert die Anordnungsreihenfolge.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))

Reset-Zeitraum der Angebotskette.

One of:

Angebotskette wird wöchentlich zurückgesetzt.

interval_type required	string Wie oft die Angebotskette zurückgesetzt wird. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Der Zeitpunkt, zu dem die Angebotskette in der angegebenen Zeitzone zurückgesetzt wird (auf Stunden gerundet). Beispielsweise erfolgt die Zurücksetzung um 01:00 Uhr malaysischer Zeit (GMT+8); der Wert des Parameters `time` lautet in diesem Fall: `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] Wochentag, an dem die Angebotskette zurückgesetzt wird, wobei `1` für Montag und `7` für Sonntag steht.

Responses

201

Die Angebotskette 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 Angebotskettenkonfiguration.

Request samples

application/json

{"date_end": null,
"date_start": "2023-04-15T18:16:00+05:00",
"description": {"de": "Eine kurze Beschreibung einer regulären Angebotskette",
"en": "A short description of a regular offer chain",
"fr": "Une brève description d'une chaîne d'offres régulière",
"it": "Una breve descrizione di una catena di offerte regolare",
"ru": "Краткое описание обычной цепочки предложений"
},
"is_always_visible": true,
"is_enabled": true,
"name": {"de": "Neue Angebotskette",
"en": "New offer chain",
"fr": "Nouvelle chaîne d'offres",
"it": "Nuova catena di offerte",
"ru": "Новая цепочка предложений"
},
"order": 4,
"recurrent_schedule": null,
"steps": [{"is_free": false,
"items": [{"quantity": 2,
"sku": "chain_step_1_paid_bundle_sku"
}
],
"step_number": 1
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_2_free_virtual_good_sku"
}
],
"step_number": 2
},
{"is_free": false,
"items": [{"quantity": 5,
"sku": "chain_step_3_paid_virtual_currency_package_sku"
}
],
"step_number": 3
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "chain_step_4_free_bundle_sku"
}
],
"step_number": 4
}
]
}

Response samples

application/json

{"offer_chain_id": 10
}