ID de la promotion. Identifiant unique de la promotion au sein du projet.
- Mettre à jour une promotion sur les objets
Lire la liste des promotions sur des objets
Créer une promotion par réduction pour un objet
Supprimer une promotion sur les objets
Lire une promotion sur les objets
Mettre à jour une promoti...
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/promotion/{promotion_id}/item
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- 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/111425/itemLa promotion sur les objets a été reçu avec succès.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 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.
Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]
Exemple: [12,789]
Exemple: [{"sku":"com.xsolla.elven_sword_1"},{"sku":"com.xsolla.elven_helmet_1"},{"sku":"com.xsolla.elven_armor_1"}]
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.
Exemple: {"en-US":"Promotion","ru-RU":"Акция"}
Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion.
La promotion ne s'applique qu'aux biens dont le prix répond à toutes les conditions du tableau. Si vous passez ce tableau, définissez la valeur de l'objet items sur null.
Réponse
application/json
{ "discount": { "percent": "20.00" }, "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "items": [ { … }, { … } ], "limits": { "per_item": null, "per_user": { … }, "recurrent_schedule": { … } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "price_conditions": [ { … }, { … } ], "promotion_periods": [ { … } ] }
Requête
Met à jour la promotion.
Note
Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.
Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.
Les promotions offrent une remise (%) sur les objets. La remise s'applique à tous les prix des objets spécifiés.
Sécurité
basicAuth
Chemin
Corpsapplication/jsonobligatoireID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Objet contenant des données de la promotion.
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.
Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]
Exemple: [12,789]
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.
Exemple: {"en-US":"Promotion","ru-RU":"Акция"}
Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion.
La promotion ne s'applique qu'aux biens dont le prix répond à toutes les conditions du tableau. Si vous passez ce tableau, définissez la valeur de l'objet items sur null.
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- 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/v3/project/44056/admin/promotion/111425/item \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"type": "string",
"value": "ork"
},
{
"attribute": "level",
"can_be_missing": true,
"operator": "eq",
"type": "number",
"value": "10"
}
],
"discount": {
"percent": "24.00"
},
"is_enabled": true,
"items": [],
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'