Nombre de promotions actives.
- Créer une promotion par coupon
Lire les limites pour les code de coupon uniques
Activer une promotion par coupon
Lire les codes de coupon
Créer un code de coupon
Générer des codes de coupon
Désactiver une promotion par coupon
Lire la limite de coupon pour un utilisateur spécifique
Lire les récompenses d'un coupon
Échanger un code de coupon
Lire la liste des promotions par coupon
Supprimer une promotion par coupon
Lire une promotion par coupon
Mettre à jour une promotion par coupon
Créer une promotion par c...
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.
Télécharger la description d'OpenAPI
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/shop-builder/
https://store.xsolla.com/api/
Catalogue personnalisé
Cette API permet de spécifier des règles pour les attributs utilisateur. Si l'utilisateur remplit toutes les conditions d'une règle concrète, des objets personnalisés seront affichés.
Pour les promotions personnalisées, voir la section Promotions.
Pour passer des attributs avant un achat, utilisez Xsolla Login API ou passez-les dans la propriété user.attributes lors de la génération du jeton à l'aide de Pay Station API.
Opérations
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/coupon?limit=50&offset=0'Réponse
application/json
{ "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { … }, { … } ], "total_promotions_count": 2 }
Chemin
Corpsapplication/jsonID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la promotion selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.
ID unique de la promotion. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.
Par défaut "coupon_external_id"
Exemple: "coupon_external_id"
Nom de la promotion. Doit comprendre des paires clé/valeur où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.
Par défaut {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemple: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Périodes de validité de la promotion. Si plusieurs périodes sont spécifiées, les paramètres date_from et date_until sont tous deux requis.
Nombre d'échanges par code.
Par défaut 10
Exemple: 10
Limite le nombre total de coupons.
Par défaut 10
Exemple: 10
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/coupon \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [
{
"quantity": 1,
"sku": "com.xsolla.elven_sword_2"
}
],
"external_id": "coupon_external_id",
"name": {
"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"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
}'Réponse
application/json
{ "external_id": "coupon_external_id" }
Requête
Supprime la promotion par coupon. Les conséquences suivantes s'en suivent :
- La promotion disparaît de la liste des promotions configurées dans votre projet ;
- Elle n'est plus appliquée au catalogue des objets. L'utilisateur ne peut plus obtenir d'objets bonus à travers cette promotion.
Après la suppression, la promotion ne peut pas être restaurée. Les coupons de la promotion supprimée peuvent être ajoutés à des promotions existantes.
Sécurité
basicAuth
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/coupon/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon/{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/fr/api/shop-builder/v3/project/44056/admin/coupon/coupon_44056_1