External ID de la promotion. Identifiant unique de la promotion au sein du projet.
- Lire la limite de code promo pour un utilisateur spécifique
Lire les limites pour les codes promo
Activer une promotion par code promo
Lire les codes d'une promotion par code promo
Créer un code pour une promotion par code promo
Générer des codes pour une promotion par code promo
Désactiver une promotion par code promo
Lire les récompenses d'un code promo
Échanger un code promo
Supprimer un code promo du panier
Lire la liste des promotions par code promo
Créer une promotion par code promo
Supprimer une promotion par code promo
Lire une promotion par code promo
Mettre à jour une promotion par code promo
Lire la limite de code pr...
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}/admin/promocode/{external_id}/deactivate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{external_id}/deactivate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/deactivateRequête
Récupère le nombre de fois restant qu'un utilisateur spécifique peut utiliser le code promo.
L'API des limites utilisateur vous permet de limiter le nombre de fois que les utilisateurs peuvent utiliser un code promo. Pour configurer les limites utilisateur, référez-vous à la section Administrateur :
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/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/fr/api/shop-builder/v2/project/44056/admin/user/limit/promocode/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Réponse
application/json
{ "per_user": { "available": 9, "total": 10 } }
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}/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/fr/api/shop-builder/v2/project/44056/promocode/code/SO6rew99j9/rewards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Réponse
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "discounted_items": [ { … } ], "is_selectable": true }