Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.
- Katalogsonderangebot abrufen
Katalogsonderangebot aktivieren
Codes für Katalogsonderangebote abrufen
Code für Katalogsonderangebote erstellen
Codes für Katalogsonderangebote generieren
Katalogsonderangebot deaktivieren
Liste von Katalogsonderangeboten abrufen
Katalogsonderangebot erstellen
Katalogsonderangebotsaktion löschen
Katalogsonderangebot aktualisieren
Katalogsonderangebot abru...
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
Löscht eine einmalige Katalogsonderangebotsaktion. Die gelöschte Werbeaktion:
- verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.
- wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Der Nutzer können im Rahmen dieser Werbeaktion keine Artikel kaufen.
Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.
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/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{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/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1Das Katalogsonderangebot wurde erfolgreich abgerufen.
Eindeutige Werbeaktions-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
Standard "coupon_external_id"
Beispiel: "coupon_external_id"
Eine Liste der Artikel-SKU, die nach Inanspruchnahme des Katalogsonderangebots verfügbar sind.
Beispiel: ["booster_mega_1"]
Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.
Standard {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Beispiel: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Gültigkeitszeitraum der Werbeaktion. Wenn mehrere Zeiträume angegeben sind, sind sowohl date_from als auch date_until erforderlich.
Anzahl der Einlösungen pro Code.
Standard 10
Beispiel: 10
Begrenzt die Gesamtzahl der Gutscheine.
Standard 10
Beispiel: 10
Begrenzt, wie oft ein einzelner Nutzer Gutscheine einlösen darf.
Standard 10
Beispiel: 10
Antwort
application/json
{ "external_id": "secret_shop", "is_enabled": true, "items": [ "helmet", "sword", "shield" ], "name": { "en-US": "Secret shop", "ru-RU": "Секретный магазин" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": 1, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
Pfad
Bodyapplication/jsonProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Eine Liste der Artikel-SKU, die nach Inanspruchnahme des Katalogsonderangebots verfügbar sind.
Beispiel: ["booster_mega_1"]
Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.
Standard {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Beispiel: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Gültigkeitszeitraum der Werbeaktion. Wenn mehrere Zeiträume angegeben sind, sind sowohl date_from als auch date_until erforderlich.
Anzahl der Einlösungen pro Code.
Standard 10
Beispiel: 10
Begrenzt die Gesamtzahl der Gutscheine.
Standard 10
Beispiel: 10
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}
- 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/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1 \
-H 'Content-Type: application/json' \
-d '{
"items": [
"elven_sword",
"elven_boots"
],
"name": {
"de-DE": "Neujahrsangebot",
"en-US": "New Year Offer"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}'