Informations sur le code.
- Lire la liste de toutes les promotions
Activer une promotion
Désactiver une promotion
Vérifier un code promotionnel
Lire une promotion utilisable par code
Lire la liste de toutes l...
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/v2/project/{project_id}/promotion/code/{code}/verify
- https://store.xsolla.com/api/v2/project/{project_id}/promotion/code/{code}/verify
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/promotion/code/WINTER2021/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Réponse
application/json
{ "code": "WINTER2023", "rewards": { "bonus": [ … ], "is_selectable": true }, "type": "coupon" }
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/promotion
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion
- 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/promotion?limit=50&offset=0&enabled=0'Réponse
application/json
{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
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/promotion/redeemable/code/{code}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- 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/promotion/redeemable/code/WINTER2021La promotion a été reçue avec succès.
Liste des objets bénéficiant d'une remise grâce à un code promo. Uniquement pour les codes promo.
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
Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.
Par défaut 10
Exemple: 10
Réponse
application/json
{ "bonus": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }