Passer au contenu

Overview

  • 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/
Opérations

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
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Catalogue

Cette API permet de récupérer tout type d'objet vendable ou tout objet spécifique.

Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Coupons

Cette API permet de gérer les coupons.

Opérations

Codes promo

Cette API permet de gérer les codes promo.

Opérations

Offres uniques du catalogue

Cette API permet de gérer les offres uniques du catalogue.

Opérations

Remises

Cette API permet de gérer les promotions par réduction

Opérations

Bonus

Cette API permet de gérer les promotions par bonus.

Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Lire les informations sur les ventes incitatives dans le projetServer-sideAdmin

Requête

Récupère les informations relatives à la vente incitative dans le projet : si elle est activée, le type de vente incitative et la liste des UGS des objets concernés par cette vente.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
curl -i -X GET \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Liste des détails de configuration et des objets utilisés pour la vente incitative dans le projet.

Corpsapplication/jsonArray [
is_enabledboolean

Détermine si la vente incitative est activée pour le projet.

Exemple: true
itemsArray of objects

Liste des UGS des objets faisant partie de la vente incitative dans le projet.

Exemple: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

Type de vente incitative.

Enum"fixed_list""most_sellable""only_promotions"
Exemple: "fixed_list"
]
Réponse
application/json
[ { "is_enabled": true, "items": [], "type": "fixed_list" } ]

Créer une vente incitativeServer-sideAdmin

Requête

Crée une vente incitative pour un projet.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
Corpsapplication/json
One of:

Type de vente incitative.

is_enabledboolean(is_enabled)obligatoire
Exemple: true
itemsArray of stringsobligatoire

Tableau des UGS d'objets.

Par défaut null
Exemple: ["game_sku"]
typestringobligatoire
Valeur"fixed_list"
Exemple: true
curl -i -X POST \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Réponses

Vente incitative créée pour le projet.

Réponse
Aucun contenu

Mettre à jour une vente incitativeServer-sideAdmin

Requête

Mettre à jour une vente incitative pour un projet.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
Corpsapplication/json
One of:

Type de vente incitative.

is_enabledboolean(is_enabled)obligatoire
Exemple: true
itemsArray of stringsobligatoire

Tableau des UGS d'objets.

Par défaut null
Exemple: ["game_sku"]
typestringobligatoire
Valeur"fixed_list"
Exemple: true
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Réponses

Vente incitative mise à jour pour le projet.

Réponse
Aucun contenu
Opérations
Opérations