Begrenzung der Elementanzahl auf der Seite.
- Liste der Bundles anhand der angegebenen Gruppe abrufen
Liste der Bundles abrufen
Angegebenes Bundle abrufen
Liste der Bundles anhand...
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
Anfrage
Ruft eine Liste von Bundles ab, um einen Katalog zu erstellen.
Achtung
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort.
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort.
Hinweis
Die API-Aufrufe für den Artikelkatalog können auch ohne Autorisierung verwendet werden. Um jedoch einen personalisierten Katalog abzurufen, müssen Sie den Benutzer-JWT im Authorization-Header übermitteln.
Die API-Aufrufe für den Artikelkatalog können auch ohne Autorisierung verwendet werden. Um jedoch einen personalisierten Katalog abzurufen, müssen Sie den Benutzer-JWT im Authorization-Header übermitteln.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).
Beispiel: offset=0
Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.
Standard "en"
Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden.
Elemente Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern und dazu, wie das Land ermittelt wird, finden Sie in der Dokumentation.
Beispiel: country=US
Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.
Beispiel: promo_code=WINTER2021
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/items/bundle
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/items/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Antwort
application/json
{ "has_more": true, "items": [ { … } ] }
Anfrage
Ruft eine Liste von Bundles innerhalb einer Gruppe ab, um einen Katalog zu erstellen.
Achtung
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort.
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort.
Hinweis
Die API-Aufrufe für den Artikelkatalog können auch ohne Autorisierung verwendet werden. Um jedoch einen personalisierten Katalog abzurufen, müssen Sie den Benutzer-JWT im Authorization-Header übermitteln.
Die API-Aufrufe für den Artikelkatalog können auch ohne Autorisierung verwendet werden. Um jedoch einen personalisierten Katalog abzurufen, müssen Sie den Benutzer-JWT im Authorization-Header übermitteln.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).
Beispiel: offset=0
Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.
Standard "en"
Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden.
Elemente Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern und dazu, wie das Land ermittelt wird, finden Sie in der Dokumentation.
Beispiel: country=US
Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.
Beispiel: promo_code=WINTER2021
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/items/bundle/group/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/group/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/items/bundle/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Antwort
application/json
{ "has_more": true, "items": [ { … } ] }
Anfrage
Ruft ein angegebenes Bundle ab.
Hinweis
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.
Beispiel: promo_code=WINTER2021
Zeigt zeitlich begrenzte Artikel an, die nicht erhältlich sind. Der Gültigkeitszeitraum dieser Artikel hat noch nicht begonnen oder ist bereits vorüber.
Standard 0
Beispiel: show_inactive_time_limited_items=1
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/items/bundle/sku/{sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/items/bundle/sku/kg_1?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Das angegebene Bundle wurde erfolgreich empfangen.
Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.
Standard []
Beispiel: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
Bundle-Typ. Durch Angabe von standard erstellen Sie ein Bundle mit Artikeln, wobei die SKUs der im Bundle enthaltenen Artikel anzugeben ist. Durch Angabe von partner_side_content wird ein leeres Bundle erstellt, wobei die Artikel über einen Webhook hinzuzufügen sind. Dieser Typ wird nur für die Katalogpersonalisierung aufseiten des Partners verwendet.
Standard "standard"
Enum"standard""partner_side_content"
Beispiel: "standard"
Sofern true, kann der Nutzer einen Artikel kaufen.
Beispiel: true
Bundle-/Paketinhalt.
Beispiel: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":"10.99","amount_without_discount":"10.99","currency":"USD"},"quantity":100,"sku":"com.xsolla.big_rocket_1","type":"virtual_currency"}]
Ein JSON-Objekt mit Artikelattributen und ‑werten.
Artikelbeschreibung.
Beispiel: "Big Rocket - description."
Gruppen, zu denen der Artikel gehört.
Standard []
Beispiel: [{"external_id":"exclusive","name":"Exclusive"}]
Ist true eingestellt, ist der Artikel kostenlos.
Standard false
Beispiel: false
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)
Objekt mit Lokalisierungen für lange Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Varianten angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.
Any of:
Objekt mit Lokalisierungen für lange Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Varianten angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.
Zusätzliche Medieninhalte des Bundles.
Beispiel: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
Auf bestimmte Artikel im Warenkorb angewandte Werbeaktionen. Das array wird in den folgenden Fällen zurückgegeben:
Für einen bestimmten Artikel ist eine Rabattaktion konfiguriert.
Ein Promocode mit der Einstellung Rabatt auf ausgewählte Artikel ist angewandt.
Werden keine Werbeaktionen auf Artikelebene angewandt, wird ein leeres Array zurückgegeben.
Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
Beispiel: "bundle_1"
Preissumme der einzelnen Bundle-Inhalte.
Antwort
application/json
{ "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { … } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1.", "groups": [], "image_url": null, "is_free": false, "item_id": 610316, "limits": { "per_user": { … } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { … } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { … }, { … } ] }