Passer au contenu
/
Lire une promotion par co...

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

Supprimer une promotion par code promoServer-sideAdmin

Requête

Supprime la promotion par code promo. 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 obtenir d'objets bonus ou acheter des objets à travers cette promotion.

Après la suppression, la promotion ne peut pas être restaurée. Les codes promo de la promotion supprimée peuvent être ajoutés à des promotions existantes.

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
external_idintegerobligatoire

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

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

Réponses

Code promo supprimé avec succès.

Réponse
Aucun contenu

Lire une promotion par code promoServer-sideAdmin

Requête

Récupère des informations sur une promotion par code promo spécifique.

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
external_idintegerobligatoire

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

Exemple: coupon_44056_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1

Réponses

Le code promo a été reçu avec succès.

Corpsapplication/json
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.

bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null
Exemple: {"discount":{"percent":"10.99"}}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Liste des objets bénéficiant d'une remise grâce à un code promo.

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]
external_idstring(Promotions_coupon-external_id)

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"
is_enabledboolean(Promotions_coupon-is_enabled)
Par défaut true
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à certains biens du panier.
Le prix de chaque bien du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions ne s'appliquent qu'aux biens du panier dont le prix répond à la condition.
Si vous passez ce tableau, définissez la valeur du tableau discounted_items sur null.

nameobject(Promotions_coupon_name)

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"}
price_conditionsArray of objects or null(price_conditions_promocode)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à l'ensemble du panier.
Le prix total de tous les biens du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions s'appliquent à tous les biens du panier si le prix du panier répond à la condition spécifiée.
Si vous passez ce tableau, définissez la valeur du tableau discounted_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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Nombre d'échanges par code.

Par défaut 10
Exemple: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limite le nombre total de coupons.

Par défaut 10
Exemple: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.

Par défaut 10
Exemple: 10
total_limit_stateobject or null(Promotions_promocode_total_limit_state)

Limites pour chaque code promo unique.

Réponse
application/json
{
  "bonus": [
    { … }
  ],
  "discount": {
    "percent": "10.99"
  },
  "discounted_items": null,
  "excluded_promotions": [
    23,
    45
  ],
  "external_id": "summer20221",
  "is_enabled": true,
  "name": {
    "en-US": "Coupon name",
    "ru-RU": "Название купона"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": 1,
  "redeem_total_limit": 100,
  "redeem_user_limit": null,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

Mettre à jour une promotion par code promoServer-sideAdmin

Requête

Met à jour une promotion par code promo.

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
external_idintegerobligatoire

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

Exemple: coupon_44056_1
Corpsapplication/json
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.

bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null
Exemple: {"percent":"10.10"}
discounted_itemsArray of objects or null(Promotions_discounted_items)

Liste des objets bénéficiant d'une remise grâce à un code promo.

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]
item_price_conditionsArray of objects or null(item_price_conditions_promocode)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à certains biens du panier.
Le prix de chaque bien du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions ne s'appliquent qu'aux biens du panier dont le prix répond à la condition.
Si vous passez ce tableau, définissez la valeur du tableau discounted_items sur null.

nameobject(Promotions_coupon_name)obligatoire

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"}
name.​property name*stringpropriété supplémentaire
price_conditionsArray of objects or null(price_conditions_promocode)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à l'ensemble du panier.
Le prix total de tous les biens du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les bonus et les réductions s'appliquent à tous les biens du panier si le prix du panier répond à la condition spécifiée.
Si vous passez ce tableau, définissez la valeur du tableau discounted_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.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Nombre d'échanges par code.

Par défaut 10
Exemple: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limite le nombre total de coupons.

Par défaut 10
Exemple: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.

Par défaut 10
Exemple: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "discount": {
      "percent": "10.10"
    },
    "name": {
      "de-DE": "Neujahrsrabatt",
      "en-US": "New Year Discount"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ],
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Réponses

Le code promo a été mis à jour avec succès.

Réponse
Aucun contenu

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

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