` représente le jeton utilisateur. Ce jeton identifie l'utilisateur et donne accès à ses données personnalisées.\nVous pouvez également utiliser un [jeton pour ouvrir l'interface de paiement](/fr/api/pay-station/token/create-token).\n\n2. **Mode simplifié sans en-tête Authorization.** Ce mode est réservé aux utilisateurs non authentifiés et peut être utilisé uniquement pour la [vente de clés de jeu](/fr/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Au lieu d'un jeton, la requête doit inclure les en-têtes suivants :\n - `x-unauthorized-id` avec un identifiant de requête\n - `x-user` avec l'adresse e-mail de l'utilisateur encodée en Base64\n\n## Liens utiles\n\n- [API calls by interaction model](https://developers.xsolla.com/fr/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/fr/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/fr/api/catalog/)\n- [API keys](https://developers.xsolla.com/fr/api/catalog/)\n- [Webhooks](https://developers.xsolla.com/fr/api/catalog/)\n\n# Structure de l'entité principale\n\nLes objets de tous types (objets virtuels, lots, monnaie virtuelle et clés) partagent une structure de données similaire. Comprendre cette structure de base facilite l’utilisation de l'API et la navigation dans la documentation.\n\nNote
Certains appels peuvent inclure des champs supplémentaires, mais ils ne modifient pas la structure de base.
\n\n**Identification**\n\n- `merchant_id` — ID de l'entreprise dans le [Compte éditeur](https://publisher.xsolla.com/)\n- `project_id` — ID de projet dans le Compte éditeur\n- `sku` — UGS de l'objet, unique au sein du projet\n\n**Affichage en magasin**\n\n- `name` — nom de l'objet\n- `description` — description de l'objet\n- `image_url` — URL de l'image\n- `is_enabled` — disponibilité de l'objet\n- `is_show_in_store` — affichage de l'objet dans le catalogue\n\nPour plus d'informations sur la gestion de la disponibilité des objets dans le catalogue, consultez la [documentation](/fr/items-catalog/catalog-features/items-availability/).\n\n**Organisation**\n\n- `type` — type d'objet, par exemple, un objet virtuel (`virtual_item`) ou un lot (`bundle`)\n- `groups` — groupes auxquels l'objet appartient\n- `order` — ordre d'affichage dans le catalogue\n\n**Conditions de vente**\n\n- `prices` — prix en devise réelle ou monnaie virtuelle\n- `limits` — limites d'achat\n- `periods` — périodes de disponibilité\n- `regions` — restrictions régionales\n\n**Exemple de structure d'entité principale :**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Processus d'achat de base\n\nL'API Xsolla vous permet d'implémenter la logique de magasin en jeu, notamment la récupération du catalogue des objets, la gestion du panier, la création de commandes et le suivi de leur statut. Selon le scénario d'intégration, les appels API sont répartis en sections **Administrateur** et **Catalogue**, qui utilisent différents [schémas d'authentification](/fr/api/catalog/section/authentication).\n\nL'exemple suivant montre un processus de base pour configurer et exploiter un magasin, de la création d'objets à l'achat.\n\n## Création d'objets et de groupes (Administrateur)\n\nCréez un catalogue des objets pour votre magasin, tels que des objets virtuels, des lots ou de la monnaie virtuelle.\n\nExemples d'appels API :\n- [Créer un objet virtuel](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Créer un lot](/fr/api/catalog/bundles-admin/admin-create-bundle)\n- [Créer une monnaie virtuelle](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Configuration de promotions, chaînes et limites (Administrateur)\n\nConfigurez des outils d'acquisition d'utilisateurs et de monétisation, tels que des remises, des bonus, des récompenses quotidiennes ou des chaînes d'offres.\n\nExemples d'appels API :\n- [Créer une promotion de bonus](/fr/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Créer une récompense quotidienne](/fr/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Créer une offre de catalogue unique](/fr/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Récupération d'informations sur un objet (Client)\n\nConfigurez l'affichage des objets dans l'application.\n\n\n
Remarque\n N'utilisez pas les appels API de la sous-section Administrateur pour créer un catalogue utilisateur. Ces appels API présentent des
limites de taux et ne sont pas destinés au trafic utilisateur.\n
\n\nExemples d'appels API :\n- [Lire la liste des objets virtuels](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Lire la liste des groupes d'objets](/fr/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Lire la liste des lots](/fr/api/catalog/bundles-catalog/get-bundle-list)\n- [Lire la liste des objets vendables](/fr/api/catalog/common-catalog/get-sellable-items)\n\n\n Note
\n Par défaut, les appels API du catalogue renvoient les objets disponibles dans la boutique au moment de la requête. Pour récupérer les objets inactifs ou à durée limitée, ajoutez le paramètre \"show_inactive_time_limited_items\": 1 dans la requête du catalogue.\n
\n\n## Vente des objets\n\nVous pouvez vendre des objets en utilisant les méthodes suivantes :\n- Achat rapide — vendre une UGS plusieurs fois.\n- Achat via le panier — l'utilisateur ajoute des objets au panier, supprime des objets et modifie les quantités dans une seule commande.\n\nSi un objet est acheté en utilisant de la monnaie virtuelle au lieu des devises réelles, utilisez l'appel API [Créer une commande à partir d'un objet spécifique en monnaie virtuelle](/fr/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). L'interface de paiement n'est pas requise, car le coût est traité lors de l'exécution de l'appel API.\n\nPour l'achat d'un objet gratuit, utilisez l'appel API [Créer une commande avec un bien gratuit spécifique](/fr/api/catalog/free-item/create-free-order-with-item) ou l'appel API [Créer une commande à partir d'un panier gratuit](/fr/api/catalog/free-item/create-free-order). L'interface de paiement n'est pas requise, la commande est immédiatement définie sur le statut done.\n\n### Achat rapide\n\nUtilisez l'appel API côté client pour [créer une commande à partir d'un objet spécifique](/fr/api/catalog/payment-client-side/create-order-with-item). L'appel renvoie un jeton utilisé pour ouvrir l'interface de paiement.\n\n\n Note
\n Les informations sur les remises sont disponibles pour l'utilisateur uniquement dans l'interface de paiement. Les codes promo ne sont pas pris en charge.\n
\n\n### Achat via le panier\n\nLa configuration et les achats du panier peuvent être gérés côté client ou côté serveur.\n\n**Configuration et achat du panier côté client**\n\nImplémentez vous-même la logique d'ajout et de suppression des objets. Avant d'appeler l'API pour configurer un panier, vous ne disposerez pas d'informations sur les promotions qui s'appliqueront à l'achat. Le coût total ainsi que les informations des objets bonus ajoutés ne seront donc pas encore connus.\n\nImplémentez la logique suivante pour le panier :\n1. Après que le joueur a rempli un panier, utilisez l'appel API [Remplir le panier d'objets](/fr/api/shop-builder/operation/cart-fill/). L'appel renvoie les informations actuelles sur les objets sélectionnés (prix avant et après remises, objets bonus).\n2. Mettez à jour le contenu du panier en fonction des actions utilisateur :\n - Pour ajouter un objet ou modifier la quantité de l'objet, utilisez l'appel API [Mettre à jour un objet du panier par ID de panier](/fr/api/shop-builder/operation/put-item-by-cart-id/).\n - Pour supprimer un objet, utilisez l'appel API [Supprimer un objet du panier par ID de panier](/fr/api/shop-builder/operation/delete-item-by-cart-id/).\n\n\n Note
\n Pour obtenir le statut actuel du panier, utilisez l'appel API Lire le panier de l'utilisateur actuel.\n
\n\n3. Utilisez l'appel API [Créer une commande à partir de tous les objets du panier actuel](/fr/api/shop-builder/operation/create-order/). L'appel renvoie l'ID de commande et le jeton de paiement. La commande nouvellement créée est définie sur le statut new par défaut.\n\n**Configuration et achat du panier côté serveur**\n\nCette approche peut nécessiter davantage de temps pour configurer le panier, car chaque modification doit être effectuée via des appels API.\n\nImplémentez la logique suivante pour le panier :\n1. Après que le joueur a rempli un panier, utilisez l'appel API [Remplir le panier d'objets](/fr/api/catalog/cart-server-side). L'appel renvoie les informations à jour sur les objets sélectionnés (prix avant et après remises, objets bonus).\n2. Utilisez l'appel API [Créer une commande à partir de tous les objets du panier actuel](/fr/api/shop-builder/operation/create-order/). L'appel renvoie l'ID de commande et le jeton de paiement. La commande nouvellement créée est définie sur le statut new par défaut.\n\n## Ouverture de l'interface de paiement\n\nUtilisez le jeton renvoyé pour ouvrir l'interface de paiement dans une nouvelle fenêtre. D'autres méthodes d'ouverture de l'interface de paiement sont décrites dans la [documentation](/fr/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Ouverture dans l'environnement de production. | https://secure.xsolla.com/paystation4/?token={token} |\n| Ouverture en mode bac à sable. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Note\n Utilisez le mode bac à sable pendant le développement et les tests. Les achats de test n'entraînent aucun débit sur des comptes réels. Vous pouvez utiliser des
cartes bancaires de test.\n\n Après le premier paiement réel, une politique stricte du mode bac à sable s'applique. Les paiements en mode bac à sable sont disponibles uniquement pour les utilisateurs spécifiés dans la section [Company settings > Users](https://publisher.xsolla.com/0/settings/users) du Compte éditeur.\n\n L'achat de monnaie virtuelle et d'objets en devise réelle n'est possible qu'après la signature d'un contrat de licence avec Xsolla. Pour cela, dans le [Compte éditeur](https://publisher.xsolla.com/), accédez à **Agreements & Taxes > Agreements**, complétez le formulaire et attendez la validation. Le traitement du contrat peut prendre jusqu'à 3 jours ouvrés.\n
\n Note
\n N'utilisez pas les appels API de la sous-section Administrateur pour créer un catalogue de magasin.\n
\n\n
\n\n\n
Note\n L'appel API
Lire la liste des objets virtuels renvoie des données détaillées sur les objets, y compris les prix et les attributs, et prend en charge la pagination. Utilisez-le pour afficher les pages du catalogue dans la vitrine.\n
\n L'appel API
Lire la liste de tous les objets virtuels renvoie l'UGS, le nom, la description des objets, ainsi que l'ID et le nom du groupe sans pagination. Utilisez-le pour la recherche côté client ou l'indexation.\n
\n\nPour les achats avec de la monnaie virtuelle, utilisez l'appel API [Créer une commande à partir d'un objet spécifique en monnaie virtuelle](/fr/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). L'interface de paiement n'est pas requise, le coût est traité lors de l'exécution de l'appel API.\n\nExemple de processus d'achat avec de la monnaie virtuelle :\n\n"
},
{
"name": "virtual-items-currency-admin",
"x-displayName": "Administrateur"
},
{
"name": "virtual-items-currency-catalog",
"x-displayName": "Catalogue"
},
{
"name": "virtual-payment",
"x-displayName": "Paiement virtuel"
},
{
"name": "game-keys-overview",
"x-displayName": "Aperçu",
"description": "Les clés de jeu sont des codes alphanumériques uniques à usage unique permettant d’accéder à un jeu ou à un contenu téléchargeable (DLC) sur les plateformes de jeux vidéo. Vous pouvez vendre des clés de jeu via un [lien direct](https://developers.xsolla.com/fr/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_direct_link), via l'[interface du magasin](https://developers.xsolla.com/fr/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_store_ui), ou via un [widget](https://developers.xsolla.com/fr/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_items_develop_buttons). Vous pouvez également [configurer des restrictions régionales](https://developers.xsolla.com/fr/items-catalog/catalog-features/regional-restrictions/) afin de vendre les clés de jeu dans des pays spécifiques. Pour plus d'informations, consultez la section [Packs de clés de jeux](https://developers.xsolla.com/fr/items-catalog/items-type/set-up-modules/).\n\nL'authentification utilisateur n'est pas requise pour vendre des clés de jeu : elles sont envoyées à l'adresse e-mail fournie lors du paiement. Vous pouvez toutefois la configurer pour accéder à des fonctionnalités comme la [personnalisation](/fr/liveops/liveops-management/personalization-tutorial/), les [limites d'achat](/fr/items-catalog/catalog-features/items-catalog-number-limits/) ou le [système des droits](/fr/sell-games/how-to/entitlement-system/). Pour en savoir plus, consultez la section [Comment configurer l'authentification pour la vente de clés de jeu](/fr/sell-games/how-to/set-up-authentication/).\n\nFlux de vente de clés de jeux :\n\n1. Créez un jeu en utilisant l'appel API [Créer un jeu](/fr/api/catalog/game-keys-admin/admin-create-game).\n2. Configurez les restrictions régionales.\n3. Téléchargez des clés dans un package de clés de jeu en utilisant l'appel API [Télécharger des codes](/fr/api/catalog/game-keys-admin/admin-upload-codes-by-sku) afin de les proposer à la vente.\n4. Affichez le catalogue des jeux avec les prix correspondant à la région de l'utilisateur à l'aide de l'appel API [Lire la liste des jeux](/fr/api/catalog/game-keys-catalog/get-games-list).\n5. Créez une commande. Pour un achat rapide, utilisez l'appel API [Créer une commande à partir de tous les objets du panier actuel](/fr/api/catalog/payment-client-side/create-order-with-item), en passant l'UGS de la clé de jeu. La réponse renvoie un jeton permettant d'ouvrir l'interface de paiement.\n6. Implémentez l'ouverture de l'interface de paiement afin de régler la commande.\n\nPour recevoir des notifications en temps réel sur les paiements réussis et l'attribution des objets à l'utilisateur, configurez le suivi du statut des commandes, par exemple via les [webhooks](/fr/webhooks/section/osnovnye-polozheniya). Les clés sont envoyées à l'adresse e-mail indiquée lors du paiement, et la commande passe au statut `done`.\n\n"
},
{
"name": "game-keys-catalog",
"x-displayName": "Catalogue"
},
{
"name": "game-keys-entitlement",
"x-displayName": "Droit"
},
{
"name": "game-keys-admin",
"x-displayName": "Administrateur"
},
{
"name": "bundles-overview",
"x-displayName": "Aperçu",
"description": "Les lots sont des ensembles d'objets vendus comme une seule unité. Un lot peut inclure des objets virtuels, de la monnaie virtuelle, des packages de monnaie virtuelle, des clés de jeu et d'autres lots. Utilisez les lots pour créer des kits de démarrage, des offres saisonnières et des offres spéciales.\n\nUtilisez les groupes d'appels API suivants pour interagir avec les lots :\n\n* Utilisez des appels API de la sous-section Administrateur pour créer, mettre à jour, supprimer des lots, et gérer leur visibilité.\n* Utilisez des appels API de la sous-section Catalogue pour récupérer des lots.\n\nLes limites d'achat sont configurées via l'objet `limits` lors de la création ou de la mise à jour d'un lot. Pour en savoir plus, consultez l'aperçu des [Limites](/fr/api/catalog/limits-overview). Vous pouvez également configurer des [restrictions régionales](https://developers.xsolla.com/fr/items-catalog/catalog-features/regional-restrictions/) afin de vendre des objets dans des pays spécifiques.\n\n\n
Note\n Pour en savoir plus sur la configuration des lots, consultez la section
Lots.\n
\n\nScénario de gestion de lot :\n\n1. Créez un lot en utilisant l'appel API [Créer un lot](/fr/api/catalog/bundles-admin/admin-create-bundle). Pour vérifier le lot créé, utilisez l'appel API [Lire un lot](/fr/api/catalog/bundles-admin/admin-get-bundle). Pour récupérer tous les lots du projet, utilisez l'appel API [Lire la liste des lots](/fr/api/catalog/bundles-admin/admin-get-bundle-list).\n2. Si nécessaire, utilisez l'appel API [Mettre à jour un lot](/fr/api/catalog/bundles-admin/admin-update-bundle) pour modifier le contenu ou les paramètres du lot.\n3. Implémentez la logique d'affichage des lots dans votre vitrine en utilisant l'appel API [Lire la liste des lots](/fr/api/catalog/bundles-catalog/get-bundle-list), [Lire un lot spécifique](/fr/api/catalog/bundles-catalog/get-bundle), ou [Lire la liste des lots par groupe spécifique](/fr/api/catalog/bundles-catalog/get-bundle-list-in-group).\n4. Créez une commande en utilisant la section [Panier et paiement](/fr/api/catalog/cart-and-payment-overview). Par exemple, pour un achat rapide, vous pouvez utiliser l'appel API [Créer une commande à partir d'un objet spécifique](/fr/api/catalog/payment-client-side/create-order-with-item), en passant l'UGS du lot. La réponse contient un jeton pour ouvrir l'interface de paiement.\n5. Implémentez l'ouverture de l'interface de paiement pour payer la commande.\n6. Configurez le suivi du statut de la commande, par exemple en utilisant des [webhooks](https://developers.xsolla.com/fr/webhooks/overview), pour recevoir rapidement des données sur les objets payés avec succès et les attribuer à l'utilisateur.\n\n"
},
{
"name": "bundles-admin",
"x-displayName": "Administrateur"
},
{
"name": "bundles-catalog",
"x-displayName": "Catalogue"
},
{
"name": "cart-and-payment-overview",
"x-displayName": "Aperçu",
"description": "Le panier est un mécanisme d'achat qui permet de regrouper plusieurs objets dans une seule commande. Un utilisateur peut acheter des objets de tout type et en toute quantité avec de la devise réelle, ainsi qu'utiliser des [codes promo](https://developers.xsolla.com/fr/api/liveops/promotions-promo-codes).\n\nLe panier est stocké côté Xsolla. Sa sauvegarde d'une session à une autre dépend de l'authentification :\n * pour les utilisateurs authentifiés, le panier est lié à un utilisateur et conservé entre les sessions tant que les requêtes sont effectuées au nom de ce même utilisateur.\n\n * Pour les [utilisateurs non authentifiés](/fr/api/catalog/section/authentication/authentication-with-guest-access-support), la sauvegarde du panier dépend de la transmission de l'en-tête `x-unauthorized-id`. Pour conserver le panier d'un utilisateur non authentifié d'une session à l'autre, passez le même `x-unauthorized-id` dans chaque requête. Cette option est disponible uniquement pour la vente de clés de jeu.\n\nVous pouvez identifier le panier de deux façons : automatiquement via le [JWT utilisateur](https://developers.xsolla.com/fr/api/catalog/section/authentication/authentication-using-user's-jwt) ou via l'ID du panier (`cart_id`).\n\nLa gestion du panier est disponible à la fois côté client et côté serveur.\n\nCôté serveur, vous pouvez remplir le panier avec des objets, par exemple lors de la restauration d'une session utilisateur. Les actions suivantes sont disponibles côté client :\n\n* récupérer le panier de l'utilisateur actuel ou un panier par ID\n* remplir le panier\n* mettre à jour les objets dans le panier\n* supprimer des objets du panier\n\nPour acheter des objets du panier, les appels client et serveur servent à créer une commande.\n\nLa durée de vie (TTL) du panier est de 72 heures par défaut. Si son contenu change, par exemple lorsqu'un nouvel objet est ajouté, la TTL est prolongée.\n\nAprès un paiement réussi, le panier n'est pas vidé automatiquement. Pour le vider, utilisez les appels API côté client suivants :\n * [Supprimer tous les objets du panier par ID de panier](/fr/api/catalog/cart-client-side/cart-clear-by-id).\n\n * [Supprimer tous les objets du panier actuel](/fr/api/catalog/cart-client-side/cart-clear).\n\n * [Supprimer un objet du panier par ID de panier](/fr/api/catalog/cart-client-side/delete-item-by-cart-id) et [Supprimer un objet du panier actuel](/fr/api/catalog/cart-client-side/delete-item) — le panier est vidé lorsque vous supprimez le dernier objet.\n\nScénario d'utilisation du panier :\n\n1. Implémentez une interface de magasin permettant à l'utilisateur de sélectionner des objets.\n\n2. Lorsque l'utilisateur sélectionne des objets dans le magasin, ajoutez-les au panier, par exemple via l'appel [Remplir le panier d'objets](https://developers.xsolla.com/fr/api/catalog/cart-client-side/cart-fill). Dans le tableau des objets, indiquez les UGS et les quantités requises pour chaque objet.\n\n3. Implémentez l'interface du panier. Lors de l'accès au panier, affichez son contenu via l'appel [Lire le panier de l'utilisateur actuel](https://developers.xsolla.com/fr/api/catalog/cart-client-side/get-user-cart). La réponse inclut des informations sur le prix final de l'objet, avec remises et promotions appliquées.\n\n4. Implémentez l'ouverture de l'interface de paiement pour régler la commande. Vous pouvez, par exemple, utiliser l'appel [Créer une commande à partir de tous les objets d'un panier spécifique](https://developers.xsolla.com/fr/api/catalog/payment-client-side/create-order-by-cart-id). La réponse renvoie un jeton permettant d'ouvrir l'interface de paiement.\n\n5. Configurez le suivi du statut des commandes, par exemple à l'aide des [webhooks](https://developers.xsolla.com/fr/webhooks/), afin de recevoir rapidement les informations sur les objets payés avec succès et de les attribuer à l'utilisateur.\n\n\n
Note
\n
Pour implémenter la vente d'objets en jeu et en ligne, consultez le guide d'intégration.
\n
\n \n \n | Statut | \n Description | \n Notes | \n
\n \n \n \n new | \n Commande créée. Le système attend la confirmation du paiement.. | \n Les descriptions des statuts de transaction se trouvent dans la documentation Pay Station API. | \n
\n \n paid | \n Commande payée (la transaction est passée au statut done), et l'objet peut être attribué à l'utilisateur. | \n La commande reste en statut new jusqu'à ce que le paiement soit confirmé. | \n
\n \n done | \n Objet attribué à l'utilisateur. | \n — | \n
\n \n canceled | \n Paiement remboursé. | \n La commande passe à ce statut lorsque le statut de la transaction devient refunded. | \n
\n \n expired | \n La création d'une nouvelle commande pour un objet en édition limitée, un code promo ou une promotion fait passer toute commande antérieure non réglée contenant cet objet au statut expired. Seule la commande la plus récente peut être réglée. | \n Si un utilisateur tente de régler une commande expirée, l'interface de paiement affichera une erreur 2002 et le paiement échouera. | \n
\n \n
\n\n\n\n\n
Note
\n
Lorsque la commande passe au statut expired pendant que l'utilisateur finalise un paiement, mais que le paiement aboutit, la commande passe du statut expired au statut paid. Cela s'applique uniquement si la limite d'achat de l'objet associé à la commande n'est pas dépassée lors du paiement.
\n
\n
Note\n Pour des informations détaillées sur la configuration des limites dans le catalogue, consultez la section
Item purchase limits.\n
Note
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Créer un objet virtuel",
"description": "Crée un objet virtuel.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Note
\n Le corps de la requête inclut des paramètres optionnels pour des cas d'utilisation avancés, tels que la configuration de prix régionaux, de limites d'achat et de disponibilités limitées dans le temps. Pour créer un objet de base, fournissez les paramètres sku, name et description. Pour définir des prix en monnaie réelle, utilisez le paramètre prices, et pour une monnaie virtuelle, le paramètre vc_prices. Pour rendre l'objet gratuit, définissez is_free: true.
\n\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": {
"get": {
"summary": "Lire la liste des objets virtuels par external ID d'un groupe spécifique",
"description": "Récupère la liste des objets virtuels au sein d'un groupe à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": {
"get": {
"summary": "Lire la liste des objets virtuels par ID d'un groupe spécifique",
"description": "Récupère la liste des objets virtuels au sein d'un groupe à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Lire un objet virtuel",
"description": "Récupère des informations sur un objet virtuel au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Mettre à jour un objet virtuel",
"description": "Met à jour un objet virtuel.",
"operationId": "admin-update-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Note
\n Le schéma du corps de la requête inclut des paramètres obligatoires et optionnels pour des cas d'utilisation avancés, tels que la configuration de prix régionaux, de limites d'achat et de disponibilité limitée dans le temps.\n
\n\n
\n\n\n Remarque
\n Passez tous les paramètres de l'objet, y compris ceux qui n'ont pas besoin d'être mis à jour. Les paramètres omis de la requête seront supprimés.
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"204": {
"description": "L'objet virtuel a été mis à jour avec succès.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer un objet virtuel",
"description": "Supprime un objet virtuel.",
"operationId": "admin-delete-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "L'objet virtuel a été supprimé avec succès.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency": {
"get": {
"summary": "Lire la liste des monnaies virtuelles",
"description": "Récupère la liste des monnaies virtuelles au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currencies-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Créer une monnaie virtuelle",
"operationId": "admin-create-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"description": "Crée une monnaie virtuelle.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": {
"get": {
"summary": "Lire une monnaie virtuelle",
"description": "Récupère des informations sur une monnaie virtuelle au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"virtual-items-currency-admin"
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Virtual-Items-Currency_404-item"
}
}
},
"put": {
"summary": "Mettre à jour une monnaie virtuelle",
"description": "Met à jour une monnaie virtuelle.",
"operationId": "admin-update-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"204": {
"description": "La monnaie virtuelle a été mise à jour avec succès.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer une monnaie virtuelle",
"description": "Supprime une monnaie virtuelle.",
"operationId": "admin-delete-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "La monnaie virtuelle a été supprimée avec succès.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package": {
"get": {
"summary": "Lire la liste des packages de monnaie virtuelle (administrateur)",
"description": "Récupère la liste des packages de monnaie virtuelle au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currency-packages-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Créer un package de monnaie virtuelle",
"description": "Crée un package de monnaie virtuelle.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": {
"put": {
"summary": "Mettre à jour un package de monnaie virtuelle",
"description": "Met à jour un package de monnaie virtuelle.",
"operationId": "admin-update-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"204": {
"description": "L'objet virtuel a été mis à jour avec succès."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer un package de monnaie virtuelle",
"description": "Supprime un package de monnaie virtuelle.",
"operationId": "admin-delete-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Le package de monnaie virtuelle a été mis à jour avec succès."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Lire un package de monnaie virtuelle",
"description": "Récupère des informations sur un package de monnaie virtuelle au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"summary": "Lire une liste d'objets virtuels",
"description": "Récupère une liste d'objets virtuels pour la constitution d'un catalogue.\n\n\n Remarque
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Voir aussi : L'appel API Lire la liste de tous les objets virtuels pour la recherche ou l'indexation côté client.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
},
{
"$ref": "#/components/parameters/show_inactive_time_limited_items-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Lire un objet virtuel par UGS",
"description": "Récupère des informations sur un objet virtuel par son UGS pour la constitution d'un catalogue.\n\n\n
Remarque\n Cet appel API renvoie des données génériques du catalogue d'objets lorsqu'il est utilisé sans autorisation. Utilisez l'autorisation pour récupérer\n des
données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT de l'utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Remarque
\n Retourne uniquement l'UGS de l'objet, le nom, les groupes et la description.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Voir aussi : L'appel API Lire la liste des objets virtuels pour récupérer des données détaillées sur les objets avec pagination.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-all-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"summary": "Lire une liste de monnaies virtuelles",
"description": "Récupère une liste de monnaies virtuelles pour la constitution d'un catalogue.\n\n\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
NoteIn general, the use of catalog of items is available without authorization.
Only authorized users can get
a personalized catalog. ",
"operationId": "get-item-groups",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/with_geo-query-param"
}
],
"tags": [
"item-groups-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups": {
"get": {
"summary": "Lire la liste des groupes d'objets",
"description": "Récupère la liste complète des groupes d'objets au sein d'un projet sans pagination à des fins d'administration.\n\n",
"operationId": "admin-get-item-group-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Créer un groupe d'objets",
"description": "Crée un groupe d'objets au sein d'un projet.\nPour récupérer des groupes d'objets pour la création d'un catalogue, utilisez l'endpoint côté client Lire la liste des groupes d'objets.",
"operationId": "admin-create-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_create"
},
"responses": {
"201": {
"$ref": "#/components/responses/ItemGroup_201-admin-create-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups/{external_id}": {
"get": {
"summary": "Lire un groupe d'objets par ID externe",
"description": "Récupère un groupe d'objets par son ID externe à des fins d'administration.\n\n",
"operationId": "admin-get-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
},
"put": {
"summary": "Mettre à jour un groupe d'objets",
"description": "Met à jour un groupe d'objets par son ID externe.",
"operationId": "admin-update-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_update"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-update-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
},
"delete": {
"summary": "Supprimer un groupe d'objets",
"description": "Supprime un groupe d'objets par son ID externe.",
"operationId": "admin-delete-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-delete-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-delete"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups": {
"get": {
"summary": "Lire une liste des groupes d'objets filtrée par type d'objet",
"description": "Retrieves item group list with filtering by item type. Only items of the specified type are counted for the group. This is similar to the [Get item group list](/fr/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-list-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": {
"get": {
"summary": "Lire un groupe d'objets par ID externe filtré par type d'objet",
"description": "Retrieves an item group by external ID. Only items of the specified type are counted for the group. This is similar to the [Get item group by external ID](/fr/api/catalog/item-groups-admin/admin-get-item-group) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/group/order": {
"put": {
"summary": "Réorganiser les groupes d'objets",
"description": "Définit l'ordre d'affichage des groupes d'objets au sein d'un projet. Passez un tableau de groupes avec leurs nouvelles valeurs d'ordre.",
"operationId": "admin-reorder-item-groups",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/{external_id}/order/item": {
"put": {
"summary": "Réorganiser les objets au sein d'un groupe (par ID externe)",
"description": "Définit l'ordre d'affichage des objets au sein d'un groupe identifié par son ID externe. Passez un tableau d'objets avec leurs nouvelles valeurs d'ordre.",
"operationId": "admin-reorder-items-in-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/id/{id}/order/item": {
"put": {
"summary": "Réorganiser les objets au sein d'un groupe (par ID)",
"description": "Définit l'ordre d'affichage des objets au sein d'un groupe identifié par son ID numérique interne. Passez un tableau d'objets avec leurs nouvelles valeurs d'ordre.",
"operationId": "admin-reorder-items-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": {
"post": {
"summary": "Créer une commande à partir d'un objet spécifique en monnaie virtuelle",
"description": "Crée un achat d'objet en utilisant la monnaie virtuelle.
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Note
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-game-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-games-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/sku/{item_sku}": {
"get": {
"summary": "Lire un jeu (administrateur)",
"description": "Récupère des informations sur un jeu au sein d'un projet à des fins d'administration.\nLe jeu consiste en des clés de jeu qui peuvent être achetées par un utilisateur.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jeu non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Mettre à jour un jeu par UGS",
"description": "Met à jour les informations d'un jeu dans le projet par UGS.",
"operationId": "admin-update-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Le jeu a été mis à jour avec succès."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jeu non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer un jeu par UGS",
"description": "Supprime un jeu dans le projet par UGS.",
"operationId": "admin-delete-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Le jeu a été supprimé avec succès."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/id/{item_id}": {
"get": {
"summary": "Lire un jeu par ID (administrateur)",
"description": "Récupère des informations sur un jeu au sein d'un projet à des fins d'administration.\nLe jeu consiste en des clés de jeu qui peuvent être achetées par un utilisateur.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jeu non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Mettre à jour un jeu par ID",
"description": "Met à jour les informations d'un jeu dans le projet par son ID.",
"operationId": "admin-update-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Le jeu a été mis à jour avec succès."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jeu non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer un jeu par ID",
"description": "Supprime un jeu du projet par son ID.",
"operationId": "admin-delete-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Le jeu a été supprimé avec succès."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": {
"post": {
"summary": "Télécharger des codes",
"description": "Télécharge des codes par UGS de clé de jeu.",
"operationId": "admin-upload-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID de la région."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
},
"required": true
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": {
"post": {
"summary": "Télécharger des codes par ID",
"description": "Télécharge des codes par ID de clé de jeu.",
"operationId": "admin-upload-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID de la région."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": {
"get": {
"summary": "Lire des informations sur la session de chargement des codes",
"description": "Récupère des informations sur la session de chargement des codes.",
"operationId": "admin-get-codes-session",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "session_id",
"in": "path",
"required": true,
"description": "ID de la session.",
"schema": {
"type": "string",
"default": "fc7105b6e8ee01339582970b37697242"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Session de chargement des codes non trouvée."
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": {
"get": {
"summary": "Lire des codes",
"description": "Récupère un certain nombre de codes par UGS de clé de jeu.",
"operationId": "admin-get-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": {
"get": {
"summary": "Lire des codes par ID",
"description": "Récupère un certain nombre de codes par ID de clé de jeu.",
"operationId": "admin-get-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": {
"delete": {
"summary": "Supprimer les codes",
"description": "Supprime tous les codes par UGS de clé de jeu.",
"operationId": "admin-delete-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": {
"delete": {
"summary": "Supprimer des codes par ID",
"description": "Supprime tous les codes par ID de clé de jeu.",
"operationId": "admin-delete-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Clé de jeu ou région introuvable.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/entitlement": {
"get": {
"tags": [
"game-keys-entitlement"
],
"operationId": "get-user-games",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/sandbox-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-entitlement-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-user-entitlement-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
},
"summary": "Lire la liste des jeux qu'un utilisateur détient",
"description": "Récupère la liste des jeux que l'utilisateur détient. La réponse contiendra un tableau de jeux qu'un utilisateur spécifique détient.\n\n\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Remarque
\n Vous pouvez utiliser des codes uniquement pour une plateforme sans DRM.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Attention
Seuls les codes de jeu ou les jeux pour une plateforme sans DRM peuvent être accordés.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"code": {
"type": [
"string",
"null"
],
"example": "AAAA-BBBB-CCCC-DDDD",
"description": "Game code of the game."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode."
},
"user_country": {
"type": [
"string",
"null"
],
"example": "US",
"description": "User's country."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/entitlement/revoke": {
"post": {
"tags": [
"game-keys-entitlement"
],
"operationId": "revoke-entitlement-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"204": {
"description": "Révoqué avec succès."
},
"403": {
"$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent"
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 5103
},
"errorMessage": {
"type": "string",
"example": "[0401-5103]: Selected drm is not drmfree."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"DRM is not DRM free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
}
}
}
}
}
},
"summary": "Révoquer un droit (administrateur)",
"description": "Retire les droits à l'utilisateur.\n\nAttention
Seuls les codes de jeu ou les jeux pour une plateforme sans DRM peuvent être retirés.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/items/bundle": {
"get": {
"summary": "Lire une liste de lots",
"description": "Récupère la liste des lots au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-bundle-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Créer un lot",
"description": "Crée un lot : un ensemble d'objets vendus comme une seule unité. Un lot peut contenir des objets virtuels, des packages de monnaie virtuelle, des clés de jeu et d'autres lots. Pour en savoir plus, consultez la section [Lots](https://developers.xsolla.com/fr/items-catalog/items-type/bundles/).\n\nRemarque
Tous les objets dans le tableau content doivent être créés à l'avance dans le projet. Le système renvoie une erreur si l'UGS spécifiée n'existe pas.
",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"201": {
"$ref": "#/components/responses/Bundles_201-admin-create-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": {
"get": {
"summary": "Lire la liste des lots par ID d'un groupe spécifique",
"description": "Récupère la liste des lots au sein d'un groupe à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-bundle-list-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": {
"get": {
"summary": "Lire la liste des lots par external ID d'un groupe spécifique",
"description": "Récupère la liste des lots au sein d'un groupe à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-bundle-list-in-group-by-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}": {
"put": {
"summary": "Mettre à jour un lot",
"description": "Mettre à jour un lot. Cet appel remplace entièrement le lot : passez tous les champs requis dans le corps de la requête, pas uniquement ceux à modifier. Pour en savoir plus, consultez la section [Lots](https://developers.xsolla.com/fr/items-catalog/items-type/bundles/).\n\nRemarque
Tous les objets dans le tableau content doivent être créés à l'avance dans le projet. Le système renvoie une erreur si l'UGS spécifiée n'existe pas.
",
"operationId": "admin-update-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-update-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
},
"delete": {
"summary": "Supprimer un lot",
"description": "Supprime un lot.",
"operationId": "admin-delete-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-delete-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Lire un lot",
"description": "Récupère des informations sur un lot au sein d'un projet à des fins d'administration.\n\nNote
N'utilisez pas cet endpoint pour créer un catalogue de magasin.
",
"operationId": "admin-get-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": {
"put": {
"summary": "Afficher un lot dans le catalogue",
"description": "Affiche un lot dans un catalogue.",
"operationId": "admin-show-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-show-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": {
"put": {
"summary": "Masquer un lot dans le catalogue",
"description": "Masque un lot dans un catalogue.",
"operationId": "admin-hide-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-hide-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"summary": "Lire une liste de lots",
"description": "Récupère une liste de lots pour la constitution d'un catalogue.\n\n\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Remarque Étant donné que cette méthode se base sur l'adresse IP pour déterminer le pays de l'utilisateur et sélectionner la devise de la commande, il est important de l'utiliser exclusivement côté client et non côté serveur. L'utilisation de cette méthode côté serveur pourrait entraîner une détermination incorrecte de la devise, ce qui pourrait affecter les modes de paiement dans
Pay Station.
",
"operationId": "create-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/cart": {
"post": {
"summary": "Créer une commande à partir de tous les objets du panier actuel",
"description": "Utilisé pour l'intégration client-serveur. Crée une commande à partir de tous les objets du panier et génère un jeton de paiement pour cette commande. La commande créée aura le statut `new`.\n\nL'adresse IP du client est utilisée pour déterminer le pays de l'utilisateur, qui est ensuite utilisé pour appliquer la devise appropriée et les modes de paiement disponibles pour la commande.\n\nPour ouvrir l'interface de paiement dans une nouvelle fenêtre, utilisez le lien suivant : `https://secure.xsolla.com/paystation4/?token={token}`, où `{token}` est le jeton reçu.\n\nÀ des fins de test, utilisez cette URL : `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nRemarque Étant donné que cette méthode se base sur l'adresse IP pour déterminer le pays de l'utilisateur et sélectionner la devise de la commande, il est important de l'utiliser exclusivement côté client et non côté serveur. L'utilisation de cette méthode côté serveur pourrait entraîner une détermination incorrecte de la devise, ce qui pourrait affecter les modes de paiement dans
Pay Station.
",
"operationId": "create-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}": {
"post": {
"summary": "Créer une commande à partir d'un objet spécifique",
"description": "Utilisé pour l'intégration client-serveur. Crée une commande avec un objet spécifié et génère un jeton de paiement pour celle-ci. La commande créée reçoit le statut `new`.\n\nL'adresse IP du client est utilisée pour déterminer le pays de l'utilisateur, qui est ensuite utilisé pour appliquer la devise appropriée et les modes de paiement disponibles pour la commande.\n\nPour ouvrir l'interface de paiement dans une nouvelle fenêtre, utilisez le lien suivant : `https://secure.xsolla.com/paystation4/?token={token}`, où `{token}` est le jeton reçu.\n\nÀ des fins de test, utilisez cette URL : `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nRemarque Étant donné que cette méthode se base sur l'adresse IP pour déterminer le pays de l'utilisateur et sélectionner la devise de la commande, il est important de l'utiliser exclusivement côté client et non côté serveur. L'utilisation de cette méthode côté serveur pourrait entraîner une détermination incorrecte de la devise, ce qui pourrait affecter les modes de paiement dans
Pay Station.
\n\n
\n\n\n Note
\n Cet appel API utilise un JWT utilisateur pour l'autorisation.
\n Incluez le jeton dans l'en-tête Authorization au format suivant : Bearer <user_JWT>. Pour plus d'informations sur le JWT utilisateur, consultez le bloc Security pour cet appel.\n
",
"operationId": "create-order-with-item",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid"
}
}
}
},
"/v2/project/{project_id}/free/cart": {
"post": {
"summary": "Créer une commande à partir d'un panier gratuit",
"description": "Crée une commande à partir de tous les objets d'un panier gratuit. La commande créée aura le statut `done`.",
"operationId": "create-free-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/cart/{cart_id}": {
"post": {
"summary": "Créer une commande à partir d'un panier gratuit spécifique",
"description": "Crée une commande à partir de tous les biens d'un panier gratuit spécifique. La commande créée aura le statut `done`.",
"operationId": "create-free-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/item/{item_sku}": {
"post": {
"summary": "Créer une commande à partir d'un bien gratuit spécifique",
"description": "Crée une commande pour un objet gratuit spécifique. La commande créée reçoit le statut `done`.
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Remarque\n
\n Le paramètre
user.country.value est utilisé pour sélectionner une devise pour la commande. Si le pays de l'utilisateur est inconnu,\nfournir l'adresse IP de l'utilisateur dans l'en-tête
X-User-Ip est une option alternative.
L'une de ces deux options est nécessaire au bon fonctionnement de cette méthode.
La devise sélectionnée est utilisée pour les méthodes de paiement sur
Pay Station.\n
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token"
},
"responses": {
"201": {
"$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token"
}
}
}
},
"/v2/admin/project/{project_id}/cart/fill": {
"put": {
"summary": "Remplir le panier d'objets",
"description": "Remplit d'objets le panier actuel. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.",
"operationId": "admin-cart-fill",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/admin/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"summary": "Remplir le panier d'objets par ID de panier",
"description": "Remplit d'objets le panier par son ID. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.",
"operationId": "admin-fill-cart-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-items-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Actualiser toutes les limites d'achat pour un utilisateur spécifique",
"description": "Actualise toutes les limites d'achat de tous les objets pour un utilisateur spécifique afin qu'il puisse à nouveau acheter ces objets.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "La limite a été actualisée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"User not found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User"
}
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Actualiser la limite d'achat",
"description": "Actualise les limites d'achat pour un objet afin que l'utilisateur puisse l'acheter à nouveau. Si le paramètre *user* est défini sur `null`, cet appel actualise ces limites pour tous les utilisateurs.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "La limite a été actualisée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Lire le nombre d'objets offerts pour un utilisateur spécifique",
"description": "Récupère le nombre restant d'objets disponibles pour l'utilisateur spécifié dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Augmenter le nombre d'objets offerts pour un utilisateur spécifique",
"description": "Augmente le nombre restant d'objets disponibles pour un utilisateur spécifique dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Définir le nombre d'objets offerts pour un utilisateur spécifique",
"description": "Définit le nombre d'objets qu'un utilisateur spécifique peut acheter dans la limite appliquée après une augmentation ou une diminution.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Réduire le nombre d'objets offerts pour un utilisateur spécifique",
"description": "Réduit le nombre restant d'objets offerts pour un utilisateur spécifique dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v1/projects/{project_id}/import/from_external_file": {
"post": {
"tags": [
"connector-admin"
],
"operationId": "import-items-from-external-file",
"summary": "Importer des objets via un fichier JSON",
"description": "Importe des objets dans le magasin à partir d'un fichier JSON via l'URL spécifiée. Pour plus d'informations, consultez la [documentation](https://developers.xsolla.com/fr/doc/shop-builder/how-to/json-import/).",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"responses": {
"201": {
"description": "Fichier importé avec succès, traitement en cours.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"import_id": {
"type": "string",
"example": "af9f3638a16e11ef880da2cd677d2d24",
"description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com."
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/connector-422-validation-failed"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/connector-import-items-body"
}
}
},
"/v1/admin/projects/{project_id}/connectors/import_items/import/status": {
"get": {
"tags": [
"connector-admin"
],
"operationId": "get-items-import-status",
"summary": "Lire le statut de l'importation d'objets",
"description": "Récupère des informations sur la progression de l'importation d'objets dans le projet. Cet appel API récupère des données sur la dernière importation effectuée par le biais de l'API ou du Compte éditeur.",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-items-import-status-model"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
]
}
},
"/v2/project/{project_id}/admin/webhook/version": {
"put": {
"tags": [
"common-webhooks"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-webhook-version",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Update webhook version",
"description": "Updates the webhook version for the project. In version 2, additional parameters are included in the `items` array.\n\nFor more information about webhooks, see the [Set up order status tracking](https://developers.xsolla.com/fr/doc/shop-builder/integration-guide/set-up-webhooks/).",
"responses": {
"204": {
"description": "Webhook version is successfully updated."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"422": {
"description": "Request validation error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request-extended"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "version",
"message": "Must have a minimum value of 1"
}
],
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Webhook version. Version 1 is used by default. In version 2, the `items` array includes the following parameters: `is_free`, `is_bonus`, and `is_bundle_content` parameters.",
"enum": [
1,
2
],
"example": 2
}
},
"required": [
"version"
]
},
"example": {
"version": 2
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Lire des informations sur la limite de pré-commande d'un objet",
"description": "Récupère des information sur la limite de pré-commande pour un objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section Administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"200": {
"description": "Les informations relatives à la limite de pré-commande de l'objet ont été reçues avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "com.xsolla.item_1"
},
"is_pre_order_limit_enabled": {
"type": "boolean",
"example": true
},
"available": {
"type": "integer",
"example": 431
},
"reserved": {
"type": "integer",
"example": 13
},
"sold": {
"type": "integer",
"example": 556
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.item_1",
"is_pre_order_limit_enabled": true,
"available": 431,
"reserved": 13,
"sold": 556
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
}
},
"post": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Ajouter une quantité à la limite de pré-commande pour un objet",
"description": "Ajoute une quantité à la limite de pré-commande pour un objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section Administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"201": {
"description": "La quantité de la limite a été ajoutée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to add."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Définir une quantité de la limite de pré-commande pour un objet",
"description": "Définit une quantité de limite de pré-commande pour un objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section Administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "La quantité de la limite a été définie avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to set."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Supprimer une quantité de la limite de pré-commande pour un objet",
"description": "Supprime une quantité de la limite de pré-commande pour un objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section Administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "La quantité de la limite a été supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to remove."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": {
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "toggle-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Basculer la limite de pré-commande pour un objet",
"description": "Activer/désactiver la limite de pré-commande de l'objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "La limite a été désactivée/activée."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"is_pre_order_limit_enabled": {
"type": "boolean"
}
},
"required": [
"is_pre_order_limit_enabled"
]
},
"example": {
"is_pre_order_limit_enabled": true
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-all-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Supprimer toute la quantité de la limite de pré-commande pour un objet",
"description": "Supprime toute la quantité de limite de pré-commande pour un objet.\n\nL'API des limites de précommande vous permet de vendre un objet en quantité limitée. Pour configurer la pré-commande, accédez à la section administrateur du module de l'objet souhaité :\n* [Clés de jeu](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-game/)\n* [Objets et monnaie virtuels](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Lots](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-get-bundle-list/)\n\nAlias pour cet endpoint :\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "La limite a été supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Objet non trouvé."
}
}
}
},
"/v2/merchant/{merchant_id}/projects": {
"get": {
"tags": [
"common-merchant"
],
"operationId": "get-projects",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"security": [
{
"basicMerchantAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/merchant_id-path-param"
}
],
"summary": "Lire les projets",
"description": "Récupère la liste des projets du commerçant.\n\n\n
Remarque
Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour configurer l'autorisation.
\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
\n Attention
\n Tous les projets sont soumis à une limite de nombre d'objets pouvant être\n retourné dans une réponse. La valeur par défaut et maximale est de 50 objets\n par réponse. Pour récupérer davantage de données page par page, utilisez les champs limit\n et offset.\n
\n\n
\n\n\n
Note\n Cet appel API renvoie des données génériques du catalogue des objets lorsqu'il est utilisé sans\n autorisation. Utilisez l'autorisation pour récupérer\n
des données utilisateur personnalisées, telles que les limites et les promotions associées à l'objet.\n Pour ce faire, passez le JWT utilisateur dans l'en-tête
Authorization.\n Pour plus d'informations sur le JWT utilisateur, consultez le bloc
Security\n pour cet appel.\n
Note
Si vous supprimez un attribut de bien, toutes ses données et connexions avec les objets seront perdues.
",
"operationId": "delete-attribute",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "L'attribut a été supprimé avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value": {
"post": {
"summary": "Créer une valeur d'attribut",
"description": "Crée une valeur d'attribut.\n\nAttention
Tous les projets sont soumis à une limite du nombre de valeurs d'attribut. La valeur par défaut et la valeur maximale sont de 20 valeurs par attribut.
",
"operationId": "admin-create-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-attribute-value"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Supprimer toutes les valeurs d'un attribut",
"description": "Supprime toutes les valeurs de l'attribut.\n\nNoteSi vous supprimez la valeur d'un attribut, toutes les connexions entre cet attribut et les objets seront perdues. Pour modifier la valeur de l'attribut de bien, utilisez l'appel API
Mettre à jour une valeur d'attribut au lieu de supprimer la valeur et d'en créer une nouvelle.
",
"operationId": "admin-delete-all-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Les valeurs de l'attribut ont été supprimées avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": {
"put": {
"summary": "Mettre à jour une valeur d'attribut",
"description": "Met à jour les valeurs d'un attribut.",
"operationId": "admin-update-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "La valeur de l'attribut a été mise à jour avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-value-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Supprimer une valeur d'attribut",
"description": "Supprime une valeur de l'attribut.\n\nNoteSi vous supprimez la valeur d'un attribut, toutes les connexions entre cet attribut et les objets seront perdues. Pour modifier la valeur de l'attribut de bien, utilisez l'appel API
Mettre à jour une valeur d'attribut au lieu de supprimer la valeur et d'en créer une nouvelle.
",
"operationId": "admin-delete-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Administrateur",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "La valeur de l'attribut a été supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"description": "Les appels côté serveur utilisent le schéma d'authentification `basicAuth`. Toutes les requêtes à l'API doivent\ncontenir l'en-tête `Authorization: Basic `\noù `your_authorization_basic_key` est la paire `project_id:api_key`\nencodée en Base64.\n\nVous pouvez utiliser `merchant_id` au lieu de `project_id` si nécessaire. Cela n'affecte pas la fonctionnalité.\n\nAccédez au [Compte éditeur](https://publisher.xsolla.com/) pour trouver les valeurs des paramètres :\n\n* `merchant_id` s'affiche :\n * Dans la section **Company settings > Company**\n * Dans l'URL dans la barre d'adresse du navigateur sur n'importe quelle page du Compte éditeur. L'URL présente le format suivant : `https://publisher.xsolla.com/`.\n* `api_key` s'affiche dans le Compte éditeur une seule fois lors de sa création et doit être stockée de votre côté. Vous pouvez créer une nouvelle clé dans les sections suivantes :\n * [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n * [Project settings > API keys](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Remarque**\n\nSi un appel API requis n'inclut pas le paramètre de chemin `project_id`, utilisez une clé API valide pour tous les projets de l'entreprise pour l'autorisation.\n{% /html %}\n\n* `project_id` s'affiche :\n * Dans le Compte éditeur à côté du nom du projet.\n * Dans l'URL dans la barre d'adresse du navigateur lorsque vous utilisez le projet dans le Compte éditeur. L'URL a le format suivant : `https://publisher.xsolla.com//projects/`.\n\nPour plus d'informations sur l'utilisation des clés API, voir la [référence API](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview).",
"scheme": "basic"
},
"XsollaLoginUserJWT": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Les appels côté client utilisent le schéma d’authentification `XsollaLoginUserJWT`. La requête doit inclure le JWT utilisateur dans l’en-tête `Authorization` au format suivant : Bearer ``. Ce jeton identifie l’utilisateur et donne accès à des données personnalisées. Pour découvrir comment créer un jeton, consultez la [documentation Xsolla Login API](/fr/api/login/authentication-schemes#getting-user-token).\n\nVous pouvez également utiliser un [jeton pour ouvrir l’interface de paiement](/fr/api/pay-station/token/create-token)."
},
"AuthForCart": {
"type": "http",
"scheme": "bearer",
"description": "Le schéma d’authentification `AuthForCart` est utilisé pour les achats via le panier et prend en charge deux modes :\n\n1. Authentification par JWT utilisateur. Le jeton est passé dans l'en-tête Authorization au format suivant : `Authorization: Bearer `, où `` est le jeton utilisateur. Le jeton identifie l'utilisateur et donne accès à des données personnalisées.\n\nVous pouvez également utiliser un [jeton pour ouvrir l’interface de paiement](/fr/api/pay-station/token/create-token).\n\n2. Mode simplifié sans en-tête `Authorization`. Ce mode est uniquement destiné aux utilisateurs non authentifiés et peut être utilisé uniquement pour la [vente de clés de jeu](/fr/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Au lieu d’un jeton, la requête doit inclure les en-têtes suivants :\n* `x-unauthorized-id` avec un ID de requête\n* `x-user` avec l’adresse e-mail de l’utilisateur encodée en Base64."
},
"basicMerchantAuth": {
"type": "http",
"description": "Les appels côté serveur utilisent le schéma d'authentification `basicMerchantAuth`. Toutes les requêtes à l'API doivent\ncontenir l'en-tête `Authorization: Basic `\noù `your_authorization_basic_key` est la paire `merchant_id:api_key`\nencodée en Base64.\n\nAccédez au [Compte éditeur](https://publisher.xsolla.com/) pour trouver les valeurs des paramètres :\n\n* `merchant_id` s'affiche :\n * Dans la section **Company settings > Company**\n * Dans l'URL dans la barre d'adresse du navigateur sur n'importe quelle page du Compte éditeur. L'URL présente le format suivant : `https://publisher.xsolla.com/`\n* `api_key` est affiché dans le Compte éditeur une seule fois lors de sa création et doit être stocké de votre côté. Vous pouvez créer une nouvelle clé dans la section [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key).\n\nPour plus d'informations sur l'utilisation des clés API, voir la [référence API](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview).",
"scheme": "basic"
}
},
"parameters": {
"project_id-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID du projet. Vous trouverez ce paramètre dans le [Compte éditeur](https://publisher.xsolla.com/0/projects/0/), à côté du nom du projet, ainsi que dans l'URL affichée dans la barre d'adresse du navigateur lorsque vous utilisez ce projet. L'URL présente le format suivant : `https://publisher.xsolla.com//projects/`.",
"schema": {
"type": "integer",
"example": 44056
}
},
"limit-query-param": {
"name": "limit",
"in": "query",
"example": 50,
"required": false,
"description": "Nombre maximal d'éléments sur une page.",
"schema": {
"type": "integer",
"example": 50,
"minimum": 1
}
},
"offset-query-param": {
"name": "offset",
"in": "query",
"required": false,
"example": 0,
"description": "Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).",
"schema": {
"type": "integer",
"example": 0,
"minimum": 0
}
},
"external_id-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "[ID externe du groupe d'objets](/fr/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) défini lors de sa création.",
"schema": {
"type": "string",
"example": "weapons"
}
},
"group_id-path-param": {
"name": "group_id",
"in": "path",
"required": true,
"description": "ID du groupe.",
"schema": {
"type": "integer",
"example": 10
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "UGS de l'objet.",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"virtual_currency_sku-path-param": {
"name": "virtual_currency_sku",
"in": "path",
"required": true,
"description": "UGS de la monnaie virtuelle.",
"schema": {
"type": "string",
"example": "crystal"
}
},
"locale-query-param": {
"name": "locale",
"in": "query",
"required": false,
"description": "Langue de la réponse. Code de langue ISO 639-1 à deux lettres en minuscules (par exemple, `en`). Les codes régionaux à cinq caractères (par exemple, `en-US`) sont pris en charge dans les champs localisables tels que `name` et `description`, mais sont normalisés en codes à deux lettres dans les réponses. La liste complète des langues prises en charge est disponible dans la [documentation](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-languages/).",
"schema": {
"type": "string",
"default": "en"
}
},
"additional_fields-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Champs supplémentaires à inclure dans la réponse. Par défaut, ces champs ne sont pas renvoyés. Passez les valeurs requises pour les inclure.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"media_list",
"order",
"long_description",
"custom_attributes",
"item_order_in_group"
]
}
}
},
"country-query-param": {
"name": "country",
"in": "query",
"required": false,
"description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Consultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/) et [le processus de détermination du pays](https://developers.xsolla.com/fr/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination).",
"schema": {
"type": "string",
"example": "US"
}
},
"promo_code-query-param": {
"name": "promo_code",
"in": "query",
"required": false,
"description": "Code unique sensible à la casse. Comprend des lettres et des chiffres.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"show_inactive_time_limited_items-query-param": {
"name": "show_inactive_time_limited_items",
"in": "query",
"required": false,
"description": "Affiche les objets à durée limitée qui ne sont pas disponibles pour l'utilisateur. La période de validité de ces objets n'ayant pas commencé ou ayant déjà expiré.",
"schema": {
"type": "integer",
"example": 1,
"default": 0
}
},
"virtual_currency_package_sku-path-param": {
"name": "virtual_currency_package_sku",
"in": "path",
"required": true,
"description": "UGS du package de monnaie virtuelle.",
"schema": {
"type": "string",
"example": "crystal-pack"
}
},
"with_geo-query-param": {
"name": "with_geo",
"in": "query",
"required": false,
"description": "Indique si les informations de langue et de pays de l'utilisateur doivent être renvoyées dans les en-têtes de la réponse. Lorsque la valeur est `true`, la réponse inclut les en-têtes `X-User-Locale-Code` et `X-User-Country-Code`.",
"schema": {
"type": "boolean",
"default": false
}
},
"item_type-group-path-param": {
"name": "item_type",
"in": "path",
"required": true,
"description": "Type d'objet utilisé pour filtrer les groupes. Détermine quels objets sont inclus dans `items_count`. Les valeurs contenant un caractère `/` (par exemple, `virtual_currency/package` ou `game/key`) doivent être encodées dans l'URL (par exemple, `virtual_currency%2Fpackage`).",
"schema": {
"type": "string",
"enum": [
"virtual_items",
"virtual_currency",
"virtual_currency/package",
"game/key",
"bundle",
"game",
"value_points",
"subscription_plans"
],
"example": "virtual_items"
}
},
"id-group-path-param": {
"name": "id",
"in": "path",
"required": true,
"description": "ID du groupe d'objets attribué par Xsolla. ",
"schema": {
"type": "integer",
"example": 1
}
},
"platform-query-param": {
"name": "platform",
"in": "query",
"required": false,
"description": "Plateforme de publication sur laquelle l'utilisateur joue : `xsolla` (par défaut), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, `pc_other`.",
"schema": {
"type": "string",
"enum": [
"playstation_network",
"xbox_live",
"xsolla",
"pc_standalone",
"nintendo_shop",
"google_play",
"app_store_ios",
"android_standalone",
"ios_standalone",
"android_other",
"ios_other",
"pc_other"
],
"default": "xsolla"
}
},
"item_id-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID de l'objet",
"schema": {
"type": "string",
"example": "656"
}
},
"user_email-query-param": {
"name": "user_email",
"in": "query",
"required": true,
"description": "Adresse e-mail de l'utilisateur.",
"schema": {
"type": "string",
"example": "email@email.com"
}
},
"quantity-query-param": {
"name": "quantity",
"in": "query",
"required": true,
"description": "Quantité de codes.",
"schema": {
"type": "integer",
"example": 100
}
},
"reason-query-param": {
"name": "reason",
"in": "query",
"required": true,
"description": "Raison pour laquelle les codes sont reçus.",
"schema": {
"type": "string",
"example": "Very important"
}
},
"region_id-query-param": {
"name": "region_id",
"in": "query",
"required": false,
"description": "ID de la région.",
"schema": {
"type": "integer",
"default": 1
}
},
"sandbox-query-param": {
"name": "sandbox",
"in": "query",
"required": false,
"description": "Quel type de droits doit être renvoyé. Si le paramètre est défini sur 1, les droits reçus par l'utilisateur en mode bac à sable sont renvoyés. Si le paramètre n'est pas passé ou est défini sur 0, les droits reçus par l'utilisateur en mode de production sont renvoyés.",
"schema": {
"type": "integer",
"default": 0
}
},
"additional_fields-entitlement-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête. Champs disponibles `attributes`.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"sku-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "UGS du lot.",
"schema": {
"type": "string",
"example": "kg_1"
}
},
"cart_id-path-param": {
"name": "cart_id",
"in": "path",
"required": true,
"description": "ID de panier.",
"schema": {
"type": "string",
"example": "custom_id"
}
},
"currency-query-param": {
"name": "currency",
"in": "query",
"required": false,
"description": "Devise du prix de l'objet affiché dans le panier. Code de devise à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/).",
"schema": {
"type": "string",
"default": "USD"
}
},
"order_id-path-param": {
"name": "order_id",
"in": "path",
"required": true,
"description": "ID de commande.",
"schema": {
"type": "string",
"example": "656"
}
},
"x-user-for-header": {
"in": "header",
"name": "x-user-for",
"example": "ACCESS_TOKEN/LOGIN_JWT",
"schema": {
"type": "string"
},
"required": false,
"description": "L'identifiant de l'utilisateur peut être passé en utilisant le JWT utilisateur Xsolla Login ou le [jeton d'accès Pay Station](https://developers.xsolla.com/fr/pay-station-api/current/token/create-token)."
},
"x-user-id-header": {
"in": "header",
"name": "x-user-id",
"example": "UNIQUE_ID",
"schema": {
"maxLength": 32,
"type": "string"
},
"required": false,
"description": "Vous pouvez utiliser votre propre ID utilisateur lorsque vous vendez un panier contenant des jeux."
},
"user_external_id-query-param": {
"name": "user_external_id",
"in": "query",
"required": true,
"description": "External ID de l'utilisateur",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"merchant_id-path-param": {
"name": "merchant_id",
"in": "path",
"required": true,
"description": "ID de commerçant.",
"schema": {
"type": "integer",
"example": 121212
}
},
"project_id_59080-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet.",
"schema": {
"type": "integer",
"example": 59080
}
},
"item_id_59080-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID de l'objet",
"schema": {
"type": "string",
"example": "259774"
}
},
"item_sku_59080-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "UGS de l'objet.",
"schema": {
"type": "string",
"example": "electric_shield"
}
},
"external_id_59080-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "External ID du groupe.",
"schema": {
"type": "string",
"default": "armour"
}
},
"region_id-path-param": {
"name": "region_id",
"in": "path",
"required": true,
"description": "ID de la région. Identifiant unique de la région au sein du projet.",
"schema": {
"type": "integer",
"example": 42
}
},
"external_id-attr-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "External ID de l'attribut.",
"schema": {
"type": "string",
"example": "attribute_id"
}
},
"value_external_id-path-param": {
"name": "value_external_id",
"in": "path",
"required": true,
"description": "External ID de la valeur de l'attribut.",
"schema": {
"type": "string",
"pattern": "^[-_\\.\\d\\w]+$",
"example": "value_id"
}
}
},
"schemas": {
"Virtual-Items-Currency_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "ID unique de l'attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des tirets et des traits bas."
},
"admin-attribute-name": {
"type": "object",
"description": "Objet contenant des versions localisées du nom de l'attribut. Les clés sont spécifiées selon la norme ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Genre",
"de": "Genre"
},
"default": {
"en": "Genre",
"de": "Genre"
}
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "ID unique de la valeur d'un attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas."
},
"value-name": {
"type": "object",
"description": "Objet contenant des versions localisées du nom de la valeur. Les clés sont spécifiées selon la norme ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Strategy",
"de": "Strategie"
},
"default": {
"en": "Strategy",
"de": "Strategie"
}
},
"attribute-value": {
"type": "object",
"required": [
"value",
"external_id"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_external_id",
"name": {
"en": "Value 1",
"de": "Wert 1"
}
}
},
"attribute": {
"type": "object",
"required": [
"external_id",
"values"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
},
"example": {
"external_id": "attribute_external_id",
"name": {
"en": "Attribute name",
"de": "Attributname"
},
"values": [
{
"external_id": "value_1",
"name": {
"en": "value 1",
"de": "wert 1"
}
},
{
"external_id": "value_2",
"name": {
"en": "value 2",
"de": "wert 2"
}
}
]
}
},
"Virtual-Items-Currency_schemas-admin-attributes": {
"type": "array",
"description": "Liste des attributs.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Virtual-Items-Currency_admin-attributes": {
"allOf": [
{
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes"
},
{
"description": "Liste des attributs."
}
]
},
"two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Codes de langue à deux lettres minuscules.",
"title": "two-letter",
"properties": {
"en": {
"type": [
"string",
"null"
],
"description": "Anglais"
},
"ar": {
"type": [
"string",
"null"
],
"description": "Arabe"
},
"bg": {
"type": [
"string",
"null"
],
"description": "Bulgare"
},
"cn": {
"type": [
"string",
"null"
],
"description": "Chinois (simplifié)"
},
"cs": {
"type": [
"string",
"null"
],
"description": "Tchèque"
},
"de": {
"type": [
"string",
"null"
],
"description": "Allemand"
},
"es": {
"type": [
"string",
"null"
],
"description": "Espagnol (Espagne)"
},
"fr": {
"type": [
"string",
"null"
],
"description": "Français"
},
"he": {
"type": [
"string",
"null"
],
"description": "Hébreu"
},
"it": {
"type": [
"string",
"null"
],
"description": "Italien"
},
"ja": {
"type": [
"string",
"null"
],
"description": "Japonais"
},
"ko": {
"type": [
"string",
"null"
],
"description": "Coréen"
},
"pl": {
"type": [
"string",
"null"
],
"description": "Polonais"
},
"pt": {
"type": [
"string",
"null"
],
"description": "Portugais"
},
"ro": {
"type": [
"string",
"null"
],
"description": "Roumain"
},
"ru": {
"type": [
"string",
"null"
],
"description": "Russe"
},
"th": {
"type": [
"string",
"null"
],
"description": "Thaï"
},
"tr": {
"type": [
"string",
"null"
],
"description": "Turc"
},
"tw": {
"type": [
"string",
"null"
],
"description": "Chinois (traditionnel)"
},
"vi": {
"type": [
"string",
"null"
],
"description": "Vietnamien"
},
"km": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id": {
"type": [
"string",
"null"
],
"description": "Indonésien"
},
"lo": {
"type": [
"string",
"null"
],
"description": "Laotien"
},
"my": {
"type": [
"string",
"null"
],
"description": "Birman"
},
"ph": {
"type": [
"string",
"null"
],
"description": "Philippin"
},
"ne": {
"type": [
"string",
"null"
],
"description": "Népalais"
}
}
},
"five-letter-locale": {
"type": [
"object",
"null"
],
"description": "Codes régionaux à cinq caractères.",
"title": "five-letter",
"properties": {
"en-US": {
"type": [
"string",
"null"
],
"description": "Anglais"
},
"ar-AE": {
"type": [
"string",
"null"
],
"description": "Arabe"
},
"bg-BG": {
"type": [
"string",
"null"
],
"description": "Bulgare"
},
"zh-CN": {
"type": [
"string",
"null"
],
"description": "Chinois (simplifié)"
},
"cs-CZ": {
"type": [
"string",
"null"
],
"description": "Tchèque"
},
"de-DE": {
"type": [
"string",
"null"
],
"description": "Allemand"
},
"es-ES": {
"type": [
"string",
"null"
],
"description": "Espagnol (Espagne)"
},
"fr-FR": {
"type": [
"string",
"null"
],
"description": "Français"
},
"he-IL": {
"type": [
"string",
"null"
],
"description": "Hébreu"
},
"it-IT": {
"type": [
"string",
"null"
],
"description": "Italien"
},
"ja-JP": {
"type": [
"string",
"null"
],
"description": "Japonais"
},
"ko-KR": {
"type": [
"string",
"null"
],
"description": "Coréen"
},
"pl-PL": {
"type": [
"string",
"null"
],
"description": "Polonais"
},
"pt-BR": {
"type": [
"string",
"null"
],
"description": "Portugais (Brésil)"
},
"ro-RO": {
"type": [
"string",
"null"
],
"description": "Roumain"
},
"ru-RU": {
"type": [
"string",
"null"
],
"description": "Russe"
},
"th-TH": {
"type": [
"string",
"null"
],
"description": "Thaï"
},
"tr-TR": {
"type": [
"string",
"null"
],
"description": "Turc"
},
"zh-TW": {
"type": [
"string",
"null"
],
"description": "Chinois (traditionnel)"
},
"vi-VN": {
"type": [
"string",
"null"
],
"description": "Vietnamien"
},
"km-KH": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id-ID": {
"type": [
"string",
"null"
],
"description": "Indonésien"
},
"lo-LA": {
"type": [
"string",
"null"
],
"description": "Laotien"
},
"my-MM": {
"type": [
"string",
"null"
],
"description": "Birman"
},
"ph-PH": {
"type": [
"string",
"null"
],
"description": "Philippin"
},
"ne-NP": {
"type": [
"string",
"null"
],
"description": "Népalais"
}
}
},
"name-localization-object": {
"type": [
"object",
"null"
],
"description": "Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme `en`) et les codes régionaux à cinq caractères (comme `en-US`). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, `en` et `en-US`), seule la dernière est conservée. Consultez la [documentation](/fr/doc/shop-builder/references/supported-languages/) pour la liste complète des langues prises en charge.",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"description-localization-object": {
"type": [
"object",
"null"
],
"description": "Conteneur objet contenant les localisations de la description de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme `en`) et les codes régionaux à cinq caractères (comme `en-US`). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, `en` et `en-US`), seule la dernière est conservée. Consultez la [documentation](/fr/doc/shop-builder/references/supported-languages/) pour la liste complète des langues prises en charge.",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"long-description-localization-object": {
"type": [
"object",
"null"
],
"description": "Conteneur objet contenant les localisations de la description complète de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme `en`) et les codes régionaux à cinq caractères (comme `en-US`). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, `en` et `en-US`), seule la dernière est conservée. Consultez la [documentation](/fr/doc/shop-builder/references/supported-languages/) pour la liste complète des langues prises en charge.",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"Virtual-Items-Currency_admin-groups-response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Nom de l'objet. Doit comprendre des paires clé/valeur\noù la clé est une région au format \"^[a-z]{2}\", la valeur est une chaîne.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Virtual-Items-Currency_admin-media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ressources supplémentaires de l'objet, telles que des captures d'écran, des vidéos de gameplay, etc.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Type de média : `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Fichier de ressources."
}
}
}
},
"Virtual-Items-Currency_type": {
"type": "string",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"Virtual-Items_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "Montant.",
"type": "number",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"country_iso": {
"type": "string",
"description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Consultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/).
Exemple : `country=US`",
"example": "US"
},
"is_default": {
"type": "boolean",
"default": false
},
"is_enabled": {
"type": "boolean",
"default": true
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true
}
}
},
"Virtual-Items-Currency_schemas-sku": {
"type": "string",
"example": "bundle_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"Virtual-Items-Currency_admin-get-vc_prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"amount"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"description": "Montant.",
"type": "number",
"exclusiveMinimum": 0
},
"is_default": {
"type": "boolean",
"default": false
}
},
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true
}
}
},
"Virtual-Items-Currency_admin-image_url": {
"type": "string",
"description": "URL de l'image. Pour garantir un affichage correct et un chargement rapide dans l'interface de paiement, consultez les recommandations suivantes pour les images et les URL :- Formats pris en charge : WebP (recommandé), PNG, JPG.
- Taille du fichier : ≤ 50 Kb (WebP) ou ≤ 150 Kb (PNG et JPG).
- Dimensions : 280 x 280 px.
- Espace colorimétrique : sRGB.
- Protocole : HTTPS avec mise en cache longue durée pour les URL versionnées.
"
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Détermine la gratuité de l'objet."
},
"value-is_paid_randomized_reward": {
"type": "boolean",
"example": false,
"default": false,
"description": "Si l’objet est une récompense payante aléatoire (par exemple, une boîte à butin)."
},
"Virtual-Items-Currency_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Ordre d'affichage de l'objet dans le catalogue. Plus la valeur est élevée, plus l'objet apparaît bas dans la liste.\nSi les valeurs sont identiques, les objets sont triés par date de création, les plus récents apparaissant en premier."
},
"Virtual-Items-Currency_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Indique si l'objet est disponible. Si la valeur est `false`, l'objet ne peut pas être acheté dans le magasin ni obtenu dans un lot ou dans une campagne marketing. Consultez la [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/items-availability/) pour plus d'informations sur la disponibilité des objets."
},
"Virtual-Items-Currency_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Indique si l'objet est affiché dans le catalogue. Si la valeur est `false` et que `is_enabled: true`, l'objet n'est pas visible dans le catalogue, mais peut être obtenu dans un lot ou dans une campagne marketing. Consultez la [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/items-availability/) pour plus d'informations sur la disponibilité des objets."
},
"Virtual-Items-Currency_admin-regions": {
"description": "Tableau des régions dans lesquelles l'objet est disponible. Si le tableau est vide ou non fourni, l'objet est disponible dans toutes les régions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1,
"description": "ID de la région au sein du projet.\n\nConsultez la [documentation sur les restrictions de vente régionales](https://developers.xsolla.com/fr/items-catalog/catalog-features/regional-restrictions/) et les [appels API de gestion des régions](https://developers.xsolla.com/fr/api/catalog/common-regions) pour plus d'informations."
}
}
}
},
"limit_exceeded_visibility": {
"type": "string",
"example": "show",
"enum": [
"show",
"hide"
],
"description": "Détermine la visibilité de l'objet dans le catalogue une fois la limite d'achat atteinte, jusqu'à la prochaine réinitialisation de la limite.\n\nS'applique aux objets pour lesquels des réinitialisations de limite récurrentes sont configurées dans le tableau `recurrent_schedule`.\n\nSi aucune réinitialisation de limite n'est configurée, l'objet n'apparaît plus dans le catalogue une fois la limite d'achat atteinte, quelle que soit la valeur de `limit_exceeded_visibility`.\n\nValeurs possibles :\n- `show` — L'objet est renvoyé dans les appels API de récupération du catalogue après avoir atteint la limite d'achat. Dans les appels côté client, une fois la limite atteinte, l'objet est renvoyé avec l'indicateur `can_be_bought: false`. La prochaine date de réinitialisation est renvoyée dans `reset_next_date`.\n- `hide` — L'objet n'est pas renvoyé dans les appels API de récupération du catalogue après avoir atteint la limite d'achat, jusqu'à la réinitialisation de la limite.",
"default": "show"
},
"admin_recurrent_schedule_response": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites pour un utilisateur.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Type quotidien d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de réinitialisation des limites (horodatage Unix). ",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date et heure de la première réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date et heure de réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": [
"integer",
"null"
],
"description": "Jour de la semaine où les limites sont actualisées. Où 1 correspond au lundi et 7 au dimanche. Ne prend pas la valeur `null`. Uniquement pour le type de délai d'actualisation de limites `weekly`.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de réinitialisation des limites (horodatage Unix). ",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date et heure de la première réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date et heure de réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Type mensuel d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": [
"integer",
"null"
],
"description": "Jour du mois où les limites sont actualisées. Si aucun jour du mois n'est sélectionné en raison d'un mois plus court, l'actualisation aura lieu le dernier jour du mois. Ne prend pas la valeur `null`. Uniquement pour le type de délai d'actualisation de limites `monthly`.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de réinitialisation des limites (horodatage Unix). ",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date et heure de la première réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date et heure de réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = horaire",
"description": "Réinitialisation des limites de l'utilisateur effectuée selon l'intervalle de temps spécifié, en heures.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"description": "Intervalle en heures après lequel la limite est mise à jour.
Le compte à rebours commence à partir du moment où l'objet est affiché pour la première fois dans le magasin, comme spécifié dans le paramètre date_from.
Par exemple, si `date_from = \"2025-11-15T18:15:00+05:00\"` et `hours_interval = 2`, la limite d'achat pour cet objet sera actualisée toutes les 2 h à partir de `\"2025-11-15T20:15:00+05:00\"`.",
"minimum": 1,
"maximum": 10000
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de réinitialisation des limites (horodatage Unix). ",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date et heure de la première réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date et heure de réinitialisation des limites (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
}
]
}
}
},
"admin-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Limites d'objets.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites d'objets pour un utilisateur spécifique.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter."
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limites globales d'objets.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter."
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter."
},
"reserved": {
"type": "integer"
},
"sold": {
"type": "integer"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule_response"
}
}
},
"item-periods-response": {
"type": "array",
"description": "Période de vente d'objets.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Date de mise en vente de l'objet spécifié."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Date de retrait de la vente de l'objet spécifié. Peut prendre la valeur `null`."
}
}
}
},
"item-custom-attributes-response": {
"type": "object",
"description": "Un JSON contenant les attributs de l'objet et leurs valeurs.",
"format": "json"
},
"Virtual-Items-Currency_admin-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"Virtual-Items-Currency_schemas-admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image. Pour garantir un affichage correct et un chargement rapide dans l'interface de paiement, consultez les recommandations suivantes pour les images et les URL :- Formats pris en charge : WebP (recommandé), PNG, JPG.
- Taille du fichier : ≤ 50 Kb (WebP) ou ≤ 150 Kb (PNG et JPG).
- Dimensions : 280 x 280 px.
- Espace colorimétrique : sRGB.
- Protocole : HTTPS avec mise en cache longue durée pour les URL versionnées.
"
},
"Virtual-Items-Currency_admin-groups-create": {
"type": "array",
"description": "Liste des [ID externes des groupes](/fr/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) auxquels l'objet appartient.\n\nExemple : [\"horror\", \"action\"]",
"items": {
"type": "string",
"properties": {
"external_id": {
"type": "string",
"example": "accessory"
},
"name": {
"type": "string",
"example": "Accessory"
}
}
}
},
"admin-post-put-attribute-item": {
"type": "object",
"required": [
"external_id",
"values"
],
"maxItems": 6,
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"description": "Attention. La création de plus de 6 valeurs pour un attribut n'est pas autorisée. Toute tentative de dépassement entraînera une erreur.
",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
}
},
"Virtual-Items-Currency_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste des attributs.\n\nAttention. La création de plus de 20 attributs pour un objet n'est pas autorisée. Toute tentative de dépassement entraîne une erreur.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Virtual-Items-Currency_admin-create-vc_prices": {
"description": "Tableau des prix des monnaies virtuelles.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"type": "integer",
"description": "Prix de l'objet en monnaie virtuelle."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Détermine s'il s'agit du prix par défaut en monnaie virtuelle."
},
"is_enabled": {
"type": "boolean",
"default": true,
"description": "Indique si ce prix est utilisé pour l'affichage dans le catalogue et pour l'achat de l'objet. Si la valeur est `false`, ce prix n'est pas utilisé."
}
},
"required": [
"amount",
"sku",
"is_default",
"is_enabled"
],
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true,
"is_enabled": true
}
}
},
"limit_per_user": {
"description": "Limites d'objets pour un utilisateur spécifique.",
"anyOf": [
{
"type": "null",
"description": "Aucune limite d’achat par utilisateur."
},
{
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.",
"example": 5
},
{
"type": "object",
"description": "Configuration détaillée des limites d'achat.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.",
"example": 5
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
}
]
},
"limit_per_item": {
"type": [
"integer",
"null"
],
"description": "Limites globales d'objets.",
"example": 10
},
"per_user_daily": {
"type": "object",
"title": "interval_type = daily",
"description": "Type quotidien d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Délai d'actualisation récurrent.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "02:00:00+03:00"
}
},
"required": [
"interval_type",
"time"
]
},
"per_user_weekly": {
"type": "object",
"title": "interval_type = weekly",
"description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Délai d'actualisation récurrent.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": "integer",
"description": "Jour de la semaine où les limites sont actualisées. Où 1 correspond au lundi et 7 au dimanche.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "11:00:00+03:00"
}
}
},
"per_user_monthly": {
"type": "object",
"title": "interval_type = monthly",
"description": "Type mensuel d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Délai d'actualisation récurrent.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": "integer",
"description": "Jour du mois où les limites sont actualisées. Si aucun jour du mois n'est sélectionné en raison d'un mois plus court, l'actualisation aura lieu le dernier jour du mois.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "23:00:00+03:00"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
"interval_type_hourly": {
"type": "string",
"description": "Délai d'actualisation récurrent.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_user_hourly_vi": {
"type": "object",
"title": "interval_type = horaire",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalle en heures, après lequel la limite est réinitialisée.
Le compte à rebours commence à partir du paramètre date_from.
Par exemple, si `date_start = \"2025-11-15T18:15:00+05:00\"` et `hours_interval = 2`, la limite pour cet objet se réinitialise toutes les 2 h à partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_item_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"description": "Réinitialisation des limites d'achat effectuée selon l'intervalle de temps spécifié, en heures.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vi"
}
]
}
}
},
"Virtual-Item-item-limit": {
"type": "object",
"description": "Limites d'objets.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_item_recurrent_schedule"
}
}
},
"item-periods": {
"type": [
"array",
"null"
],
"description": "Période de vente d'objets.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Date de mise en vente de l'objet spécifié."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Date de retrait de la vente de l'objet spécifié. Peut prendre la valeur `null`."
}
}
}
},
"item-custom-attributes": {
"type": "object",
"description": "Un JSON contenant les attributs de l'objet et leurs valeurs. Les attributs permettent d'ajouter des informations supplémentaires aux objets, telles que le niveau requis du joueur pour utiliser l'objet. Les attributs enrichissent la logique interne de votre jeu et sont accessibles via des méthodes GET et des webhooks spécifiques.",
"format": "json",
"maxLength": 500
},
"Virtual-Items-Currency_admin-create-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Item-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Virtual-Items-Currency_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"example": 10.5,
"description": "Prix de l'objet en monnaie réelle."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Indique s'il s'agit du prix par défaut en devise réelle. Consultez la [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) pour plus d'informations sur la configuration des prix."
},
"is_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "Indique si ce prix est utilisé pour l'affichage dans le catalogue et pour l'achat de l'objet. Si la valeur est `false`, ce prix n'est pas utilisé et un autre prix s'applique. Consultez la [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) pour plus d'informations sur la configuration des prix."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Pays où ce prix est disponible. Code à deux lettres selon la norme [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"per_user_hourly_vc": {
"type": "object",
"title": "interval_type = horaire",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalle en heures, après lequel la limite est réinitialisée.
Le compte à rebours commence à partir du paramètre date_from.
Par exemple, si `date_start = \"2025-11-15T18:15:00+05:00\"` et `hours_interval = 2`, la limite pour cet objet se réinitialise toutes les 2 h à partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"description": "Réinitialisation des limites d'achat effectuée selon l'intervalle de temps spécifié, en heures.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vc"
}
]
}
}
},
"Virtual-Currency-item-limit": {
"type": "object",
"description": "Limites d'objets.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"type": "object",
"required": [
"sku",
"name"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency-package": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"bundle_type": {
"type": "string",
"default": "virtual_currency_package",
"example": "virtual_currency_package"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"quantity": {
"type": "integer"
}
}
}
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"per_user_hourly_vcp": {
"type": "object",
"title": "interval_type = horaire",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalle en heures, après lequel la limite est réinitialisée.
Le compte à rebours commence à partir du paramètre date_from.
Par exemple, si `date_start = \"2025-11-15T18:15:00+05:00\"` et `hours_interval = 2`, la limite pour cet objet se réinitialise toutes les 2 h à partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_package_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"description": "Réinitialisation des limites d'achat effectuée selon l'intervalle de temps spécifié, en heures.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vcp"
}
]
}
}
},
"Virtual-Currency-Package-item-limit": {
"type": "object",
"description": "Limites d'objets.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"type": "object",
"required": [
"sku",
"name",
"description",
"content"
],
"anyOf": [
{
"required": [
"prices"
]
},
{
"required": [
"vc_prices"
]
}
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"content": {
"type": "array",
"minLength": 1,
"maxLength": 1,
"description": "Le package de monnaie virtuelle ne doit contenir qu'une seule position de monnaie virtuelle.",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"quantity": {
"type": "integer"
}
}
}
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-Package-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "Utilisé pour indiquer qu'il y a plus de pages."
},
"items_client_groups_response": {
"type": "array",
"example": [
{
"external_id": "exclusive",
"name": "Exclusive"
}
],
"default": [],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "[ID externe du groupe d'objets](/fr/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) défini lors de sa création.",
"example": "exclusive"
},
"name": {
"type": "string",
"description": "Nom du groupe.",
"example": "Exclusive"
},
"item_order_in_group": {
"type": "integer",
"description": "Position de l'objet dans le groupe, qui détermine son ordre d'affichage.\nRenvoyée uniquement si demandée via le paramètre de requête `additional_fields[]`.",
"example": 1
}
}
}
},
"Virtual-Items-Currency_client-attributes": {
"type": "array",
"description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "object",
"description": "Nom de l'attribut.",
"example": "Genre",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valeur de l'attribut.",
"example": "Strategy"
}
}
}
}
}
}
},
"client_virtual_prices_response": {
"type": "array",
"description": "Prix virtuels.",
"items": {
"type": "object",
"description": "Prix virtuel.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Prix de l'objet en monnaie virtuelle."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Prix de l'objet en monnaie virtuelle, hors remise. Il correspond toujours à `amount`, car les remises ne s'appliquent pas aux prix en monnaie virtuelle."
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "UGS de la monnaie virtuelle."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Détermine s'il s'agit du prix par défaut en monnaie virtuelle."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "URL de l'image de la monnaie virtuelle."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Nom de la monnaie virtuelle."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet. Pour la monnaie virtuelle, il s'agit de `virtual_currency`."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Virtual currency description."
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "Si `true`, l'utilisateur peut acheter l'objet."
},
"Catalog_item_promotions": {
"type": "array",
"description": "Promotions appliquées à des objets spécifiques du panier. Le tableau est renvoyé dans les cas suivants :\n\n* Une promotion par réduction est configurée pour un objet spécifique.\n\n* Un code promo avec le paramètre **Discount on selected items** est appliqué.\n\nSi aucune promotion de ce type n'est appliquée, un tableau vide est renvoyé.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Type d'objet bonus.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Nom de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`."
},
"image_url": {
"type": "string",
"description": "URL de l'image de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Type de lot bonus. Disponible uniquement pour le type d'objet `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"catalog_recurrent_schedule_client_response": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation récurrent des limites d'un objet pour un utilisateur.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Type quotidien d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"daily"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de la réinitialisation des limites (horodatage Unix).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"weekly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de la réinitialisation des limites (horodatage Unix).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Type mensuel d'actualisation des limites pour l'utilisateur.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"monthly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de la réinitialisation des limites (horodatage Unix).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = horaire",
"description": "Réinitialisation des limites de l'utilisateur effectuée selon l'intervalle de temps spécifié, en heures.",
"properties": {
"interval_type": {
"type": "string",
"description": "Type de délai d'actualisation récurrent.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date et heure de la réinitialisation des limites (horodatage Unix).",
"example": 1677553200
}
}
}
]
},
"client-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Limites d'objets.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites d'objets pour un utilisateur spécifique.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter."
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que l'utilisateur actuel peut acheter."
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limites globales d'objets.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter."
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter."
}
}
}
}
},
"item_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique de l'objet."
},
"value-point-sku": {
"type": "string",
"description": "ID unique du point de valeur."
},
"value-point-amount": {
"type": "integer",
"description": "Montant des points de valeur."
},
"value-point-name": {
"type": "string",
"description": "Nom du point de valeur."
},
"Common_admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"is_clan": {
"type": "boolean",
"description": "Détermine l'utilisation du point de valeur dans les chaînes de récompense de clan.",
"example": true
},
"client-item-value-point-reward": {
"type": "array",
"description": "Liste des récompenses en points de valeur associées à cet objet.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"Virtual-Items-Currency_item": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID de l'objet"
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "object",
"example": "Big Rocket",
"description": "Nom de l'objet.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "object",
"example": "Big Rocket - description",
"description": "Description de l'objet.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/client-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Catalog_item_limits": {
"description": "Limites d'objets.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites d'objets pour un utilisateur.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.",
"example": 5
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que l'utilisateur actuel peut acheter.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Informations sur les limites pour un objet.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.",
"example": 5
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Virtual-Items-Currency_virtual-currency": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "ID d'objet unique attribué par Xsolla."
},
"sku": {
"type": "string",
"example": "crystal",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response",
"example": [
{
"amount": 100,
"sku": "com.xsolla.crystals_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png"
}
]
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_virtual-currency-package": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "ID d'objet unique attribué par Xsolla."
},
"sku": {
"type": "string",
"example": "crystal-pack",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Crystal Pack",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "bundle",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`."
},
"bundle_type": {
"type": "string",
"example": "virtual_currency_package",
"description": "Type de lot. Toujours `virtual_currency_package` pour les packages de monnaie virtuelle."
},
"description": {
"type": "string",
"example": "Crystal Pack Description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet sans réduction."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"type": "array",
"example": [
{
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100
}
],
"description": "Contenu du package de monnaie virtuelle.",
"items": {
"type": "object",
"description": "Monnaie virtuelle dans le package.",
"properties": {
"item_id": {
"type": "integer",
"description": "ID d'objet unique attribué par Xsolla."
},
"sku": {
"type": "string",
"example": "com.xsolla.crystal_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Nom de l'objet."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet. Pour la monnaie virtuelle, il s'agit de `virtual_currency`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL de l'image."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Quantité de la monnaie virtuelle dans le package."
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-packages": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"group-name-localization-object": {
"type": [
"object",
"null"
],
"description": "Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/fr/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-description-localization-object": {
"type": [
"object",
"null"
],
"description": "Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/fr/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-image-url": {
"type": [
"string",
"null"
],
"description": "URL de l'image du groupe d'objets.",
"example": "https://example.com/weapons.png"
},
"group-display-order": {
"type": "integer",
"description": "Ordre d'affichage du groupe des objets dans le catalogue. Plus la valeur est élevée, plus le groupe apparaît bas dans la liste. Si les valeurs sont identiques, les groupes sont triés par date de création, les plus récents apparaissant en premier.",
"default": 1,
"example": 1
},
"group-is-enabled": {
"type": "boolean",
"description": "Indique si le groupe d'objets est activé dans le catalogue.",
"example": true,
"default": true
},
"admin-group-response-base": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID du groupe d'objets attribué par Xsolla. ",
"example": 1
},
"external_id": {
"type": "string",
"description": "ID externe du groupe d'objets défini lors de sa création.",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/group-image-url"
},
"order": {
"$ref": "#/components/schemas/group-display-order"
},
"is_enabled": {
"$ref": "#/components/schemas/group-is-enabled"
},
"items_count": {
"type": "integer",
"description": "Nombre total d'objets dans le groupe.",
"example": 5
}
},
"required": [
"id",
"external_id",
"name",
"is_enabled"
]
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "État de la réponse HTTP."
},
"errorCode": {
"type": "integer",
"description": "Code d'erreur."
},
"errorMessage": {
"type": "string",
"description": "Description courte de l'erreur."
},
"transactionId": {
"type": "string",
"description": "ID de requête. Identifiant utilisé pour suivre et associer les journaux liés à cette requête ou opération spécifique. Cet ID peut être utile pour le dépannage, le débogage et l'audit."
}
}
},
"admin-group-create-request": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID externe du groupe d'objets. Ne peut contenir que des caractères alphanumériques, des tirets et des tirets bas.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
],
"default": true
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Données sur le groupe d'objets",
"required": [
"external_id",
"name"
]
},
"error-message-extended-validation": {
"type": "array",
"description": "Informations sur l'erreur de validation. Contient un tableau d'erreurs au niveau des propriétés, indiquant les champs non validés et les raisons.",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "Nom du champ ayant échoué à la validation.",
"example": "external_id"
},
"message": {
"type": "string",
"description": "Message d'erreur de validation pour le champ.",
"example": "The property external_id is required"
}
}
}
},
"ItemGroup_422-invalid-request": {
"type": "object",
"required": [
"statusCode",
"errorCode",
"errorMessage",
"transactionId"
],
"properties": {
"statusCode": {
"type": "integer",
"description": "État de la réponse HTTP.",
"example": 422
},
"errorCode": {
"type": "integer",
"description": "Code d'erreur.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Description courte de l'erreur.",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"description": "ID de requête. Identifiant utilisé pour suivre et associer les journaux liés à cette requête ou opération spécifique. Cet ID peut être utile pour le dépannage, le débogage et l'audit.",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
}
}
},
"admin-group-update-request": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"external_id": {
"type": "string",
"description": "ID externe unique du groupe. Ne peut contenir que des caractères alphanumériques, des tirets et des tirets bas, et peut être utilisé pour renommer l'ID externe du groupe.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
]
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Données du groupe des objets à mettre à jour. Les champs `external_id` et `name` sont obligatoires dans chaque requête. Les autres champs sont facultatifs : les champs omis conserveront leurs valeurs actuelles.",
"required": [
"external_id",
"name"
]
},
"group-is-contains-any-items": {
"type": "boolean",
"description": "Indique si le groupe contient des objets, quelle que soit la valeur `item_type` spécifiée. Un groupe peut avoir `items_count: 0` pour le type indiqué, tandis que `is_contains_any_items` est `true` si le groupe contient des objets d'autres types.",
"example": true
},
"admin-group-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"admin-group-detail-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"item-in-group-order-request-item": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Identifiant interne de l'objet attribué par Xsolla. Utilisez l'identifiant de l'objet renvoyé par les réponses de l'[appel API du catalogue des objets](/fr/api/catalog/common-catalog).",
"minimum": 0,
"example": 101
},
"order": {
"type": "integer",
"description": "Nouvelle valeur d'ordre d'affichage.",
"minimum": 0,
"example": 1
}
},
"required": [
"item_id",
"order"
],
"additionalProperties": false
},
"Cart-Payment_custom_parameters": {
"description": "Vos paramètres personnalisés représentés sous la forme d'un JSON valide de paires clé-valeur.
\nPour configurer des filtres anti-fraude, passez des paramètres supplémentaires via ce champ. [Voir la documentation de Pay Station](https://developers.xsolla.com/fr/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"null_param": null
}
}
},
"Game-Keys_schemas-client-attributes": {
"type": "array",
"description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nom de l'attribut.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valeur de l'attribut.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_admin-attributes": {
"type": "array",
"description": "Liste des attributs.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Game-Keys_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
}
}
}
},
"Game-Keys_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste des attributs.\n\nAttention. La création de plus de 20 attributs pour un objet n'est pas autorisée. Toute tentative de dépassement entraîne une erreur.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"game_key_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
}
]
}
}
},
"Game-key-item-limit": {
"type": "object",
"description": "Limites d'objets.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/game_key_recurrent_schedule"
}
}
},
"Game-Keys_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Pagination_total-items-count": {
"type": "integer",
"example": 10,
"description": "Nombre total d'objets dans le système."
},
"Game-Keys_client_name": {
"type": "string",
"example": "The Greatest Game in the World",
"description": "Nom du package de jeu."
},
"Game-Keys_description": {
"type": "string",
"example": "Description of the greatest game in the world.",
"description": "Description du jeu."
},
"Game-Keys_project_id": {
"type": "integer",
"example": 44056,
"description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet."
},
"Game-Keys_game_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "theGreatestGameSku",
"description": "ID unique du package de clés."
},
"Game-Keys_drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM.",
"enum": [
"steam",
"playstation",
"xbox",
"uplay",
"origin",
"drmfree",
"gog",
"epicgames",
"nintendo_eshop",
"discord_game_store",
"oculus",
"rockstar",
"viveport",
"stadia"
]
},
"Game-Keys_image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image. Pour garantir un affichage correct et un chargement rapide dans l'interface de paiement, consultez les recommandations suivantes pour les images et les URL :- Formats pris en charge : WebP (recommandé), PNG, JPG.
- Taille du fichier : ≤ 50 Kb (WebP) ou ≤ 150 Kb (PNG et JPG).
- Dimensions : 280 x 280 px.
- Espace colorimétrique : sRGB.
- Protocole : HTTPS avec mise en cache longue durée pour les URL versionnées.
"
},
"Game-Keys_admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "ID unique de l'attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des tirets et des traits bas."
},
"Game-Keys_value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "ID unique de la valeur d'un attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas."
},
"Game-Keys_client-attributes": {
"type": "array",
"description": "Liste des attributs et de leurs valeurs correspondantes pour le jeu.\n\nAttention. Cette partie de la réponse n'est disponible que si vous envoyez le paramètre de requête `additional_fields[]=attributes`.
",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nom de l'attribut.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_value-external_id"
},
"value": {
"type": "string",
"description": "Valeur de l'attribut.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_entitlement_item": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Game-Keys_client_name"
},
"description": {
"$ref": "#/components/schemas/Game-Keys_description"
},
"project_id": {
"$ref": "#/components/schemas/Game-Keys_project_id"
},
"game_sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
},
"drm": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
},
"image_url": {
"$ref": "#/components/schemas/Game-Keys_image_url"
},
"is_pre_order": {
"type": "boolean",
"example": false,
"description": "Détermine si le jeu est en pré-commande."
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_client-attributes"
}
}
},
"Bundles_item_id": {
"type": "integer",
"example": 1,
"minLength": 1,
"maxLength": 255,
"description": "Internal ID unique de l'objet."
},
"Bundles_sku": {
"type": "string",
"example": "bundle_1",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"Bundles_admin-attributes": {
"type": "array",
"description": "Liste des attributs.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Bundles_type": {
"type": "string",
"example": "bundle",
"description": "Type d'objet."
},
"bundle_type": {
"type": "string",
"description": "Type de lot. Renvoyé si le type d'objet est un lot.",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"Bundles_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "URL de l'image. Pour garantir un affichage correct et un chargement rapide dans l'interface de paiement, consultez les recommandations suivantes pour les images et les URL :- Formats pris en charge : WebP (recommandé), PNG, JPG.
- Taille du fichier : ≤ 50 Kb (WebP) ou ≤ 150 Kb (PNG et JPG).
- Dimensions : 280 x 280 px.
- Espace colorimétrique : sRGB.
- Protocole : HTTPS avec mise en cache longue durée pour les URL versionnées.
"
},
"Bundles_groups_response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Nom de l'objet. Doit comprendre des paires clé/valeur\noù la clé est une région au format \"^[a-z]{2}\", la valeur est une chaîne.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Bundles_amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"Bundles_prices": {
"type": "array",
"description": "Prix en devises réelles.",
"items": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
},
"is_default": {
"type": "boolean",
"description": "Le prix par défaut est utilisé pour constituer le catalogue si aucun prix n'est spécifié dans la devise de l'utilisateur."
},
"is_enabled": {
"type": "boolean",
"description": "Le prix est activé."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Pays où ce prix est disponible. Code à deux lettres selon la norme [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_vc-type": {
"type": "string",
"example": "virtual_currency",
"description": "Type de monnaie virtuelle."
},
"Bundles_amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency-is_default": {
"type": "boolean",
"example": true,
"description": "Indique si le prix est le prix par défaut de l'objet."
},
"Bundles_admin-response-virtual_price": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_vc-type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"is_default": {
"$ref": "#/components/schemas/Bundles_currency-is_default"
}
}
},
"Bundles_media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ressources supplémentaires du lot.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Type de média : `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Fichier de ressources."
}
}
}
},
"Bundles_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Ordre de priorité des lots dans la liste."
},
"Bundles_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être trouvé ni acheté."
},
"Bundles_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "L'objet est disponible à l'achat."
},
"Bundles_admin-regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1
}
}
}
},
"Bundles_admin_content_response": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"quantity": {
"type": "integer",
"description": "Quantité du type d'objet dans le lot.",
"default": 1,
"minimum": 1
}
}
},
"Bundles_total_content_price": {
"type": [
"object",
"null"
],
"description": "Somme des prix du contenu du lot.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Somme des prix du contenu du lot avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Somme des prix du contenu du lot."
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_admin_bundle_response": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"virtual_prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin-response-virtual_price"
}
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_content_response"
}
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
}
},
"description": "Le lot spécifié."
},
"Bundles_groups_request": {
"type": "array",
"example": [
"honor"
],
"default": [],
"description": "Groupes auxquels l'objet appartient.\n\nNote. La valeur de la chaîne correspond à l'`external_id` du groupe.
",
"items": {
"type": "string"
}
},
"Bundles_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste des attributs.\n\nAttention. La création de plus de 20 attributs pour un objet n'est pas autorisée. Toute tentative de dépassement entraîne une erreur.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Bundles_vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"amount": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_bundle_type": {
"type": "string",
"example": "standard",
"enum": [
"standard",
"partner_side_content"
],
"description": "Type de lot. Utilisez `standard` pour créer un lot contenant des objets et spécifiez les UGS des objet inclus.\nUtilisez `partner_side_content` pour créer un lot vide auquel vous ajouterez des objets de votre côté via un [webhook](https://developers.xsolla.com/fr/webhooks/operation/personalized-partner-catalog/). Ce type est réservé à la [Personnalisation du catalogue côté partenaire](https://developers.xsolla.com/fr/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side).",
"default": "standard"
},
"Bundles_admin_content_request": {
"type": "array",
"minItems": 1,
"description": "Tableau des objets inclus dans le lot. Chaque entrée indique l'UGS de l'objet et sa quantité. Tous les objets doivent être créés au préalable dans le projet. Une erreur est renvoyée si l'UGS spécifié n'existe pas.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "com.xsolla.kg_1",
"description": "UGS d'un objet à inclure dans le lot. L'objet doit être créé au préalable dans le projet. Une erreur est renvoyée si l'UGS spécifié n'existe pas. Caractères autorisés : a-z, A-Z, 0-9, point (.), tiret (-), tiret bas (_)."
},
"quantity": {
"type": "integer",
"description": "Quantité des objets sélectionnés dans le lot.",
"default": 1,
"minimum": 1
}
},
"required": [
"sku"
],
"example": {
"sku": "com.xsolla.kg_1",
"quantity": 1
}
}
},
"per_user_hourly_bundle": {
"type": "object",
"title": "interval_type = horaire",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalle en heures, après lequel la limite est réinitialisée.
Le compte à rebours commence à partir du paramètre date_from.
Par exemple, si `date_start = \"2025-11-15T18:15:00+05:00\"` et `hours_interval = 2`, la limite pour cet objet se réinitialise toutes les 2 h à partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"bundle_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Délai d'actualisation des limites.",
"properties": {
"per_user": {
"description": "Réinitialisation des limites d'achat effectuée selon l'intervalle de temps spécifié, en heures.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_bundle"
}
]
}
}
},
"bundle-item-limit": {
"type": "object",
"description": "Limites d'objets.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/bundle_recurrent_schedule"
}
}
},
"Bundles_admin_bundle_request": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_request"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-post-put-attributes"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"vc_prices": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_vc_prices"
},
{
"type": "null"
}
]
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Bundles_admin_content_request"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/bundle-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
},
"description": "Le lot spécifié.",
"required": [
"sku",
"name",
"description"
]
},
"Bundles_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Bundles_client_name": {
"type": "string",
"example": "Big Rocket",
"description": "Nom de l'objet."
},
"Bundles_client_description": {
"type": [
"string",
"null"
],
"example": "Big Rocket - description.",
"description": "Description de l'objet."
},
"Bundles_client-attributes": {
"type": "array",
"description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nom de l'attribut.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valeur de l'attribut.",
"example": "Strategy"
}
}
}
}
}
}
},
"Bundles_price": {
"type": [
"object",
"null"
],
"description": "Prix de l'objet.",
"required": [
"amount",
"amount_without_discount",
"currency"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Catalog_item_limits_with_hourly": {
"description": "Limites d'objets.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites d'objets pour un utilisateur.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.",
"example": 5
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que l'utilisateur actuel peut acheter.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Informations sur les limites pour un objet.",
"properties": {
"total": {
"type": "integer",
"description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.",
"example": 5
},
"available": {
"type": "integer",
"description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Bundles_client_content": {
"type": "array",
"example": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
}
}
],
"description": "Contenu du lot.",
"items": {
"type": "object",
"description": "Objet dans le package.",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nom de l'objet."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL de l'image."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Quantité de l'objet dans le package."
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"price": {
"type": [
"object",
"null"
],
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
}
}
}
},
"Bundles_client_bundle": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/Bundles_client_name"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"description": {
"$ref": "#/components/schemas/Bundles_client_description"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"$ref": "#/components/schemas/Bundles_price"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"$ref": "#/components/schemas/Bundles_client_content"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"media_list": {
"$ref": "#/components/schemas/Bundles_media_list"
}
},
"description": "Le lot spécifié."
},
"value-cart_is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Si ce paramètre est défini sur `true`, le panier est gratuit."
},
"Cart-Payment_client-attributes": {
"type": "array",
"description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nom de l'attribut.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valeur de l'attribut.",
"example": "Strategy"
}
}
}
}
}
}
},
"Catalog_cart_promotions": {
"type": "array",
"description": "Promotions appliquées à l'ensemble du panier. Le tableau est renvoyé dans les cas suivants :\n\n* Une promotion affecte le montant total du panier, comme un code promo avec le paramètre **Discount on purchase**.\n\n* Une promotion ajoute des objets bonus au panier.\n\nSi aucune promotion de ce type n’est appliquée, un tableau vide est renvoyé.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Type d'objet bonus.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Nom de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`."
},
"image_url": {
"type": "string",
"description": "URL de l'image de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Type de lot bonus. Disponible uniquement pour le type d'objet `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"Cart-Payment_settings_ui": {
"description": "Paramètres d'interface.",
"type": "object",
"additionalProperties": false,
"properties": {
"theme": {
"description": "Thème d'interface de paiement. Les valeurs possibles sont : `63295a9a2e47fab76f7708e1` pour le thème clair (par défaut) ou `63295aab2e47fab76f7708e3` pour le thème foncé. Vous pouvez également [créer un thème personnalisé](https://developers.xsolla.com/fr/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token) et passez son ID dans ce paramètre.",
"type": "string",
"default": "63295a9a2e47fab76f7708e1",
"enum": [
"63295a9a2e47fab76f7708e1",
"63295aab2e47fab76f7708e3"
]
},
"desktop": {
"type": "object",
"additionalProperties": false,
"description": "Paramètres de l'interface pour la version de bureau.",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"description": "Paramètres de l'en-tête.",
"properties": {
"is_visible": {
"type": "boolean",
"description": "Détermine l'affichage de l'en-tête dans l'interface de paiement."
},
"visible_logo": {
"type": "boolean",
"description": "Si `true`, le logo est affiché dans l'en-tête. Pour télécharger l'image, ouvrez votre projet dans [Publisher Account](https://publisher.xsolla.com/) et allez dans la section Pay Station > Settings."
},
"visible_name": {
"type": "boolean",
"description": "Détermine l'affichage du nom du projet dans l'en-tête."
},
"visible_purchase": {
"type": "boolean",
"description": "Détermine l'affichage de la description de l'achat (`purchase.description.value`) dans l'en-tête. Défini sur `true` par défaut.",
"default": true
},
"type": {
"type": "string",
"description": "Apparence de l'en-tête. La valeur peut être `compact` (le nom du projet et l'ID utilisateur ne s'affichent pas) ou `normal` (par défaut).",
"default": "normal",
"enum": [
"compact",
"normal"
]
},
"close_button": {
"type": "boolean",
"description": "Détermine l'affichage du bouton **Fermer** dans l'interface de paiement sur ordinateur. Un clic sur ce bouton ferme l'interface de paiement et redirige l'utilisateur vers l'URL passée dans le paramètre `settings.return_url`. Défini sur `false` par défaut.",
"default": false
}
}
}
}
},
"mode": {
"type": "string",
"enum": [
"user_account"
],
"description": "Mode d'interface dans l'interface de paiement. L'unique valeur possible est `user_account`. Dans ce mode, l'en-tête ne contient que le menu de navigation du compte, et l'utilisateur ne peut ni sélectionner un produit ni effectuer un paiement. Ce mode est disponible uniquement sur la version de bureau."
},
"user_account": {
"type": "object",
"additionalProperties": false,
"description": "Informations de compte utilisateur.",
"properties": {
"payment_accounts": {
"type": "object",
"additionalProperties": false,
"description": "Le sous-menu **Mes comptes de paiement**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`."
}
},
"required": [
"enable"
]
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "Page **My account**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Position du sous-menu dans le menu."
}
},
"required": [
"enable",
"order"
]
},
"subscriptions": {
"type": "object",
"additionalProperties": false,
"description": "Sous-menu **Gestion des abonnements**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Position du sous-menu dans le menu."
}
},
"required": [
"enable",
"order"
]
}
}
},
"header": {
"type": "object",
"properties": {
"visible_virtual_currency_balance": {
"type": "boolean",
"additionalProperties": false,
"description": "Détermine l'affichage de cet élément dans l'interface de paiement.",
"default": true
}
}
},
"mobile": {
"type": "object",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"close_button": {
"type": "boolean",
"description": "Détermine l'affichage du bouton **Fermer** dans l'interface de paiement sur appareil mobile. Un clic sur ce bouton ferme l'interface de paiement et redirige l'utilisateur vers l'URL passée dans le paramètre `settings.return_url`.",
"default": false
}
}
}
}
},
"is_prevent_external_link_open": {
"type": "boolean",
"description": "Détermine la désactivation des liens de redirection vers une ressource externe. Un clic sur un lien externe déclenche l'envoi de l'événement `external-link-open` via le mécanisme `postMessage`. L'adresse du lien de redirection est passée dans le paramètre `url`.",
"default": false
},
"is_payment_methods_list_mode": {
"type": "boolean",
"description": "Détermine l'affichage de la liste des modes de paiement disponibles dans le pays de l'utilisateur à l'ouverture de l'interface de paiement. Si `false` (par défaut), le mode de paiement passé dans le paramètre `settings.payment_method` ou le mode sélectionné selon l'[algorithme du PayRank](https://developers.xsolla.com/fr/solutions/payments/payment-ui-management/top-payment-methods-management/) s'affiche.",
"default": false
},
"is_independent_windows": {
"type": "boolean",
"description": "Détermine la redirection des utilisateurs du navigateur du lanceur intégré (WebView) vers leur navigateur par défaut pour effectuer un achat.",
"default": false
},
"currency_format": {
"type": "string",
"description": "Définissez sur `code` pour afficher un code de devise à trois lettres selon la norme [ISO 4217](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/) dans l'interface de paiement. Par défaut, le symbole de la devise est affiché à la place du code de devise à trois lettres."
},
"is_show_close_widget_warning": {
"type": "boolean",
"description": "Détermine l'affichage d'une infobulle sur le traitement de la transaction au passage de la souris sur l'icône **×** avant la fermeture de la page de paiement. Défini sur `false`, ou si le paramètre n'est pas passé, l'infobulle ne s'affiche pas.",
"default": true
},
"layout": {
"type": "string",
"description": "Emplacement des principaux éléments de l'interface de paiement. Vous pouvez ouvrir l'interface de paiement à l'intérieur de votre jeu et/ou permuter les colonnes contenant des informations sur la commande et les modes de paiement. Reportez-vous aux [instructions de customisation](https://developers.xsolla.com/fr/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout) pour des informations détaillées.",
"enum": [
"embed",
"column_reverse",
"embed_column_reverse"
]
},
"is_three_ds_independent_windows": {
"type": "boolean",
"description": "Détermine l'ouverture de la vérification 3-D Secure dans une nouvelle fenêtre du navigateur. Définissez sur `true`, si votre configuration applique une politique de sécurité du contenu (CSP).",
"default": false
},
"is_cart_open_by_default": {
"type": "boolean",
"description": "Affichage de la liste des objets dans le panier lors de l'ouverture de la version mobile de l'interface de paiement. Si `true`, la liste s'affiche dans une vue étendue. Si `false`(valeur par défaut) ou si le paramètre n'est pas passé, la liste s'affiche dans une vue réduite.",
"default": false
}
}
},
"Cart-Payment_settings_payment_method": {
"type": "integer",
"description": "ID du mode de paiement. Il détermine l'affichage de la devise dans l'interface de paiement, car certains modes de paiement ne prennent en charge que certaines devises.",
"minimum": 1
},
"Cart-Payment_settings_return_url": {
"type": "string",
"format": "uri",
"description": "Page vers laquelle l'utilisateur est redirigé après un paiement. Les paramètres `user_id`, `foreigninvoice`, `invoice_id` et `status` sont automatiquement ajoutés au lien.",
"maxLength": 1000
},
"Cart-Payment_redirect_policy": {
"type": "object",
"properties": {
"redirect_conditions": {
"description": "Statut du paiement déclenchant la redirection de l'utilisateur vers l'URL de retour.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"delay": {
"description": "Délai après lequel l'utilisateur est automatiquement redirigé vers l'URL de retour.",
"type": "integer",
"example": 0
},
"status_for_manual_redirection": {
"description": "Statut de paiement déclenchant l'affichage d'un bouton de redirection de l'utilisateur vers l'URL de retour.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"redirect_button_caption": {
"description": "Légendes localisées des boutons de redirection.",
"type": "string",
"example": "Text button"
}
}
},
"Cart-Payment_settings_sandbox": {
"type": "boolean",
"description": "Passez la valeur `true` pour tester le processus de paiement. Dans ce cas, utilisez l'URL https://sandbox-secure.xsolla.com pour accéder à l'interface de paiement de test.",
"default": false
},
"Cart-Payment_admin-user-request-body": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "object",
"properties": {
"value": {
"description": "ID utilisateur. Pour les tests, passez une valeur aléatoire. Pour accepter des paiements réels, utilisez la valeur de l'ID utilisateur dans votre système. Cet ID est passé dans le webhook [User validation](https://developers.xsolla.com/fr/webhooks/operation/user-validation/).",
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"name": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Pseudo de l'utilisateur."
}
}
},
"email": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"format": "email",
"description": "Adresse e-mail utilisateur. Doit être valide selon le protocole RFC 822."
}
}
},
"country": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Requis si l'adresse IP n'est pas passée dans l'en-tête `X-User-Ip`. Consultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/).
Exemple : `country=US`",
"example": "US"
},
"allow_modify": {
"type": "boolean",
"description": "Indique si l'utilisateur peut changer de pays dans l'interface de paiement.",
"default": false,
"example": false
}
}
},
"age": {
"type": "integer",
"description": "Âge de l'utilisateur."
},
"phone": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "Numéro de téléphone de l'utilisateur."
},
"allow_modify": {
"type": "boolean",
"description": "Détermine si l'utilisateur peut changer de téléphone dans l'interface de paiement. Si le paramètre `phone.value` est passé dans le jeton, la valeur est `false`.",
"default": false,
"example": false
},
"hidden": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"tracking_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9]{32}$",
"description": "ID unique de suivi (utilisé dans les campagnes de marketing)."
}
}
},
"steam_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 17,
"maxLength": 17,
"pattern": "^\\d{17}$",
"description": "ID Steam."
}
}
},
"is_legal": {
"type": "boolean",
"description": "Détermine si l'utilisateur est une personne morale."
},
"legal": {
"type": "object",
"description": "Informations de la personne morale. L'objet et tous ses paramètres sont requis si `user.is_legal` est défini sur `true`.",
"properties": {
"name": {
"type": "string",
"description": "Nom légal complet."
},
"address": {
"type": "string",
"description": "Adresse légale complète."
},
"vat_id": {
"type": "string",
"description": "Numéro d'identification fiscal."
},
"country": {
"type": "string",
"description": "Pays de constitution. Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
}
},
"Cart_admin_payment": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.\n\nAttention
Pour vendre une même UGS plusieurs fois, indiquez la quantité requise dans le paramètre purchase.items[].quantity. Les doublons d’UGS dans le tableau ne sont pas pris en charge, seule la première occurrence est utilisée lors de la création du jeton. Aucune erreur n’est renvoyée dans ce cas.
",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Quantité de l'objet."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "Code unique sensible à la casse. Comprend des lettres et des chiffres.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Cart-Payment_settings_currency": {
"type": "string",
"description": "Devise de paiement préférée. Code de devise à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"Cart-Payment_settings_locale": {
"type": "string",
"description": "Langue d'interface. [Code de langue](https://developers.xsolla.com/fr/doc/pay-station/features/localization/) à deux lettres minuscules."
},
"Cart-Payment_settings_external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "External ID de la transaction."
},
"Cart-Payment_custom_parameters_token": {
"description": "Vos paramètres personnalisés représentés sous la forme d'un JSON valide de paires clé-valeur.
\nPour configurer des filtres anti-fraude, passez des paramètres supplémentaires via ce champ. [Voir la documentation de Pay Station](https://developers.xsolla.com/fr/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"number_param": 12.5,
"null_param": null
}
}
},
"422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Code d'état de la réponse.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Code d'erreur.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Message d'erreur lisible.",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
},
"transactionId": {
"type": "string",
"description": "ID unique de la demande.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"Cart": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"example": "US",
"description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Consultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/).
Exemple : `country=US`"
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "USD",
"description": "Devise du prix de l'objet affiché dans le panier. Code de devise à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Quantité de l'objet."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"User-limit_user-external-id": {
"description": "External ID de l'utilisateur",
"type": "string",
"minLength": 1,
"pattern": "^\\S+$"
},
"User-limit_user": {
"type": "object",
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
},
"required": [
"user_external_id"
]
},
"User-limit_user_flexible": {
"type": [
"object",
"null"
],
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
}
},
"User-limit-item": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "Nombre maximum d'objets qu'un utilisateur peut acheter."
},
"available": {
"type": "integer",
"example": 9,
"description": "Nombre restant d'objets qu'un utilisateur peut acheter."
}
}
}
}
},
"User-limit_available_flexible": {
"type": "integer",
"minimum": 0,
"description": "Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée."
},
"User-limit_available": {
"type": "integer",
"minimum": 1,
"description": "Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée."
},
"422-invalid-request-extended": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Code d'état de la réponse.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Code d'erreur.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Message d'erreur lisible.",
"example": "[0401-1102]: Unprocessable Entity"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
},
"transactionId": {
"type": "string",
"description": "Unique request ID. Can be used to contact Xsolla support for troubleshooting.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"client_virtual_prices_with_calculated_price_response": {
"type": "array",
"description": "Prix virtuels.",
"items": {
"type": "object",
"description": "Prix virtuel.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Prix de l'objet en monnaie virtuelle."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Prix de l'objet en monnaie virtuelle, hors remise. Il correspond toujours à `amount`, car les remises ne s'appliquent pas aux prix en monnaie virtuelle."
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "UGS de la monnaie virtuelle."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Détermine s'il s'agit du prix par défaut en monnaie virtuelle."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "URL de l'image de la monnaie virtuelle."
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "ID d'objet unique attribué par Xsolla."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Nom de la monnaie virtuelle."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet. Pour la monnaie virtuelle, il s'agit de `virtual_currency."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Virtual currency description."
}
}
}
},
"Regions_region_id": {
"type": "integer",
"description": "ID de la région. Identifiant unique de la région au sein du projet.",
"example": 42
},
"Regions_name": {
"type": "object",
"description": "Nom de la région. 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.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Asia",
"de-DE": "Asien"
},
"default": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
"Regions_200-region-short-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
}
},
"Regions_countries": {
"type": "array",
"description": "Liste des pays à ajouter dans une région.\n
Code de pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\nConsultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/).\n
Exemple : `[\"JP\", \"CN\", \"VN\"]`",
"items": {
"type": "string"
}
},
"Regions_200-region-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
},
"countries": {
"$ref": "#/components/schemas/Regions_countries"
}
},
"example": {
"value": {
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
},
"admin_attribute_response": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
},
"example": {
"value": [
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
},
"schemas-422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"request-attribute-value": {
"type": "object",
"required": [
"external_id",
"value"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_id",
"value": {
"en": "Value",
"de": "Wert"
}
}
},
"404-not-found": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0000-0000]: Entity not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"responses": {
"Virtual-Items-Currency_200-admin-get-virtual-items": {
"description": "La liste d'objets virtuels a été reçue avec succès.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_1",
"name": {
"en": "Maximum Armor Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Suit up with flair showcasing your allegiance to Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"long_description": {
"en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "featured",
"name": {
"en": "featured"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "Premium",
"name": {
"en": "Premium"
}
},
{
"external_id": "NonConsumableGroupCode",
"name": {
"en": "Non-consumable"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_large_3",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_401-invalid-basic-auth": {
"description": "L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Virtual-Items-Currency_201-created": {
"description": "L'objet virtuel a été créé avec succès.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_1"
}
}
},
"schema": {
"type": "object",
"example": {
"sku": "com.xsolla.item_1"
},
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
}
}
}
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-items-by-group": {
"description": "La liste d'objets virtuels a été reçue avec succès.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_lrg_2",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-item": {
"description": "L'objet virtuel spécifié a été reçu avec succès.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.swords_1",
"name": {
"en": "Sword Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"long_description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
},
{
"external_id": "weapon",
"name": {
"en": "weapon"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currencies": {
"description": "La liste de monnaies virtuelles a été reçue avec succès.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency": {
"description": "La monnaie virtuelle spécifiée a été reçue avec succès.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
},
"Virtual-Items-Currency_404-item": {
"description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-packages": {
"description": "La liste de packages de monnaie virtuelle a été reçue avec succès.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.crystal_pack_2",
"name": {
"en": "Medium crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_2",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.crystal_pack_3",
"name": {
"en": "Massive crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_3",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_1",
"name": {
"en": "Small gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_2",
"name": {
"en": "Medium gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_2",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_3",
"name": {
"en": "Large gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_3",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-package": {
"description": "Le package de monnaie virtuelle spécifié a été reçu avec succès.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-list": {
"description": "La liste d'objets virtuels a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": {
"en": "Big Rocket"
},
"groups": [
{
"external_id": "accessory",
"name": "accessory",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "Big Rocket - description"
},
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": null,
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{
"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{
"quantity": 1,
"name": "Super Lootbox with items",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-item-by-sku": {
"description": "L'objet virtuel a été reçu avec succès.",
"content": {
"application/json": {
"example": {
"item_id": 488833,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"name": {
"en": "Sword Xsolla Skin"
},
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 3,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1761840000
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": "VALUE"
},
{
"external_id": "val2",
"value": "VALUE2"
}
]
}
],
"is_free": false,
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Virtual-Items-Currency_200-get-all-items-list": {
"description": "La liste de tous les objets virtuels a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets virtuels.",
"properties": {
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nom de l'objet."
},
"groups": {
"type": "array",
"properties": {
"external_id": {
"type": "string",
"example": "weapons"
},
"name": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
}
}
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Description de l'objet."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"description": "Big Rocket - description"
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"description": "description"
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"description": "description"
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-list": {
"description": "La liste de monnaies virtuelles a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.diamond_1",
"name": "Diamonds",
"groups": [],
"attributes": [],
"type": "virtual_currency",
"description": "Diamonds - description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency": {
"description": "La monnaie virtuelle a été reçue avec succès.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 451414,
"sku": "com.xsolla.crystal_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"is_free": false,
"groups": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-list": {
"description": "La liste de packages de monnaie virtuelle a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-package": {
"description": "Le package de monnaie virtuelle a été reçu avec succès.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 488832,
"sku": "com.xsolla.crystal_pack_1",
"type": "bundle",
"name": "Crystal Pack",
"bundle_type": "virtual_currency_package",
"description": "Crystal Pack Short Description",
"image_url": "http://vc_package_image.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 1,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1690732800
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 488831,
"sku": "com.xsolla.crystals_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"quantity": 10,
"limits": null
}
],
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-by-group-id": {
"description": "La liste d'objets du groupe spécifié a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet : `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_404-item-group": {
"description": "Groupe non trouvé. Assurez-vous que le paramètre `external_id` est correct et que le groupe n'est pas désactivé ou supprimé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "Code d'état de la réponse HTTP.",
"example": 404
},
"errorCode": {
"type": "integer",
"description": "Code d'erreur Xsolla",
"example": 4403
},
"errorMessage": {
"type": "string",
"description": "Description courte de l'erreur.",
"example": "[0401-4403]: Item group not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found"
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-by-group-id": {
"description": "La liste des monnaies virtuelles du groupe spécifié a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id": {
"description": "La liste des packages de monnaie virtuelle du groupe spécifié a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-items-groups": {
"description": "La liste des groupes a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"example": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": null,
"order": 1
},
{
"external_id": "group_external_id",
"name": "Super",
"description": "Super description",
"image_url": null,
"order": 1
}
],
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "weapons",
"description": "External ID du groupe."
},
"name": {
"type": "string",
"example": "Weapons",
"description": "Nom du groupe."
},
"description": {
"type": "string",
"example": "All weapons available in the game",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL de l'image."
},
"order": {
"type": "integer",
"example": 1,
"description": "Définit l'ordre d'empilement."
},
"level": {
"type": "integer",
"example": 0,
"description": "Niveau d'imbrication du groupe."
},
"children": {
"type": "array",
"example": [
{
"external_id": "background",
"name": "Background",
"description": "Background description",
"image_url": null,
"order": 1,
"level": 1,
"children": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"parent_external_id": "weapons"
}
],
"description": "Groupes enfant.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "background",
"description": "External ID du groupe."
},
"name": {
"type": "string",
"example": "Background",
"description": "Nom du groupe."
},
"description": {
"type": "string",
"example": "Background description",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL de l'image du groupe."
},
"order": {
"type": "integer",
"example": 1,
"description": "Définit l'ordre d'empilement."
},
"level": {
"type": "integer",
"example": 1,
"description": "Niveau d'imbrication du groupe."
},
"children": {
"type": "array",
"example": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"description": "Groupes enfant.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "accessory",
"description": "External ID du groupe."
},
"name": {
"type": "string",
"example": "Accessory",
"description": "Nom du groupe."
},
"description": {
"type": "string",
"example": "Accessory",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL de l'image."
},
"order": {
"type": "integer",
"example": 1,
"description": "Définit l'ordre d'empilement."
},
"level": {
"type": "integer",
"example": 2,
"description": "Niveau d'imbrication du groupe."
},
"children": {
"type": "array",
"example": [],
"description": "Groupes enfant.",
"items": {
"type": "string"
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "background",
"description": "External ID du groupe parent."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "weapons",
"description": "External ID du groupe parent."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": null,
"description": "External ID du groupe parent."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": "https://example.com/groups/weapons.png",
"order": 1
},
{
"external_id": "armor",
"name": "Armor",
"description": "Protective equipment",
"image_url": "https://example.com/groups/armor.png",
"order": 2
},
{
"external_id": "consumables",
"name": "Consumables",
"description": "Potions, food, and other single-use items",
"image_url": null,
"order": 3
}
]
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list": {
"description": "La liste des groupes d'objets a été récupérée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-base"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list"
}
}
}
}
},
"ItemGroup_401-invalid-basic-auth": {
"description": "Échec de l'authentification de base ou identifiants fournis non valides. Assurez-vous d'utiliser l'authentification de base et des identifiants corrects.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error-response-base"
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_201-admin-create-group": {
"description": "Le groupe d'objets a été créé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID externe du groupe d'objets défini lors de sa création.",
"example": "weapons"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/201-admin-create-group"
}
}
}
}
},
"ItemGroup_422-create-update": {
"description": "Impossible de traiter la requête. Elle est renvoyée en cas d'erreurs de validation ou si les données enfreignent les règles du système.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"The property `external_id` is required": {
"$ref": "#/components/examples/422-property-external-id-required"
},
"Group already exists": {
"value": {
"statusCode": 422,
"errorCode": 4401,
"errorMessage": "[0401-4401]: Item group already exists",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Group cannot be its own parent": {
"value": {
"statusCode": 422,
"errorCode": 4404,
"errorMessage": "[0401-4404]: Group can't be self parent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Reserved external_id value": {
"value": {
"statusCode": 422,
"errorCode": 4516,
"errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group": {
"description": "Le groupe des objets a été récupéré avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-response-base"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group"
}
}
}
}
},
"ItemGroup_404-group-not-found": {
"description": "Groupe d'objets introuvable. Retourné si le groupe avec `external_id` spécifié n'existe pas ou appartient à un autre projet.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Identifiants utilisés lors de la recherche ayant échoué.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID du projet utilisé dans la requête de recherche."
},
"external_id_list": {
"type": "array",
"description": "Liste des `external_id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Liste des `id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
},
"Items or group not found (reorder endpoints)": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_204-admin-update-group": {
"description": "Le groupe des objets a été mis à jour avec succès."
},
"ItemGroup_204-admin-delete-group": {
"description": "Le groupe des objets a été supprimé avec succès."
},
"ItemGroup_422-delete": {
"description": "Le traitement de la requête a échoué. Impossible de supprimer un groupe contenant des objets.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Cannot delete group with items": {
"value": {
"statusCode": 422,
"errorCode": 4402,
"errorMessage": "[0401-4402]: Item group with items cannot be deleted.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list-by-item-type": {
"description": "La liste des groupes d'objets a été récupérée avec succès. Le champ `items_count` inclut uniquement les objets du type spécifié.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-by-item-type"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list-by-item-type"
}
}
}
}
},
"ItemGroup_200-admin-get-group-by-item-type": {
"description": "Le groupe d'objets a été récupéré avec succès, avec le champ `items_count` filtré selon le type d'objet spécifié.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-detail-response-by-item-type"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-by-item-type"
}
}
}
}
},
"ItemGroup_204-admin-reorder-groups": {
"description": "Les groupes d'objets ont été réorganisés avec succès."
},
"ItemGroup_404-reorder-groups-not-found": {
"description": "Groupe d'objets introuvable. Retourné si le groupe avec `id` ou `external_id` spécifié n'existe pas ou appartient à un autre projet.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Identifiants utilisés lors de la recherche ayant échoué.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID du projet utilisé dans la requête de recherche."
},
"external_id_list": {
"type": "array",
"description": "Liste des `external_id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Liste des `id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
}
}
}
}
},
"ItemGroup_422-ordering": {
"description": "Le traitement de la requête a échoué. Impossible de valider le corps de la requête.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "",
"message": "Object value found, but an array is required"
}
]
}
}
}
}
}
},
"ItemGroup_204-admin-reorder-items": {
"description": "Les objets du groupe ont été réorganisés avec succès."
},
"ItemGroup_404-reorder-items-by-external-id-not-found": {
"description": "Groupe d'objets ou objets introuvables. Retourné si le groupe avec `external_id` spécifié n'existe pas ou appartient à un autre projet, ou si un ou plusieurs `item_id` sont introuvables dans le groupe.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Identifiants utilisés lors de la recherche ayant échoué.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID du projet utilisé dans la requête de recherche."
},
"external_id_list": {
"type": "array",
"description": "Liste des `external_id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_404-reorder-items-by-id-not-found": {
"description": "Groupe d'objets ou objets introuvables. Retourne si le groupe avec `id` spécifié n'existe pas ou appartient à un autre projet, ou si un ou plusieurs `item_id` sont introuvables dans le groupe.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Identifiants utilisés lors de la recherche ayant échoué.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID du projet utilisé dans la requête de recherche."
},
"group_id_list": {
"type": "array",
"description": "Liste des `id` de groupes utilisés dans la requête de recherche.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"Virtual-Items-Currency_200-quick-purchase": {
"description": "Achat rapide virtuel réussi.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de commande."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Virtual-Items-Currency_422-not-enough-virtual-currency": {
"description": "Monnaie virtuelle insuffisante.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 5006
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-5006]: Not enough virtual currency"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 5006,
"statusCode": 422,
"errorMessage": "[0401-5006]: Not enough virtual currency"
}
}
}
}
}
},
"Game-Keys_200-get-games-catalog": {
"description": "La liste de jeux a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objet contenant des jeux.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [],
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "unit",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"unit_type": {
"type": "string",
"example": "game",
"description": "Type d'unité : `game`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL de l'image."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"unit_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Type d'objet : `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nom du DRM."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Si `true`, le module Clés de jeu a des clés vendables."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Date de publication de la clé de jeu au format ISO 8601."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [],
"vp_rewards": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": []
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-get-game-keys-by-group-catalog": {
"description": "La liste des clés de jeu a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objet contenant des jeux.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "game_key",
"description": "Type d'objet : `game_key`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nom du DRM."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Si `true`, le module Clés de jeu a des clés vendables."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Date de publication de la clé de jeu au format ISO 8601."
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
]
}
}
}
}
}
},
"Game-Keys_200-get-drm-list": {
"description": "La liste des DRM a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objet contenant des jeux.",
"properties": {
"drm": {
"type": "array",
"example": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Steam",
"description": "Nom du DRM."
},
"image": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL de l'image."
},
"link": {
"type": [
"string",
"null"
],
"example": "https://support.us.playstation.com",
"description": "Lien d'échange."
},
"redeem_instruction_link": {
"type": "string",
"example": "https://support.us.playstation.com",
"description": "Lien d'instructions d'échange."
},
"drm_id": {
"type": "number",
"example": 1,
"description": "ID du DRM."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"drm": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
]
}
}
}
}
}
},
"Game-Keys_200-admin-get-games-list": {
"description": "La liste de jeux a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objet contenant des jeux.",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "unit",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Type de média : `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Fichier de ressources."
}
}
}
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être acheté et n'est pas accessible par le biais de l'inventaire."
},
"is_show_in_store": {
"type": "boolean",
"description": "L'objet est disponible à l'achat."
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"unit_items": {
"type": "array",
"description": "Clés de jeu pour différents DRM.",
"items": {
"type": "object",
"description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Prix en devises réelles.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Le prix par défaut est utilisé pour constituer le catalogue si aucun prix n'est spécifié dans la devise de l'utilisateur."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Pays où ce prix est disponible. Code à deux lettres selon la norme [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objet contenant des versions localisées du nom de la monnaie virtuelle. Les clés sont spécifiées selon la norme ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `virtual_currency`."
},
"description": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Object with localizations for game description. Keys are specified in ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être acheté et n'est pas accessible par le biais de l'inventaire."
},
"is_show_in_store": {
"type": "boolean",
"description": "L'objet est disponible à l'achat."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nom du DRM de la clé de jeu."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Icône du DRM de la clé de jeu."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique du DRM."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Nombre de clés disponibles à l'achat."
},
"total": {
"type": "integer",
"description": "Nombre total de clés téléchargées."
},
"used": {
"type": "integer",
"description": "Nombre de clés vendues."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Si `true`, la clé de jeu a été achetée par les utilisateurs."
},
"pre_order": {
"type": "object",
"description": "Paramètres de pré-commande.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Date de publication de la clé de jeu au format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande."
},
"description": {
"type": [
"string",
"null"
],
"description": "Additional information for the pre-order which will be emailed."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"name": {
"en": "Game 1 Key 2"
},
"groups": [],
"attributes": [],
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
{
"item_id": 2,
"sku": "com.xsolla.game_2",
"type": "unit",
"name": {
"en": "Game 2"
},
"description": {
"en": "Example game 2"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"item_id": 5,
"sku": "com.xsolla.game_2_key_2",
"type": "game_key",
"is_free": false,
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"order": 1,
"is_enabled": false,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
]
}
}
}
}
}
},
"Game-Keys_401-invalid-basic-auth": {
"description": "L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Game-Keys_422-invalid-request": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Game-Keys_422-invalid-request"
},
"examples": {
"The property `drm_sku` is required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required"
}
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"Game-Keys_200-admin-get-game-by-sku": {
"description": "Le jeu a été reçu avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur le jeu.",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "unit",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Type de média : `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Fichier de ressources."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_enabled": {
"type": "boolean"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_show_in_store": {
"type": "boolean"
},
"unit_items": {
"type": "array",
"description": "Clés de jeu pour différents DRM.",
"items": {
"type": "object",
"description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Prix en devises réelles.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_is": "RU"
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Le prix par défaut est utilisé pour constituer le catalogue si aucun prix n'est spécifié dans la devise de l'utilisateur."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Pays où ce prix est disponible. Code à deux lettres selon la norme [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objet contenant des versions localisées du nom de la monnaie virtuelle. Les clés sont spécifiées selon la norme ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Type d'objet. Dans ce cas, il s'agit toujours de `virtual_currency`."
},
"description": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Object with localizations for game description. Keys are specified in ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être acheté et n'est pas accessible par le biais de l'inventaire."
},
"is_show_in_store": {
"type": "boolean",
"description": "L'objet est disponible à l'achat."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nom du DRM de la clé de jeu."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Icône du DRM de la clé de jeu."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Internal ID unique du DRM."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Nombre de clés disponibles à l'achat."
},
"total": {
"type": "integer",
"description": "Nombre total de clés téléchargées."
},
"used": {
"type": "integer",
"description": "Nombre de clés vendues."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Si `true`, la clé de jeu a été achetée par les utilisateurs."
},
"pre_order": {
"type": "object",
"description": "Paramètres de pré-commande.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Date de publication de la clé de jeu au format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande."
},
"description": {
"type": [
"string",
"null"
],
"description": "Additional information for the pre-order which will be emailed."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": false,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": null
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-session-information": {
"description": "Les informations sur la session de chargement des codes ont été reçues avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "fc7105b6e8ee01339582970b37697242"
},
"count_uploaded": {
"type": "integer",
"example": 0
},
"count_total": {
"type": "integer",
"example": 100
},
"count_skipped": {
"type": "integer",
"example": 10
},
"status": {
"type": "string",
"example": "processing"
}
}
},
"examples": {
"response": {
"value": {
"session_id": "fc7105b6e8ee01339582970b37697242",
"count_uploaded": 0,
"count_total": 100,
"count_skipped": 10,
"status": "processing"
}
}
}
}
}
},
"Game-Keys_200-get-codes": {
"description": "Les codes ont été reçus avec succès.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "PIN-CODE-ALL PIN-CODE-ALL-3"
},
"examples": {
"response": {
"value": "PIN-CODE-ALL PIN-CODE-ALL-3"
}
}
}
}
},
"Game-Keys_200-user-entitlement-list": {
"description": "Une liste de clés de jeu en possession de l'utilisateur a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur le jeu.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"$ref": "#/components/schemas/Pagination_total-items-count"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game-Keys_entitlement_item"
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}
}
}
}
}
},
"Game-Keys_403-auth-header-not-sent": {
"description": "L'en-tête d'autorisation n'a pas été passé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "L'en-tête d'autorisation n'a pas été passé."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Bundles_200-admin-get-bundle-list": {
"description": "La liste de lots a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677639600,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-01T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_401-invalid-basic-auth": {
"description": "L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Bundles_201-admin-create-bundle": {
"description": "Le lot a été créé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
}
}
},
"examples": {
"response": {
"value": {
"sku": "com.xsolla.kg_1"
}
}
}
}
}
},
"Bundles_422-invalid-request": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Bundles_200-admin-get-bundle-list-in-group": {
"description": "La liste de lots a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "weekly",
"day_of_week": 2,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_200-admin-get-bundle": {
"description": "Le lot spécifié a été reçu avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
},
"example": {
"item_id": 610316,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
}
},
"Bundles_204-admin-update-bundle": {
"description": "Le lot a été mis à jour avec succès.",
"content": {}
},
"Bundles_204-admin-delete-bundle": {
"description": "Le lot a été supprimé avec succès.",
"content": {}
},
"Bundles_204-admin-show-bundle": {
"description": "Le lot a été affiché avec succès.",
"content": {}
},
"Bundles_204-admin-hide-bundle": {
"description": "Le lot a été masqué avec succès.",
"content": {}
},
"Bundles_200-get-bundle-list": {
"description": "La liste de lots a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_client_bundle"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Bundles_200-get-bundle-list"
}
}
}
}
},
"Cart-Payment_200-get-cart-json-model": {
"description": "Le panier contenant des objets a été renvoyé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID de panier."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Prix du panier."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Prix de l'objet."
},
"virtual_item_type": {
"type": "string",
"description": "Type d'objet."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_200-fill-cart-json-model": {
"description": "Le panier contenant des objets a été renvoyé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID de panier."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Prix du panier."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Prix de l'objet."
},
"virtual_item_type": {
"type": "string",
"description": "Type d'objet."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.booster_mega_21",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found"
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-item": {
"description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Cart-Payment_422-non-negative-quantity": {
"description": "La quantité de l'objet doit être un nombre entier non négatif.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "La quantité de l'objet doit être un nombre entier non négatif."
},
"errorCode": {
"type": "integer",
"example": 1102
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
}
}
}
},
"Cart-Payment_422-can-put-only-virtual-good-to-cart": {
"description": "Ce type d'objet ne peut pas être mis dans le panier. Sélectionnez un autre type d'objet.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1421
},
"errorMessage": {
"type": "string",
"example": "Ce type d'objet ne peut pas être mis dans le panier. Sélectionnez un autre type d'objet."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported"
}
}
}
}
}
},
"Cart-Payment_200-order-created": {
"description": "La commande a été créée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de commande."
},
"token": {
"type": "string",
"description": "Jeton de paiement."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
}
}
}
}
},
"Cart-Payment_422-invalid-cart": {
"description": "Panier non valide. Vérifiez que le panier existe, qu'il n'est pas vide et que tous les objets qu'il contient ne sont pas gratuits.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1401
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1401]: Invalid cart"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart"
}
}
}
}
}
},
"Cart-Payment_404-create-order-with-item-not-found-errors": {
"description": "Objet ou coupon introuvable. Assurez-vous que les données utilisées sont correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"Cart-Payment_422-create-order-with-item-invalid": {
"description": "Erreur non valide.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"invalid item": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
},
"code expired": {
"value": {
"errorCode": 9810,
"statusCode": 422,
"errorMessage": "[0401-9810]: Sorry, this code is expired."
}
},
"code redemption limit": {
"value": {
"errorCode": 9804,
"statusCode": 422,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"regionally restricted": {
"value": {
"errorCode": 9808,
"statusCode": 422,
"errorMessage": "[0401-9808]: Coupon is not available in your region."
}
}
}
}
}
},
"Cart-Free_200-order-created": {
"description": "La commande gratuite a été créée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de commande."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Cart-Payment_422-invalid-item": {
"description": "Objet non valide. Vérifiez que l'objet existe, qu'il n'est pas désactivé, qu'il n'est pas supprimé et qu'il n'est pas gratuit.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
}
}
}
}
},
"Cart-Payment_200-get-order": {
"description": "Requête de commande acceptée.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"default": "ID de commande.",
"description": "ID de commande."
},
"status": {
"type": "string",
"example": "paid",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"description": "Statut de la commande. Consultez la section [Order life cycle](https://developers.xsolla.com/fr/api/catalog/order-life-cycle) pour une description détaillée des statuts."
},
"content": {
"type": "object",
"description": "Détails de la commande.",
"properties": {
"price": {
"type": "object",
"description": "Prix de la commande.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Prix de la commande réduit."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Prix de la commande."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de la commande. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_price": {
"type": "object",
"description": "Prix de la commande en monnaie virtuelle.",
"properties": {
"amount": {
"type": "string",
"example": "100",
"description": "Prix de la commande réduit."
},
"amount_without_discount": {
"type": "string",
"example": "150",
"description": "Prix de la commande."
},
"currency": {
"type": "string",
"example": "test_vc",
"description": "UGS de la monnaie virtuelle utilisée dans la commande."
}
}
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Si ce paramètre est défini sur `true`, la commande est gratuite."
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
],
"description": "Liste des objets.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "some_sku",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Quantité de l'objet."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"order_id": 1,
"status": "paid",
"content": {
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"is_free": false,
"items": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
]
}
}
}
}
}
}
},
"Cart-Payment_404-get-order": {
"description": "Commande non trouvée. Assurez-vous que les paramètres `project_id` et `order_id` sont corrects.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9001
},
"errorMessage": {
"type": "string",
"example": "[0401-9001]: Order not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found"
}
}
}
}
}
},
"200-admin-order-search": {
"description": "La liste des commandes a été récupérée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"description": "Liste des commandes.",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"description": "ID de commande."
},
"project_id": {
"type": "integer",
"example": 44056,
"description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet."
},
"status": {
"type": "string",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"example": "paid",
"description": "Statut de la commande. Consultez la section [Order life cycle](https://developers.xsolla.com/fr/api/catalog/order-life-cycle) pour une description détaillée des statuts."
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Date de création de la commande ou code date-heure selon la norme [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "Mode de création de commandes."
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Détermine la gratuité de la commande."
},
"invoice_id": {
"type": "string",
"description": "ID de facture."
},
"price": {
"type": [
"object",
"null"
],
"description": "Prix de la commande.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Prix final de la commande."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Prix de commande sans remise."
},
"currency": {
"type": "string",
"example": "USD",
"description": "UGS de la monnaie virtuelle ou code à trois lettres de devise réelle selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les [devises prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Détermine si la monnaie est virtuelle."
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "07e653a2b15011e6818f005056a54369",
"description": "ID utilisateur passé lors de la création de la commande."
},
"country": {
"type": "string",
"description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Consultez la documentation pour obtenir des informations détaillées sur les [pays pris en charge par Xsolla](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-countries/).",
"example": "US"
},
"email": {
"type": "string",
"format": "email",
"example": "user@xsolla.com",
"description": "Adresse e-mail de l'utilisateur formatée selon le protocole [RFC 822](https://www.w3.org/Protocols/rfc822/#z8)."
},
"region_id": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "ID de la région de l'utilisateur. Il est renvoyé si des restrictions de vente régionales ont été configurées. Le pays de l'utilisateur, passé lors de la création de la commande, est comparé à la liste des pays spécifiés lors de la [création de la région](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-create-region/). Pour plus d'informations sur les restrictions régionales de vente, consultez la [documentation](https://developers.xsolla.com/fr/doc/shop-builder/features/regional-restrictions/)."
}
}
},
"items": {
"type": "array",
"description": "Liste des objets.",
"items": {
"type": "object",
"properties": {
"order_item_id": {
"type": "integer",
"description": "ID de l'objet dans la commande. Il est généré par Xsolla lors de la création de la commande."
},
"item_id": {
"type": "integer",
"example": 1,
"description": "ID d'objet. Il est généré par Xsolla lors de la création d'un objet."
},
"sku": {
"type": "string",
"example": "elven_shield",
"description": "ID de l'objet spécifié lors de sa création. L'UGS ne peut contenir que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good",
"value_point"
]
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Quantité de l'objet."
},
"is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Détermine la gratuité de l'objet."
},
"is_bonus": {
"type": "boolean",
"example": false,
"description": "Détermine si l'objet est un bonus."
},
"region_id": {
"type": [
"integer",
"null"
],
"description": "ID de la région où l'objet est disponible. Reportez-vous à la [documentation](https://developers.xsolla.com/fr/doc/shop-builder/features/regional-restrictions/) pour plus d'informations sur les restrictions de vente régionales."
},
"tax_category": {
"type": "string",
"example": "DG00002",
"description": "Catégorie fiscale."
},
"price": {
"type": [
"object",
"null"
],
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Prix de l'objet sans remise."
},
"currency": {
"type": "string",
"example": "USD",
"description": "UGS de la monnaie virtuelle ou code à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les [devises prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Détermine si la monnaie est virtuelle."
}
}
},
"description": {
"type": [
"object",
"null"
],
"description": "Object with information about the item.",
"properties": {
"name": {
"type": "string",
"description": "Nom de l'objet."
},
"image_url": {
"type": "string",
"format": "uri",
"description": "Item image URL."
},
"description": {
"type": "string",
"description": "Description de l'objet."
}
}
}
}
}
},
"promotions": {
"type": [
"array",
"null"
],
"description": "Liste des promotions appliquées à la commande.",
"items": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"example": 111425,
"description": "ID de la promotion au sein du projet."
}
}
}
},
"coupons": {
"type": [
"array",
"null"
],
"description": "Liste de coupons appliqués à la commande.",
"items": {
"type": "object",
"properties": {
"coupon_id": {
"type": "integer",
"description": "ID du coupon, généré par Xsolla lors de la création d'une promotion par coupon."
},
"sku": {
"type": "string",
"description": "UGS du coupon, générée par Xsolla lors de la création d'une promotion par coupon."
},
"code": {
"type": "string",
"description": "Code du coupon utilisé. Code unique sensible à la casse. Contient des lettres et des chiffres."
},
"type": {
"type": "string",
"enum": [
"unique_catalog_offer",
"coupon",
"promocode"
],
"description": "Type de coupon."
}
}
}
}
}
}
},
"total_items_count": {
"type": "integer",
"example": 1,
"description": "Nombre total de commandes pour la période spécifiée."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Détermine la présence de pages supplémentaires."
}
}
},
"examples": {
"response": {
"value": {
"orders": [
{
"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [
{
"order_item_id": 29,
"item_id": 1005111,
"sku": "com.xsolla.1005111",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {
"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{
"order_item_id": 30,
"item_id": 1005112,
"sku": "com.xsolla.1005112",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{
"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 27,
"item_id": 1005101,
"sku": "com.xsolla.1005101",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {
"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{
"order_item_id": 28,
"item_id": 1005102,
"sku": "com.xsolla.1005102",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [
{
"promotion_id": 1005101
}
],
"coupons": [
{
"coupon_id": 100510,
"sku": "com.xsolla.100510",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{
"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 17,
"item_id": 1005051,
"sku": "com.xsolla.1005051",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{
"order_item_id": 18,
"item_id": 1005052,
"sku": "com.xsolla.1005052",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}
}
}
}
}
},
"401-invalid-basic-auth": {
"description": "L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_201-admin-create-payment-token": {
"description": "La commande et le jeton de paiement ont été créés avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Jeton de paiement."
},
"order_id": {
"type": "integer",
"example": 1,
"description": "ID de commande."
}
}
},
"examples": {
"response": {
"value": {
"token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb",
"order_id": 12345
}
}
}
}
}
},
"Cart-Payment_401-invalid-basic-auth": {
"description": "L'authentification de base n'a pas été passée ou est incorrecte. Vérifiez que vous avez utilisé l'authentification de base ou des informations d'identification correctes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_422-admin-create-payment-token": {
"description": "Erreur de validation du corps de la requête et de la création du panier.\n- Panier non valide, créé à partir d'objets passés. Vérifiez que le panier n'est pas vide et que tous les objets qu'il contient ne sont pas gratuits.\n- Corps de la requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Item is free": {
"value": {
"errorCode": 1421,
"statusCode": 422,
"errorMessage": "[0401-1421]: Item is free",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Invalid cart": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Empty cart": {
"value": {
"errorCode": 1417,
"statusCode": 422,
"errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"User country not provided": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"Cart-Payment_200-admin-fill-cart-json-model": {
"description": "Le panier contenant des objets a été renvoyé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID de panier. Passez-le à la requête pour la page d'achat ou aux endpoints de l'API de paiement."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Prix du panier."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Prix de l'objet."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "The cup of tea",
"groups": [
{
"external_id": "cups",
"name": "Cups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Cup",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"quantity": 2,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "White T-shirt",
"price": {
"amount": "3.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.t-shirt01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [
{
"external_id": "clothes",
"name": "Clothes"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"is_bonus": false,
"name": "Cat's cup",
"price": null,
"quantity": 1,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.hat01",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found"
}
],
"price": {
"amount": "15.97",
"amount_without_discount": "22.96",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-user": {
"description": "L'utilisateur n'a pas été trouvé. Assurez-vous que le jeton `x-user-for` ou `x-user-id` est correct.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 5008
},
"errorMessage": {
"type": "string",
"example": "[0401-5008]: Could not find User"
}
},
"type": "object"
}
}
}
},
"Common_401-invalid-basic-auth": {
"description": "Basic authentication credentials are not provided or are incorrect. Make sure you use basic authentication and verify that your credentials are correct.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"200-admin-get-user-item-limits": {
"description": "Les limites d'achat pour un utilisateur ont été reçues avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-item"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"connector-422-validation-failed": {
"description": "Erreur de validation basée sur le corps de la requête, les propriétés du fichier ou le contenu du fichier.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1803
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1803,
"errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"200-items-import-status-model": {
"description": "Statut d'importation récupéré avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "error",
"description": "Statut d'importation.\n\nValeurs possibles :\n- `initialized` — L'importation a été initiee.\n- `process` — L'importation est en cours.\n- `done` — L'importation est réussie.\n- `error` — En raison d'erreurs, l'importation n'a pas abouti ou n'a été que partiellement réalisée.",
"enum": [
"initialized",
"process",
"done",
"error"
]
},
"date_created": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Date de création de l'opération d'importation dans le fuseau horaire GMT+3."
},
"date_updated": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Date d'interruption de l'importation en raison d'une erreur dans le fuseau horaire GMT+3."
},
"date_completed": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Heure de fin de l'opération d'importation dans le fuseau horaire GMT+3. Si une erreur interrompt le processus et qu'aucun élément n'est importé, une chaîne vide sera renvoyée."
},
"progress": {
"type": "integer",
"example": 100,
"description": "État d'avancement de l'exécution de l'importation en pourcentage."
},
"error": {
"type": "string",
"description": "Description de l'erreur générale d'importation."
},
"error_code": {
"type": "string",
"description": "Code de l'erreur générale d'importation."
},
"result": {
"type": "object",
"description": "Objet contenant des données sur les résultats et les erreurs d'importation pour chaque UGS spécifique.",
"properties": {
"errors_count": {
"type": "integer",
"example": 3,
"description": "Nombre d'objets ayant des erreurs lors de l'importation."
},
"total_entities_count": {
"type": "integer",
"example": 11,
"description": "Nombre total d'objets importés."
},
"errors_by_sku": {
"type": "array",
"description": "Tableau d'objets contenant des données sur les erreurs d'importation pour des UGS spécifiques.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "sku_1",
"description": "UGS de l'objet importé."
},
"type": {
"type": "string",
"example": "vi",
"description": "Type d'objet.",
"enum": [
"virtual_good",
"virtual_currency",
"virtual_currency_packages",
"bundle"
]
},
"error_code": {
"type": "integer",
"example": 1001,
"description": "Code d'erreur d'importation pour une UGS spécifique."
},
"error_message": {
"type": "string",
"example": "Something went wrong",
"description": "Description de l'erreur d'importation pour une UGS spécifique."
}
}
}
}
}
}
},
"example": {
"status": "error",
"date_created": "2024-11-19T14:27:31+03:00",
"date_updated": "2024-11-19T15:27:31+03:00",
"date_completed": "2024-11-19T15:27:31+03:00",
"progress": 100,
"error": null,
"error_code": null,
"result": {
"errors_count": 2,
"total_entities_count": 10,
"errors_by_sku": [
{
"sku": "com.xsolla.sword_1",
"type": "virtual_items",
"error_code": 4055,
"error_message": "[0401-4055]: Item default price not set"
},
{
"sku": "",
"type": null,
"error_code": 1817,
"error_message": "[0410-1817]: SKU can't be empty"
}
]
}
}
}
}
}
},
"sellable_items_200-get-items-list": {
"description": "La liste des objets vendables a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets vendables.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_2",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_14",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"bundle_type": {
"type": "string",
"description": "Type de lot. Renvoyé si le type d'objet est un lot.",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Si `true`, l'utilisateur peut acheter l'objet."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"content": {
"type": "array",
"items": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Bundles_client_content"
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_2",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"sellable_items_200-get-item-by-id": {
"description": "L'objet vendable a été reçu avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur l'objet vendable.",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "electric_shield",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Si `true`, l'utilisateur peut acheter l'objet."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"examples": {
"response": {
"value": {
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 10
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"sellable-item-by-id_404": {
"description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_id` sont corrects.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 259774 not found"
}
}
}
}
}
},
"sellable-item-by-sku_404": {
"description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `sku` sont corrects.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'electric_shiel' not found"
}
}
}
}
}
},
"sellable_items_200-get-items-by-group-id": {
"description": "La liste des objets vendables du groupe spécifié a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Internal ID unique de l'objet, fourni lors de la création de l'objet."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nom de l'objet."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Electric shield",
"description": "Description de l'objet."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL de l'image."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Prix de l'objet.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet avec remise."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Prix de l'objet."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Type d'objet virtuel.\n\nValeurs possibles :\n- `consumable` — Objet qui disparaît de l'inventaire après utilisation (par exemple des munitions).\n- `non_consumable` — Objet conservé dans l'inventaire sans limite de durée.\n- `non_renewing_subscription` — Objet à durée limitée pouvant représenter un accès à des services ou du contenu pendant une période définie.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Si `true`, l'utilisateur peut acheter l'objet."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shields_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_2",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
]
}
}
}
}
}
},
"200-admin-get-regions-list": {
"description": "La liste des régions a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets.",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regions_200-region-short-model"
}
}
}
},
"examples": {
"response": {
"value": {
"regions": [
{
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
{
"id": 45,
"name": {
"en-US": "CIS",
"de-DE": "GUS"
}
}
]
}
}
}
}
}
},
"201-admin-create-region": {
"description": "La région a été créée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region_id": {
"$ref": "#/components/schemas/Regions_region_id"
}
}
},
"example": {
"region_id": 42
}
}
}
},
"200-admin-get-region": {
"description": "La région spécifiée a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Regions_200-region-model"
}
}
}
},
"404-region-not-found": {
"description": "Région non trouvée. Assurez-vous que le paramètre `id` est correct.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9701
},
"errorMessage": {
"type": "string",
"example": "[0401-9701]: Region not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-region": {
"description": "La région a été mise à jour avec succès.",
"content": {}
},
"204-admin-delete-region": {
"description": "La région a été supprimée avec succès.",
"content": {}
},
"200-admin-get-attribute-list-response": {
"description": "La liste des attributs a été reçue avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Informations sur les objets.",
"properties": {
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin_attribute_response"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"response": {
"value": {
"total_count": 2,
"attributes": [
{
"external_id": "size",
"name": {
"en": "Size",
"de": "Größe"
}
},
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
}
}
}
}
},
"201-admin-create-attribute": {
"description": "L'attribut a été créé avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
}
}
},
"example": {
"external_id": "genre"
}
}
}
},
"422-validation-failed": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"200-admin-get-attribute": {
"description": "L'attribut spécifié a été reçu avec succès.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_attribute_response"
}
}
}
},
"404-attribute-not-found": {
"description": "Attribut non trouvé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9901
},
"errorMessage": {
"type": "string",
"example": "[0401-9901]: Attribute not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-attribute": {
"description": "L'attribut a été mis à jour avec succès.",
"content": {}
},
"201-admin-create-attribute-value": {
"description": "La valeur de l'attribut a été créée avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
}
}
},
"example": {
"external_id": "rpg"
}
}
}
},
"403-auth-header-not-sent": {
"description": "L'en-tête d'autorisation n'a pas été passé.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "L'en-tête d'autorisation n'a pas été passé."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"422-create-update-attribute-value": {
"description": "Requête non valide.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"external_id is required": {
"$ref": "#/components/examples/422-external-id-required"
},
"external_id is invalid": {
"$ref": "#/components/examples/422-external-id-invalid"
},
"external_id is duplicate": {
"$ref": "#/components/examples/422-external-id-duplicate"
},
"value is required": {
"$ref": "#/components/examples/422-value-invalid"
},
"value properties minimum length": {
"$ref": "#/components/examples/422-value-properties-required"
},
"value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"404-attribute-value-not-found": {
"description": "Valeur d'attribut non trouvée.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404-not-found"
},
"examples": {
"Attribute not found": {
"$ref": "#/components/examples/404-attribute-not-found"
},
"Attribue value not found": {
"$ref": "#/components/examples/404-attribute-value-not-found"
}
}
}
}
}
},
"requestBodies": {
"Virtual-Items-Currency_admin-create-virtual-item": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item"
},
"examples": {
"default": {
"summary": "Minimal setup example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle."
}
}
},
"quickstart": {
"summary": "Quickstart example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster",
"de": "Mega-Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle.",
"de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte."
},
"is_enabled": true,
"is_show_in_store": true,
"is_free": false,
"groups": [
"boosters"
],
"order": 1,
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
]
}
},
"full-payload": {
"summary": "Full payload example",
"value": {
"sku": "com.xsolla.sword_1",
"name": {
"en": "Sword",
"de": "Schwert"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"weapons"
],
"order": 1,
"description": {
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
"de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist."
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
},
{
"amount": 200,
"currency": "CZK",
"country_iso": "CZ",
"is_enabled": false,
"is_default": true
}
],
"vc_prices": [],
"is_show_in_store": true,
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 100
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency"
},
"example": {
"sku": "com.xsolla.coin_1",
"name": {
"en-US": "Gold coin",
"de-DE": "Goldmünze"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"groups": [
"gold"
],
"order": 1,
"description": {
"en-US": "The main currency of your kingdom",
"de-DE": "Die Hauptwährung deines Königreichs"
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 10000
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.novigrad_crown_500",
"name": {
"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"witcher"
],
"order": 1,
"long_description": {
"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {
"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"attributes": [
{
"external_id": "event",
"name": {
"en-US": "Event"
},
"values": [
{
"external_id": "10-anniversary",
"value": {
"en-US": "10th anniversary"
}
},
{
"external_id": "christmas",
"value": {
"en-US": "Christmas"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": 99.99,
"is_default": true
},
{
"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [
{
"sku": "com.xsolla.novigrad_crown",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package"
}
}
}
},
"ItemGroup_create": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-create-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons",
"de": "Waffen"
},
"description": {
"en": "Player weapons",
"de": "Spielerwaffen"
},
"iconUrl": "https://example.com/weapons.png",
"isEnabled": true,
"order": 1
}
}
},
"description": "Objet avec les données du groupe d'objets.",
"required": true
},
"ItemGroup_update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-update-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons Updated",
"de": "Waffen Aktualisiert"
},
"description": {
"en": "Updated player weapons",
"de": "Aktualisierte Spielerwaffen"
},
"iconUrl": "https://example.com/weapons-new.png",
"isEnabled": true,
"order": 2
}
}
},
"description": "Objet avec les données du groupe d'objets à mettre à jour.",
"required": true
},
"ItemGroup_order": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Identifier par ID",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID du groupe d'objets attribué par Xsolla. ",
"minimum": 0,
"example": 1
},
"order": {
"type": "integer",
"description": "Nouvelle valeur d'ordre d'affichage.",
"minimum": 0,
"example": 1
}
},
"required": [
"id",
"order"
],
"additionalProperties": false
}
},
{
"title": "Identifier par external_id",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID externe du groupe d'objets défini lors de sa création.",
"minLength": 1,
"example": "weapons"
},
"order": {
"type": "integer",
"description": "Nouvelle valeur d'ordre d'affichage.",
"minimum": 0,
"example": 1
}
},
"required": [
"external_id",
"order"
],
"additionalProperties": false
}
}
]
},
"examples": {
"by_id": {
"summary": "Identify groups by ID",
"value": [
{
"id": 1,
"order": 1
},
{
"id": 2,
"order": 2
},
{
"id": 3,
"order": 3
}
]
},
"by_external_id": {
"summary": "Identify groups by external_id",
"value": [
{
"external_id": "weapons",
"order": 1
},
{
"external_id": "armor",
"order": 2
},
{
"external_id": "consumables",
"order": 3
}
]
}
}
}
},
"description": "Tableau de groupes avec les nouvelles valeurs d'ordre. Tous les objets doivent utiliser la même méthode d'identification (soit uniquement par `id`, soit uniquement par `external_id`).",
"required": true
},
"ItemGroup_item_order": {
"content": {
"application/json": {
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/item-in-group-order-request-item"
}
},
"example": [
{
"item_id": 101,
"order": 1
},
{
"item_id": 102,
"order": 2
},
{
"item_id": 103,
"order": 3
}
]
}
},
"description": "Tableau des objets avec les nouvelles valeurs d'ordre dans le groupe.",
"required": true
},
"Game-Keys_create-update-game-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL de l'image."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Type de média : `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Fichier de ressources."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"groups": {
"type": "array",
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes"
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être acheté et n'est pas accessible par le biais de l'inventaire."
},
"is_show_in_store": {
"type": "boolean",
"description": "L'objet est disponible à l'achat."
},
"unit_items": {
"type": "array",
"description": "Clés de jeu pour différents DRM.",
"items": {
"type": "object",
"description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"type": "array",
"description": "Groupes auxquels l'objet appartient.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Prix en devises réelles.",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Devise du prix de l'objet. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"is_default": {
"type": "boolean",
"description": "Le prix par défaut est utilisé pour constituer le catalogue si aucun prix n'est spécifié dans la devise de l'utilisateur."
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Ordre de priorité des jeux dans la liste."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet ne peut pas être acheté et n'est pas accessible par le biais de l'inventaire."
},
"is_show_in_store": {
"type": "boolean",
"description": "L'objet est disponible à l'achat."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID unique du DRM."
},
"pre_order": {
"type": "object",
"description": "Paramètres de pré-commande.",
"properties": {
"release_date": {
"type": "string",
"description": "Date de publication de la clé de jeu au format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande."
},
"description": {
"type": "string",
"description": "Additional information for the pre-order, which will be emailed."
}
},
"required": [
"release_date",
"is_enabled"
]
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/Game-key-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
},
"required": [
"sku",
"drm_sku",
"prices"
]
}
}
},
"required": [
"sku",
"name",
"unit_items"
],
"example": {
"sku": "com.xsolla.game_1",
"name": {
"en-US": "Game name",
"ru-RU": "Название игры"
},
"description": {
"en-US": "Game description",
"ru-RU": "Краткое описание игры"
},
"long_description": {
"en-US": "Game long description",
"ru-RU": "Полное описание игры"
},
"image_url": "http://image.png",
"media_list": [
{
"type": "image",
"url": "http://image.png"
},
{
"type": "video",
"url": "http://video.png"
}
],
"groups": [
"new_games"
],
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"sku": "com.xsolla.game_key_1",
"name": {
"en-US": "Game key name",
"ru-RU": "Название игрового ключа"
},
"drm_sku": "steam_key_1",
"prices": [
{
"amount": 35.5,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"vc_prices": [
{
"amount": 35.5,
"sku": "com.xsolla.gold_1",
"is_enabled": true,
"is_default": true
}
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
},
"description": "Objet contenant des données de jeu.",
"required": true
},
"Bundles_bundle": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_request"
},
"example": {
"sku": "com.xsolla.armour_chest_1",
"name": {
"en": "Chest of armour",
"de": "Brustpanzer"
},
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"order": 1,
"long_description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"image_url": "https://picture.bundle-with-many-stuff.png",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"groups": [
"chests"
],
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": "9.99",
"is_default": true,
"is_enabled": true
},
{
"currency": "EUR",
"amount": "9.99",
"is_default": false,
"is_enabled": true
}
],
"vc_prices": [],
"content": [
{
"sku": "com.xsolla.iron_gloves_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_boots_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_shield_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_armour_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_helmet_1",
"quantity": 1
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
},
"description": "Objet contenant des données du lot",
"required": true
},
"Cart-Payment_fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"sku": "com.xsolla.booster_mega_1",
"quantity": 123
}
]
},
"properties": {
"items": {
"type": "array",
"description": "Liste des objets.",
"items": {
"type": "object",
"minItems": 1,
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"default": "booster_mega_1"
},
"quantity": {
"type": "number",
"default": 123
}
}
}
}
}
}
}
}
},
"Cart-Payment_put-item-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "Quantité de l'objet.",
"default": 123
}
}
}
}
}
},
"Cart-Payment_create-order-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Devise du prix de la commande. Code de devise à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Langue de la réponse."
},
"sandbox": {
"type": "boolean",
"description": "Crée une commande en mode bac à sable. L'option est disponible pour les utilisateurs spécifiés dans la liste des utilisateurs de l'entreprise.",
"default": false
},
"settings": {
"type": "object",
"description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Paramètres spécifiques au projet.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"Cart-Payment_create-order-with-specified-item-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Devise du prix de la commande. Code de devise à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consultez la documentation pour obtenir des informations détaillées sur les devises [prises en charge par Xsolla](https://developers.xsolla.com/fr/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Langue de la réponse."
},
"sandbox": {
"type": "boolean",
"description": "Crée une commande en mode bac à sable. L'option est disponible pour les utilisateurs spécifiés dans la liste des utilisateurs de l'entreprise.",
"default": false
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "Quantité de l'objet.",
"default": 1
},
"promo_code": {
"type": "string",
"description": "Échange le code d'une promotion par code promo contre un paiement."
},
"settings": {
"type": "object",
"description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Paramètres spécifiques au projet.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"admin-order-search": {
"description": "Paramètres de recherche des commandes",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Limite sur le nombre de commandes incluses dans la réponse.",
"minimum": 1,
"maximum": 10,
"default": 10,
"nullable": false
},
"offset": {
"type": "integer",
"description": "Numéro de commande à partir de laquelle la liste est générée (le décompte commence à 0).",
"default": 0,
"minimum": 0,
"nullable": false
},
"created_date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-15T18:16:00+05:00",
"description": "Date de début ou date-heure de la période de création de la commande selon la norme [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"created_date_until": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-16T18:16:00+05:00",
"description": "Date de fin ou date-heure de la période de création de la commande selon la norme [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
}
}
},
"example": {
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}
}
}
},
"Cart-Payment_admin-create-payment-token": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"purchase"
],
"properties": {
"sandbox": {
"$ref": "#/components/schemas/Cart-Payment_settings_sandbox"
},
"user": {
"$ref": "#/components/schemas/Cart-Payment_admin-user-request-body"
},
"purchase": {
"$ref": "#/components/schemas/Cart_admin_payment"
},
"promo_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"settings": {
"type": "object",
"description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"language": {
"$ref": "#/components/schemas/Cart-Payment_settings_locale"
},
"external_id": {
"$ref": "#/components/schemas/Cart-Payment_settings_external_id"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"$ref": "#/components/schemas/Cart-Payment_custom_parameters_token"
}
},
"additionalProperties": false
},
"examples": {
"common": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/fr/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
}
}
},
"in-sandbox": {
"value": {
"sandbox": true,
"user": {
"id": {
"value": "user-id"
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"currency": "USD"
}
}
},
"with-custom-parameters": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/fr/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"custom_parameters": {
"user_public_id": "player1",
"user_os": "windows10"
}
}
}
}
}
}
},
"Cart-Payment_admin-fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart"
},
"examples": {
"basic": {
"value": {
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}
}
}
}
}
},
"reset-user-limits": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"reset-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"update-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 0
}
}
}
},
"update-user-limits-strict": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 1
}
}
}
},
"connector-import-items-body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connector_external_id",
"file_url"
],
"properties": {
"connector_external_id": {
"type": "string",
"description": "Valeur fixe déterminant le type d'opération pour l'importation d'objets.",
"enum": [
"import_items"
]
},
"file_url": {
"type": "string",
"description": "URL d'un fichier contenant des données au format JSON. Le fichier doit être hébergé sur un service de stockage à accès public. Téléchargez le modèle de fichier dans le Compte éditeur dans la section [Store > Virtual Items > Catalog Management > Import Items (JSON)](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items).",
"example": "https://my-bucket.s3.amazonaws.com/items.json"
},
"mode": {
"type": "string",
"description": "Actions d'importation :\n\nValeurs possibles :\n- `create` — Ajouter de nouveaux objets.\n- `create_and_update` — Ajouter de nouveaux objets et mettre à jour les objets existants.\n- `sync` — Ajouter de nouveaux objets, mettre à jour les objets existants et désactiver les objets manquants.",
"enum": [
"create",
"create_and_update",
"sync"
],
"default": "create_and_update"
}
}
}
}
}
},
"create-update-region": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"countries",
"name"
],
"properties": {
"countries": {
"$ref": "#/components/schemas/Regions_countries"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
},
"example": {
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
}
}
},
"create-update-attribute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
}
},
"example": {
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
}
}
},
"create-update-attribute-value": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/request-attribute-value"
},
"example": {
"external_id": "weapon_class_sword_value",
"value": {
"en": "Sword",
"de": "Schwert"
}
}
}
}
}
},
"examples": {
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attribute-values-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9909,
"errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attributes-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-value-limit-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-custom-attributes-size-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "da145238620011eb8e24fe6913ff226a",
"errorMessageExtended": [
{
"property": "custom_attributes",
"message": "JSON can’t exceed 500 characters."
}
]
}
},
"200-admin-get-group-list": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 3
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 4
}
]
}
},
"201-admin-create-group": {
"value": {
"external_id": "weapons"
}
},
"422-property-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "external_id",
"message": "The property external_id is required"
}
]
}
},
"200-admin-get-group": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
}
},
"200-admin-get-group-list-by-item-type": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 2,
"is_contains_any_items": true
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 0,
"is_contains_any_items": false
}
]
}
},
"200-admin-get-group-by-item-type": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
}
},
"404-game-code-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4603,
"errorMessage": "[0401-4603]: Game code not found.",
"transactionId": "transaction id"
}
},
"422-drm-is-not-drm-free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
},
"422-user-already-has-entitlement": {
"value": {
"statusCode": 422,
"errorCode": 5101,
"errorMessage": "[0401-5101]: User already has entitlement.",
"transactionId": "transaction id"
}
},
"Bundles_200-get-bundle-list": {
"value": {
"has_more": true,
"items": [
{
"item_id": 61031,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1",
"image_url": null,
"long_description": null,
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
],
"is_free": false,
"order": 999,
"groups": [
{
"external_id": "exclusive",
"name": "Exclusive",
"item_order_in_group": 1
}
],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"can_be_bought": true,
"bundle_type": "standard",
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "virtual_currency",
"quantity": 100,
"virtual_item_type": "non_consumable",
"attributes": [
{
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
}
],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
]
}
},
"Bundles_200-get-bundle": {
"value": {
"item_id": 610316,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1.",
"image_url": null,
"long_description": null,
"attributes": [],
"is_free": false,
"order": 999,
"groups": [],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"bundle_type": "standard",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
},
"404-item-by-sku-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found",
"transactionId": "transaction id"
}
},
"404-coupon-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9802,
"errorMessage": "[0401-9802]: Coupon not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-user-not-found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User",
"transactionId": "transaction id"
}
},
"422-user_external_id_invalid": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "transaction id",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
},
"422-item-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4508,
"errorMessage": "[0401-4508]: Item does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-item-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4510,
"errorMessage": "[0401-4510]: Available item limit is out of range.",
"transactionId": "transaction id"
}
},
"422-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-duplicate": {
"value": {
"statusCode": 422,
"errorCode": 9907,
"errorMessage": "[0401-9907]: The attribute value already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-properties-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-value-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9906,
"errorMessage": "[0401-9906]: Attribute value not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"x-tagGroups": [
{
"name": "OBJETS ET MONNAIE VIRTUELS",
"tags": [
"virtual-items-currency-overview",
"virtual-items-currency-admin",
"virtual-items-currency-catalog",
"virtual-payment"
]
},
{
"name": "CLÉS DE JEU",
"tags": [
"game-keys-overview",
"game-keys-catalog",
"game-keys-entitlement",
"game-keys-admin"
]
},
{
"name": "LOTS",
"tags": [
"bundles-overview",
"bundles-admin",
"bundles-catalog"
]
},
{
"name": "PANIER ET PAIEMENT",
"tags": [
"cart-and-payment-overview",
"order-life-cycle",
"cart-client-side",
"cart-server-side",
"payment-client-side",
"payment-server-side",
"order",
"free-item"
]
},
{
"name": "LIMITES",
"tags": [
"limits-overview",
"user-limits-admin"
]
},
{
"name": "OBJETS IMPORTÉS",
"tags": [
"connector-admin"
]
},
{
"name": "COMMUNS",
"tags": [
"common-pre-orders",
"common-merchant",
"common-catalog",
"common-regions",
"common-webhooks"
]
},
{
"name": "ATTRIBUTS DE BIEN",
"tags": [
"attribute-admin"
]
},
{
"name": "GROUPES D'OBJETS",
"tags": [
"item-groups-admin",
"item-groups-catalog"
]
}
]
}