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

Catalog API bietet Endpunkte zur Verwaltung Ihres In-Game-Store-Katalogs und zur Abwicklung von Käufen. Verwenden Sie die Endpunkte zum Konfigurieren von virtuellen Gegenständen, virtuellen Währungen, Spielschlüsseln, Bundles, Warenkorb- und Zahlungsabläufen sowie Artikelattributen und zum Importieren von Artikeln aus externen Quellen.

OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/
https://store.xsolla.com/api/
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Artikel in den Warenkorb legenServer-side

Anfrage

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

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Abfrage
localestring

Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.

Standard "en"
Header
x-user-forstring

Die Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.

Beispiel: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Sie können Ihre eigene Benutzer-ID verwenden, wenn Sie einen Warenkorb mit Spielen verkaufen.

Beispiel: UNIQUE_ID
Bodyapplication/json
countrystring= 2 characters

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
currencystring= 3 characters

Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumber>= 1erforderlich

Artikelmenge.

Beispiel: 2
items[].​skustringnon-emptyerforderlich

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

Beispiel: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.

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.

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": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Warenkorb anhand der Warenkorb-ID mit Artikeln zusammenstellenServer-side

Anfrage

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

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
Abfrage
localestring

Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.

Standard "en"
Header
x-user-forstring

Die Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.

Beispiel: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Sie können Ihre eigene Benutzer-ID verwenden, wenn Sie einen Warenkorb mit Spielen verkaufen.

Beispiel: UNIQUE_ID
Bodyapplication/json
countrystring= 2 characters

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
currencystring= 3 characters

Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumber>= 1erforderlich

Artikelmenge.

Beispiel: 2
items[].​skustringnon-emptyerforderlich

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

Beispiel: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.

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.

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": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }
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