Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.
- Gutscheinbelohnung abrufen
Limits eindeutiger Gutscheincodes abrufen
Gutscheinaktion aktivieren
Gutscheincodes abrufen
Gutscheincode erstellen
Gutscheincodes generieren
Gutscheinaktion deaktivieren
Gutschein-Limit für den angegebenen Benutzer abrufen
Gutscheincode einlösen
Liste der Gutscheinaktionen abrufen
Gutscheinaktionen erstellen
Gutscheinaktion löschen
Gutscheinaktion abrufen
Gutscheinaktion aktualisieren
Gutscheinbelohnung abrufe...
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
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Antwort
application/json
{ "per_user": { "available": 9, "total": 10 } }
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/coupon/code/{coupon_code}/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/code/{coupon_code}/rewards
- 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/coupon/code/WINTER2021/rewards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Antwort
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "is_selectable": true }
Pfad
Bodyapplication/jsonProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Eindeutiger Gutscheincode. Enthält Buchstaben und Ziffern.
Standard "WINTER2021"
Beispiel: "WINTER2021"
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/coupon/redeem
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/coupon/redeem \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"coupon_code": "WINTER2021",
"selected_unit_items": {
"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}'Gutschein wurde erfolgreich eingelöst.
Beispiel: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Antwort
application/json
{ "items": [ { … } ] }