Zum Inhalt springen
/
Artikelaktion löschen

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

Rabattaktion für Artikel erstellenServer-sideAdmin

Anfrage

Erstellt eine Rabattaktion für einen Artikel.

Werbeaktionen gewähren einen Rabatt (in %) auf Artikel. Der Rabatt wird auf alle Preise der angegebenen Artikel angewendet.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/jsonerforderlich

Objekt mit Werbeaktionsdaten.

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.

discountobjecterforderlich
discount.​percentstringerforderlich

Prozentualer Rabatt. Der Preis des Artikels wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.

Beispiel: 10
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]
is_enabledboolean(Promotions_is_enabled)

Ob die Werbeaktion aktiviert ist oder nicht.

Beispiel: true
itemsArray of objectserforderlich
items[].​skustringerforderlich

Artikel-SKU.

Standard "elven_sword"
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: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringzusätzliche Eigenschaft
price_conditionsArray of objects or null(price_conditions_discount)

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 items 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 POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/promotion/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Antworten

Werbeaktion wurde erfolgreich erstellt.

Bodyapplication/json
promotion_idinteger

Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Antwort
application/json
{
  "promotion_id": 2384756
}

Artikelaktion löschenServer-sideAdmin

Anfrage

Löscht eine Rabattaktion. Die gelöschte Aktion:

  • verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.
  • wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Artikel kaufen.

Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.

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 DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/promotion/111425/item

Antworten

Die Werbeaktion wurde erfolgreich gelöscht.

Antwort
Kein Inhalt

Artikelaktion abrufenServer-sideAdmin

Anfrage

Ruft die für einen bestimmten Artikel geltende Werbeaktion ab.

Werbeaktionen gewähren einen Rabatt (in %) auf Artikel. Der Rabatt wird auf alle Preise der angegebenen Artikel angewendet.

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/item

Antworten

Die Artikelaktion 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.

discountobject
Beispiel: {"percent":"15.00"}
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.

Beispiel: 1
is_enabledboolean(Promotions_is_enabled)

Ob die Werbeaktion aktiviert ist oder nicht.

Beispiel: true
itemsArray of objects or null
Beispiel: [{"sku":"com.xsolla.elven_sword_1"},{"sku":"com.xsolla.elven_helmet_1"},{"sku":"com.xsolla.elven_armor_1"}]
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: {"en-US":"Promotion","ru-RU":"Акция"}
price_conditionsArray of objects or null(price_conditions_discount)

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 items 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
{
  "discount": {
    "percent": "20.00"
  },
  "excluded_promotions": [
    23,
    45
  ],
  "id": 1,
  "is_enabled": true,
  "items": [
    { … },
    { … }
  ],
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": { … }
  },
  "name": {
    "en-US": "Promotion",
    "ru-RU": "Акция"
  },
  "price_conditions": [
    { … },
    { … }
  ],
  "promotion_periods": [
    { … }
  ]
}

Boni

Diese API ermöglicht die Verwaltung von Bonusaktionen.

Operationen

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