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

Artikel in den angegeben Warenkorb legenClient-side

Anfrage

Legt Artikel in den angegebene Warenkorb. Wenn der Warenkorb bereits einen Artikel mit derselben SKU enthält, wird die vorhandene Artikelposition durch den übergebenen Wert ersetzt.

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
Bodyapplication/json
itemsArray of objectserforderlich

Liste der Artikel.

Beispiel: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumbererforderlich
Standard 123
items[].​skustringerforderlich
Standard "booster_mega_1"
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID.

Beispiel: "cart_id"
is_freeboolean(value-cart_is_free)

Ist true eingestellt, ist der Warenkorb kostenlos.

Standard false
Beispiel: false
itemsArray of objects
priceobject or null

Warenkorbpreis.

Beispiel: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Auf den gesamten Warenkorb angewandte Werbeaktionen. Das Array wird in den folgenden Fällen zurückgegeben:

  • Eine Werbeaktion wirkt sich auf den Warenkorb-Gesamtbetrag aus, z. B. ein Promocode mit der Einstellung Rabatt auf den Kauf.

  • Im Rahmen einer Werbeaktion werden Bonusartikel in den Warenkorb gelegt.

Werden keine Werbeaktionen auf Bestellebene angewandt, wird ein leeres Array zurückgegeben.

warningsArray of objects
Antwort
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Warenkorbartikel anhand der Warenkorb-ID löschenClient-side

Anfrage

Entfernt einen Artikel aus dem Warenkorb.

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
curl -i -X DELETE \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/cart/custom_id/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Der Artikel aus dem Warenkorb wurde erfolgreich gelöscht.

Antwort
Kein Inhalt

Warenkorbartikel anhand der Warenkorb-ID aktualisierenClient-side

Anfrage

Aktualisiert einen vorhandenen Warenkorbartikel oder legt den Artikel in den Warenkorb.

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
Bodyapplication/json
quantitynumber

Artikelmenge.

Standard 123
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/cart/custom_id/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 123
  }'

Antworten

Der Warenkorb wurde erfolgreich aktualisiert.

Antwort
Kein Inhalt
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
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen