Zum Inhalt springen
/
Bonusaktion aktualisieren

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

Bonusaktion abrufenServer-sideAdmin

Anfrage

Ruft die Bonusaktion ab.

Die Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel. Die Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
promotion_idintegererforderlich

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

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

Antworten

Bonusaktion wurde erfolgreich empfangen.

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

bonusArray of objects or null
conditionArray of objects or null

Die zu kaufenden Artikel, damit eine Werbeaktion greifen kann. Ist dieser Parameter auf null gestellt, greift die Werbeaktion bei allen Käufen innerhalb eines Projekts.

excluded_promotionsArray of integers(excluded_promotions)

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

Beispiel: [12,789]
idinteger

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

is_enabledboolean
Standard true
limitsobject(Promotions_promotion_limits_response)

Werbebeschränkungen.

nameobject

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.

Beispiel: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
price_conditionsArray of objects or null(price_conditions_bonus)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion angewandt wird.
Die Aktion wird nur auf Artikel angewandt, deren Preis alle in dem Array aufgelisteten Bedingungen erfüllt. Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Objekts condition auf null setzen.

promotion_periodsArray of objects(promotion_periods)

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

Antwort
application/json
{
  "bonus": [
    { … },
    { … },
    { … }
  ],
  "condition": [
    { … },
    { … }
  ],
  "excluded_promotions": [
    23,
    45
  ],
  "id": 1,
  "is_enabled": true,
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": { … }
  },
  "name": {
    "de-DE": "Neujahrsbonus",
    "en-US": "New Year Bonus"
  },
  "price_conditions": [
    { … },
    { … }
  ],
  "promotion_periods": [
    { … }
  ]
}

Bonusaktion aktualisierenServer-sideAdmin

Anfrage

Aktualisiert die Werbeaktion.

Hinweis

Neue Daten ersetzen alte Daten. Auch wenn Sie nur einen Teil einer Werbeaktion aktualisieren möchten, sollten Sie alle erforderlichen Daten in der Anfrage übermitteln.

Die Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel. Die Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
promotion_idintegererforderlich

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: 111425
Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 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.

bonusArray of objects or nullerforderlich
bonus[].​quantitynumber

Artikelmenge.

Standard 1
bonus[].​skustring

Artikel-SKU.

Standard "elven_shield"
conditionArray of objects or nullerforderlich

Die zu kaufenden Artikel, damit eine Werbeaktion greifen kann. Ist dieser Parameter auf null gestellt, greift die Werbeaktion bei allen Käufen innerhalb eines Projekts.

condition[].​skustring

Artikel-SKU.

Standard "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

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

Beispiel: [12,789]
idinteger

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

is_enabledboolean(Promotions_is_enabled)

Ob die Werbeaktion aktiviert ist oder nicht.

Beispiel: true
limitsobject(Promotions_promotion_limits)

Werbebeschränkungen.

nameobjecterforderlich

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.

Beispiel: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*stringzusätzliche Eigenschaft
price_conditionsArray of objects or null(price_conditions_bonus)

Objekt-Array mit Bedingungen für die Preisspanne, innerhalb der die Werbeaktion angewandt wird.
Die Aktion wird nur auf Artikel angewandt, deren Preis alle in dem Array aufgelisteten Bedingungen erfüllt. Wenn Sie dieses Array übermitteln, müssen Sie den Wert des Objekts condition auf null setzen.

promotion_periodsArray of objects(promotion_periods)

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

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Antworten

Die Werbeaktion wurde erfolgreich aktualisiert.

Antwort
Kein Inhalt

Verwaltung

Operationen

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen