Zum Inhalt springen

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
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/shop-builder/
https://store.xsolla.com/api/
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
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Katalog

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

Operationen
Operationen
Operationen
Operationen
Operationen
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
Operationen
Operationen
Operationen
Operationen
Operationen

Wertpunkte von Artikeln löschenServer-sideAdmin

Anfrage

Entfernt Wertpunktbelohnungen von ALLEN Artikeln.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
value_point_skustringerforderlich

Wertepunkt-SKU.

Beispiel: value_point_3
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards

Antworten

Wertpunktbelohnungen für Artikel wurden erfolgreich gelöscht.

Body
Antwort
Kein Inhalt

Liste der Artikel mit Wertpunkten abrufenServer-sideAdmin

Anfrage

Ruft eine Liste aller Artikel mit Wertpunkten innerhalb eines Projekts zu Verwaltungszwecken ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
value_point_skustringerforderlich

Wertepunkt-SKU.

Beispiel: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards

Antworten

Die Liste der Artikel mit Wertpunktbelohnungen wurde erfolgreich empfangen.

Bodyapplication/json
itemsArray of objects(admin-item-value-point-reward)
Antwort
application/json
{ "items": [ {}, {} ] }

Wertpunkte für Artikel teilweise aktualisierenServer-sideAdmin

Anfrage

Aktualisiert die Anzahl der Wertpunkte für einen oder mehrere Artikel teilweise anhand der SKU des Artikels. Nutzer erhalten Wertpunkte nach dem Kauf der angegebenen Artikel.

Grundregeln für die Aktualisierung von Wertpunkten:

  • Wenn einem Artikel noch keine Wertpunkte zugewiesen sind, werden diese durch das Senden eines Wertes ungleich Null in das Feld amount eingetragen.
  • Wenn einem Artikel bereits Wertpunkte zugewiesen sind, werden die im Feld amount angegebenen Wertpunkte durch das Senden eines Wertes ungleich Null überschrieben.
  • Wennamount auf 0 festgelgt wird, werden die vorhandenen Wertpunkte für diesen Artikel gelöscht.

Im Gegensatz zur PUT-Methode (Wertpunkte für Artikel festlegen), werden bei dieser PATCH-Methode nicht alle vorhandenen Artikel-Wertpunkte im Projekt überschrieben, sondern nur die Wertpunkte der angegebenen Artikel aktualisiert.

Mit einer einzelnen Anfrage können bis zu 100 Artikel aktualisiert werden. Doppelt vorhandene Artikel-SKUs dürfen nicht in derselben Anfrage enthalten sein.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
value_point_skustringerforderlich

Wertepunkt-SKU.

Beispiel: value_point_3
Bodyapplication/jsonArray [
amountinteger>= 0erforderlich

Anzahl der Wertpunkte.

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"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

Antworten

Wertpunktbelohnungen für Artikel wurden erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen