Artikelmenge.
Shop Builder API (2.0.0)
- 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/
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
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Header
Bodyapplication/jsonDie Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.
Beispiel: ACCESS_TOKEN/LOGIN_JWT
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"
Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.
Beispiel: "USD"
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/admin/project/{project_id}/cart/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/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"
}
]
}'Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.
Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.
Beispiel: "cart_id"
Ist true eingestellt, ist der Warenkorb kostenlos.
Standard false
Beispiel: false
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.
Antwort
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Header
Bodyapplication/jsonDie Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.
Beispiel: ACCESS_TOKEN/LOGIN_JWT
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"
Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.
Beispiel: "USD"
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/admin/project/{project_id}/cart/{cart_id}/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/{cart_id}/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/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"
}
]
}'Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.
Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.
Beispiel: "cart_id"
Ist true eingestellt, ist der Warenkorb kostenlos.
Standard false
Beispiel: false
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.
Antwort
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }