Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.
- Promocode-Belohnungen abrufen
Promocode-Limit für Codes abrufen
Promocode-Aktion aktivieren
Codes von Promocode-Aktion abrufen
Code für Promocode-Aktion erstellen
Codes für eine Promocode-Aktion generieren
Promocode-Aktion deaktivieren
Promo-Code-Limit für den angegebenen Benutzer abrufen
Promocode einlösen
Promocode aus Warenkorb entfernen
Liste der Promocode-Aktionen abrufen
Promocode-Aktion erstellen
Promocode löschen
Promocode-Aktion abrufen
Promocode-Aktion aktualisieren
Promocode-Belohnungen abr...
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 ab, wie oft der angegebene Nutzer den Promocode in Anspruch nehmen kann.
Mit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer einen Promocode in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung":
Sicherheit
basicAuth
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/promocode/external_id/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promocode/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/promocode/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}/promocode/code/{promocode_code}/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/promocode/code/{promocode_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/promocode/code/SO6rew99j9/rewards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Die Liste der Promocode-Prämien wurde erfolgreich empfangen.
Prozentualer Rabatt. Der Preis des Warenkorbs wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.
Liste der Artikel, die durch einen Promocode rabattiert werden.
Antwort
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "discounted_items": [ { … } ], "is_selectable": true }
Pfad
Bodyapplication/jsonProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Eindeutiger Code des Promocodes. Enthält Buchstaben und Ziffern.
Standard "SUMMER2021"
Beispiel: "SUMMER2021"
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/{project_id}/promocode/redeem
- https://store.xsolla.com/api/v2/project/{project_id}/promocode/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/promocode/redeem \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"cart": {
"id": "current"
},
"coupon_code": "SUMMER2021",
"selected_unit_items": {
"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
}'Promocode wurde erfolgreich eingelöst.
Ist true eingestellt, ist der Artikel kostenlos.
Standard false
Beispiel: false
Beispiel: [{"attributes":[],"can_be_bought":{"$ref":"../schemas/Can_be_bought.yaml"},"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,"limits":{"$ref":"../schemas/Catalog_item_limits.yaml"},"name":"Xsolla Booster Mega","periods":{"$ref":"../schemas/item-periods.yaml"},"price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"promotions":{"$ref":"../schemas/Catalog_item_promotions.yaml"},"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"vp_rewards":{"$ref":"../schemas/reward-chain-client/client-item-value-point-reward.yaml"}}]
Warenkorbpreis.
Beispiel: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
Antwort
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "12300.0000000000000000", "currency": "USD" }, "rewards": { "bonus": [ … ], "discount": { … }, "discounted_items": [ … ], "is_selectable": false } }