Zum Inhalt springen
/
Belohnungskette aktualisi...

Shop Builder API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/shop-builder/
https://store.xsolla.com/api/

Verwaltung

Operationen

Personalisierter Katalog

Diese API ermöglicht es, Regeln für Benutzerattribute festzulegen. Wenn der Nutzer alle Bedingungen einer konkreten Regel erfüllt, werden personalisierte Artikel angezeigt.

Für personalisierte Werbeaktionen siehe Abschnitt Werbeaktionen.

Um Attribute vor einem Kauf zu übermitteln, können Sie die Xsolla Login API verwenden oder die Attribute in der Eigenschaft user.attributes übermitteln, während Sie den Token mit der Pay Station API generieren.

Operationen

Verwaltung

Operationen

Katalog

Operationen

Warenkorb (clientseitig)

Operationen

Warenkorb (serverseitig)

Operationen

Zahlung (clientseitig)

Operationen

Zahlung (serverseitig)

Operationen

Bestellung

Operationen

Kostenlose Artikel

Operationen

Webhooks

Operationen

Vorbestellungen

Operationen

Händler

Operationen

Katalog

Diese API ermöglicht es, jede Art von verkäuflichen oder bestimmten Artikeln zu erhalten.

Operationen

Gängige Regionen

Operationen

Katalog

Operationen

Berechtigung

Operationen

Verwaltung

Operationen

Allgemeines

Operationen

Gutscheine

Mit dieser API können Sie Gutscheine verwalten.

Operationen

Promocodes

Diese API ermöglicht die Verwaltung von Promocodes.

Operationen

Katalogsonderangebote

Mit dieser API können Sie Katalogsonderangebote verwalten.

Operationen

Rabatte

Mit dieser API können Sie Rabattaktionen verwalten.

Operationen

Boni

Diese API ermöglicht die Verwaltung von Bonusaktionen.

Operationen

Verwaltung

Operationen

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Belohnungskette abrufenServer-sideAdmin

Anfrage

Ruft eine bestimmte Belohnungskette ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/reward_chain/id/101

Antworten

Die angegebene Belohnungskette wurde erfolgreich empfangen.

Bodyapplication/json
One of:

Eine Belohnungskette.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(chain_user-attribute_conditions_model-get)[ 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.

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

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:

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.

image_urlstring or null(image_url)

Bild-URL.

Beispiel: "https://image.example.com"
is_always_visibleboolean(chain_is_always_visible)

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.

Standard true
Beispiel: true
is_enabledboolean(is_enabled)
Beispiel: true
is_reset_after_endboolean(is_reset_after_end)

Ob die Belohnungskette (Wertpunkte und Fortschritt aller Nutzer) nach dem Enddatum zurückgesetzt wird:

  • Wenn true festgelegt ist, wird die Belohnungskette nach dem Enddatum zurückgesetzt.
  • Wenn false festgelegt ist, wird die Belohnungskette nach dem Enddatum nicht zurückgesetzt.

Hinweis

true ist nicht möglich, wenn:
  • in recurrent_schedule ein Zeitraum für das Zurücksetzen angegeben ist.
  • der Wert null im Parameter periods.date_until übermittelt wird.
Standard false
Beispiel: false
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

Objekt mit Lokalisierungen für lange 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 Varianten 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.

Any of:

Objekt mit Lokalisierungen für lange 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 Varianten 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.

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

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:

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.

orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
periodsArray of objects(periods)

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

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

Wiederkehrender Reset-Zeitraum der Belohnungskette.

One of:

Belohnungskette wird wöchentlich zurückgesetzt.

reward_chain_idinteger(reward_chain_id)

Eindeutige ID der Belohnungskette.

Beispiel: 9
stepsArray of objects(reward_step_short)
value_pointobject
Antwort
application/json
{
  "clan_type": "guild",
  "description": {
    "en": "Clan reward chain description."
  },
  "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
  "is_enabled": true,
  "long_description": {
    "en": "Clan reward chain long description."
  },
  "name": {
    "en": "Clan reward chain"
  },
  "order": 1,
  "periods": [
    { … }
  ],
  "popup_header": {
    "en": "How to unlock rewards"
  },
  "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
  "popup_instruction": {
    "en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
  },
  "recurrent_schedule": {
    "day_of_week": 2,
    "displayable_reset_next_date": "2023-03-07T11:00:00+08:00",
    "displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
    "interval_type": "weekly",
    "reset_next_date": 1677553200,
    "time": "11:00:00+08:00"
  },
  "reward_chain_id": 1,
  "steps": [
    { … },
    { … }
  ],
  "value_point": {
    "description": { … },
    "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
    "is_clan": true,
    "is_enabled": true,
    "long_description": { … },
    "media_list": [],
    "name": { … },
    "order": 1,
    "sku": "com.xsolla.clan_value_point_1"
  }
}

Belohnungskette aktualisierenServer-sideAdmin

Anfrage

Aktualisiert eine bestimmte Belohnungskette.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
Bodyapplication/json
One of:

Eine Belohnungskette.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(chain_user-attribute_conditions_model-post)[ 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.

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

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:

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.

image_urlstring or null(image_url)

Bild-URL.

Beispiel: "https://image.example.com"
is_always_visibleboolean(chain_is_always_visible)

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.

Standard true
Beispiel: true
is_enabledboolean(is_enabled)erforderlich
Beispiel: true
is_reset_after_endboolean(is_reset_after_end)

Ob die Belohnungskette (Wertpunkte und Fortschritt aller Nutzer) nach dem Enddatum zurückgesetzt wird:

  • Wenn true festgelegt ist, wird die Belohnungskette nach dem Enddatum zurückgesetzt.
  • Wenn false festgelegt ist, wird die Belohnungskette nach dem Enddatum nicht zurückgesetzt.

Hinweis

true ist nicht möglich, wenn:
  • in recurrent_schedule ein Zeitraum für das Zurücksetzen angegeben ist.
  • der Wert null im Parameter periods.date_until übermittelt wird.
Standard false
Beispiel: false
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

Objekt mit Lokalisierungen für lange 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 Varianten 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.

Any of:

Objekt mit Lokalisierungen für lange 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 Varianten 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.

name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)erforderlich

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:

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.

name.​arstring or null

Arabisch

name.​bgstring or null

Bulgarisch

name.​cnstring or null

Chinesisch (vereinfacht)

name.​csstring or null

Tschechisch

name.​destring or null

Deutsch

name.​enstring or null

Englisch

name.​esstring or null

Spanisch (Spanien)

name.​frstring or null

Französisch

name.​hestring or null

Hebräisch

name.​idstring or null

Indonesisch

name.​itstring or null

Italienisch

name.​jastring or null

Japanisch

name.​kmstring or null

Khmer

name.​kostring or null

Koreanisch

name.​lostring or null

Laotisch

name.​mystring or null

Birmanisch

name.​nestring or null

Nepalesisch

name.​phstring or null

Filipino

name.​plstring or null

Polnisch

name.​ptstring or null

Portugiesisch

name.​rostring or null

Rumänisch

name.​rustring or null

Russisch

name.​thstring or null

Thai

name.​trstring or null

Türkisch

name.​twstring or null

Chinesisch (traditionell)

name.​vistring or null

Vietnamesisch

orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
periodsArray of objects(periods)erforderlich

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

periods[].​date_fromstring(date-time)erforderlich

Startdatum für die angegebene Belohnungskette.

Beispiel: "2020-08-11T10:00:00+03:00"
periods[].​date_untilstring or null(date-time)

Enddatum für die angegebene Belohnungskette. Kann nur dann null sein, wenn eine einziger Gültigkeitszeitraum angegeben ist.

Beispiel: "2020-08-11T20:00:00+03:00"
recurrent_schedule(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))(recurrent_schedule_create_update)

Wiederkehrender Reset-Zeitraum der Belohnungskette.

One of:

Belohnungskette wird wöchentlich zurückgesetzt.

stepsArray of objects(modify_reward_step)erforderlich
steps[].​image_urlstring or null(image_url)

Bild-URL.

Beispiel: "https://image.example.com"
steps[].​name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)erforderlich

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:

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.

steps[].​name.​arstring or null

Arabisch

steps[].​name.​bgstring or null

Bulgarisch

steps[].​name.​cnstring or null

Chinesisch (vereinfacht)

steps[].​name.​csstring or null

Tschechisch

steps[].​name.​destring or null

Deutsch

steps[].​name.​enstring or null

Englisch

steps[].​name.​esstring or null

Spanisch (Spanien)

steps[].​name.​frstring or null

Französisch

steps[].​name.​hestring or null

Hebräisch

steps[].​name.​idstring or null

Indonesisch

steps[].​name.​itstring or null

Italienisch

steps[].​name.​jastring or null

Japanisch

steps[].​name.​kmstring or null

Khmer

steps[].​name.​kostring or null

Koreanisch

steps[].​name.​lostring or null

Laotisch

steps[].​name.​mystring or null

Birmanisch

steps[].​name.​nestring or null

Nepalesisch

steps[].​name.​phstring or null

Filipino

steps[].​name.​plstring or null

Polnisch

steps[].​name.​ptstring or null

Portugiesisch

steps[].​name.​rostring or null

Rumänisch

steps[].​name.​rustring or null

Russisch

steps[].​name.​thstring or null

Thai

steps[].​name.​trstring or null

Türkisch

steps[].​name.​twstring or null

Chinesisch (traditionell)

steps[].​name.​vistring or null

Vietnamesisch

steps[].​priceobject(reward_step_price)erforderlich
steps[].​price.​amountinteger(step_price_amount)erforderlich

Stufenpreis in Wertpunkten.

Beispiel: 100
steps[].​rewardArray of objectserforderlich
steps[].​reward[].​attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(reward-chain-step-reward_user-attribute_conditions_model-post)[ 1 .. 100 ] items

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

steps[].​reward[].​quantityinteger(reward_item_quantity)erforderlich

Artikelmenge.

Beispiel: 2
steps[].​reward[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$erforderlich

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "booster_mega_1"
steps[].​step_idinteger or null(step_id)erforderlich

ID des eindeutigen Schritts.

Beispiel: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/reward_chain/id/101 \
  -H 'Content-Type: application/json' \
  -d '{
    "clan_type": "guild",
    "description": {
      "en": "Clan reward chain description."
    },
    "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
    "is_enabled": true,
    "long_description": {
      "en": "Clan reward chain long description."
    },
    "name": {
      "en": "Clan reward chain"
    },
    "order": 1,
    "periods": [
      {
        "date_from": "2026-01-01T01:00:00+05:00",
        "date_until": "2026-01-31T23:59:59+05:00"
      },
      {
        "date_from": "2026-02-01T01:00:00+05:00",
        "date_until": "2026-02-28T23:59:59+05:00"
      }
    ],
    "popup_header": {
      "en": "How to unlock rewards"
    },
    "popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
    "popup_instruction": {
      "en": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan."
    },
    "recurrent_schedule": {
      "day_of_week": 1,
      "interval_type": "weekly",
      "time": "01:00:00+08:00"
    },
    "steps": [
      {
        "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
        "name": {
          "en": "First step of the reward chain"
        },
        "price": {
          "amount": 10
        },
        "reward": [
          {
            "quantity": 5,
            "sku": "com.xsolla.item_1"
          },
          {
            "quantity": 1,
            "sku": "com.xsolla.item_2"
          }
        ],
        "step_id": 1
      },
      {
        "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
        "name": {
          "en": "Second step of the reward chain"
        },
        "price": {
          "amount": 15
        },
        "reward": [
          {
            "quantity": 5,
            "sku": "com.xsolla.item_3"
          },
          {
            "quantity": 1,
            "sku": "com.xsolla.item_4"
          }
        ],
        "step_id": 2
      }
    ]
  }'

Antworten

Die Belohnungskette wurde erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Belohnungskette zurücksetzenServer-sideAdmin

Anfrage

Setzt die Wertpunkte und den Fortschritt aller Nutzer in der Belohnungskette zurück.
Nach dem Zurücksetzen können Sie den Gültigkeitszeitraum der Belohnungskette aktualisieren und der Nutzer kann sie erneut durchlaufen.

Hinweis

Sie sollten die Belohnungskette während ihrer Gültigkeitsdauer nicht zurücksetzen, weil die Nutzer ansonsten verdiente Wertpunkte möglicherweise verlieren, bevor sie ihre Belohnung in Anspruch nehmen können.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/reward_chain/id/101/reset

Antworten

Die Belohnungskette wurde zurückgesetzt.

Body
Antwort
Kein Inhalt

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen