Passer au contenu
/
Créer une promotion par r...

Shop Builder API (2.0.0)

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
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/shop-builder/
https://store.xsolla.com/api/

Administrateur

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

Administrateur

Opérations

Catalogue

Opérations

Panier (côté client)

Opérations

Panier (côté serveur)

Opérations

Paiement (côté client)

Opérations

Paiement (côté serveur)

Opérations

Commande

Opérations

Biens gratuits

Opérations

Webhooks

Opérations

Pré-commandes

Opérations

Commerçant

Opérations

Catalogue

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

Opérations

Régions communes

Opérations

Catalogue

Opérations

Droit

Opérations

Administrateur

Opérations

Communs

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

Lire la liste des promotions sur des objetsServer-sideAdmin

Requête

Récupère la liste des promotions sur les objets d'un projet.

Les promotions offrent une remise (%) sur les objets. La remise s'applique à tous les prix des objets spécifiés.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 59080
Requête
limitinteger

Nombre maximal d'éléments sur une page.

offsetinteger

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'

Réponses

La liste des promotions sur des objets a été reçue avec succès.

Corpsapplication/json
active_promotions_countinteger(active_promotions_count)

Nombre de promotions actives.

inactive_promotions_countinteger(inactive_promotions_count)

Nombre de promotions désactivées.

promotionsArray of objects
total_promotions_countinteger(total_promotions_count)

Nombre total de promotions.

Réponse
application/json
{
  "active_promotions_count": 4,
  "inactive_promotions_count": 0,
  "promotions": [
    { … },
    { … },
    { … },
    { … }
  ],
  "total_promotions_count": 4
}

Créer une promotion par réduction pour un objetServer-sideAdmin

Requête

Crée une promotion par réduction pour un objet.

Les promotions offrent une remise (%) sur les objets. La remise s'applique à tous les prix des objets spécifiés.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
Corpsapplication/jsonobligatoire

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.

discountobjectobligatoire
discount.​percentstringobligatoire

Pourcentage de la remise. Le prix de l'objet sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.

Exemple: 10
excluded_promotionsArray of integers(excluded_promotions)

Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]

Exemple: [12,789]
is_enabledboolean(Promotions_is_enabled)

Si la promotion est activée ou non.

Exemple: true
itemsArray of objectsobligatoire
items[].​skustringobligatoire

UGS de l'objet.

Par défaut "elven_sword"
limitsobject(Promotions_promotion_limits)

Limites de la promotion.

nameobjectobligatoire

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":"Акция"}
name.​property name*stringpropriété supplémentaire
price_conditionsArray of objects or null(price_conditions_discount)

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.

promotion_periodsArray of objects(promotion_periods)

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.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/promotion/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"
      }
    ]
  }'

Réponses

La promotion a été créée avec succès.

Corpsapplication/json
promotion_idinteger

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Réponse
application/json
{
  "promotion_id": 2384756
}

Supprimer une promotion sur les objetsServer-sideAdmin

Requête

Supprime la promotion par réduction. 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 ni au panier. L'utilisateur ne peut plus acheter d'objets à travers cette promotion.

Après la suppression, la promotion ne peut pas être restaurée.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
promotion_idintegerobligatoire

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Exemple: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/promotion/111425/item

Réponses

Promotion supprimée avec succès.

Réponse
Aucun contenu

Bonus

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

Opérations

Administrateur

Opérations

Catalogue

Opérations

Paiement virtuel

Opérations

Gestion

Opérations

Administrateur

Opérations

Client

Opérations

Client clans

Opérations

Administrateur

Opérations

Client

Opérations

Administrateur

Opérations

Client

Opérations

Administrateur

Opérations

Client

Opérations

Administrateur

Opérations