{ "components": { "examples": { "200-admin-get-group": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-by-item-type": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-list": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_enabled": true, "items_count": 3, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_enabled": true, "items_count": 4, "name": { "en": "Armor" }, "order": 3 } ] } }, "200-admin-get-group-list-by-item-type": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 2, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_contains_any_items": false, "is_enabled": true, "items_count": 0, "name": { "en": "Armor" }, "order": 3 } ] } }, "201-admin-create-group": { "value": { "external_id": "weapons" } }, "404-attribute-not-found": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-attribute-value-not-found": { "value": { "errorCode": 9906, "errorMessage": "[0401-9906]: Attribute value not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-coupon-not-found": { "value": { "errorCode": 9802, "errorMessage": "[0401-9802]: Coupon not found", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-game-code-not-found": { "value": { "errorCode": 4603, "errorMessage": "[0401-4603]: Game code not found.", "statusCode": 404, "transactionId": "transaction id" } }, "404-item-by-sku-not-found": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found", "statusCode": 404, "transactionId": "transaction id" } }, "404-user-not-found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404, "transactionId": "transaction id" } }, "422-custom-attributes-size-exceeded": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "JSON can’t exceed 500 characters.", "property": "custom_attributes" } ], "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-drm-is-not-drm-free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } }, "422-external-id-duplicate": { "value": { "errorCode": 9907, "errorMessage": "[0401-9907]: The attribute value already exists.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-item-out-of-range-available-user-limit": { "value": { "errorCode": 4510, "errorMessage": "[0401-4510]: Available item limit is out of range.", "statusCode": 422, "transactionId": "transaction id" } }, "422-item-without-user-limit": { "value": { "errorCode": 4508, "errorMessage": "[0401-4508]: Item does not have configured user limits.", "statusCode": 422, "transactionId": "transaction id" } }, "422-numbers-of-attribute-values-per-item-exceeded": { "value": { "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.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-numbers-of-attributes-per-item-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-property-external-id-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "The property external_id is required", "property": "external_id" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-property-sku-is-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-user-already-has-entitlement": { "value": { "errorCode": 5101, "errorMessage": "[0401-5101]: User already has entitlement.", "statusCode": 422, "transactionId": "transaction id" } }, "422-user_external_id_invalid": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404, "transactionId": "transaction id" } }, "422-value-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-limit-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-properties-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Bundles_200-get-bundle": { "value": { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1.", "groups": [], "image_url": null, "is_free": false, "item_id": 610316, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } }, "Bundles_200-get-bundle-list": { "value": { "has_more": true, "items": [ { "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" } ] } ], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [ { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] } ], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_item_type": "non_consumable", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1", "groups": [ { "external_id": "exclusive", "item_order_in_group": 1, "name": "Exclusive" } ], "image_url": null, "is_free": false, "item_id": 61031, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "parameters": { "additional_fields-entitlement-query-param": { "description": "Liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête. Champs disponibles `attributes`.", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "additional_fields-query-param": { "description": "La liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête.", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "enum": [ "media_list", "order", "long_description", "custom_attributes", "item_order_in_group" ], "type": "string" }, "type": "array" } }, "cart_id-path-param": { "description": "ID de panier.", "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" } }, "country-query-param": { "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).", "in": "query", "name": "country", "required": false, "schema": { "example": "US", "type": "string" } }, "currency-query-param": { "description": "Devise du prix de l'article 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/).", "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" } }, "external_id-attr-path-param": { "description": "External ID de l'attribut.", "in": "path", "name": "external_id", "required": true, "schema": { "example": "attribute_id", "type": "string" } }, "external_id-group-path-param": { "description": "External item group ID specified during creation.", "in": "path", "name": "external_id", "required": true, "schema": { "example": "weapons", "type": "string" } }, "external_id_59080-group-path-param": { "description": "External ID du groupe.", "in": "path", "name": "external_id", "required": true, "schema": { "default": "armour", "type": "string" } }, "group_id-path-param": { "description": "ID du groupe.", "in": "path", "name": "group_id", "required": true, "schema": { "example": 10, "type": "integer" } }, "id-group-path-param": { "description": "Item group ID assigned by Xsolla.", "in": "path", "name": "id", "required": true, "schema": { "example": 1, "type": "integer" } }, "item_id-path-param": { "description": "ID de l'objet", "in": "path", "name": "item_id", "required": true, "schema": { "example": "656", "type": "string" } }, "item_id_59080-path-param": { "description": "ID de l'objet", "in": "path", "name": "item_id", "required": true, "schema": { "example": "259774", "type": "string" } }, "item_sku-path-param": { "description": "UGS de l'objet.", "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" } }, "item_sku_59080-path-param": { "description": "UGS de l'objet.", "in": "path", "name": "sku", "required": true, "schema": { "example": "electric_shield", "type": "string" } }, "item_type-group-path-param": { "description": "Item type used to filter groups. Determines which items are included in `items_count`. Values containing `/` (for example, `virtual_currency/package` or `game/key`) must be URL-encoded (for example, `virtual_currency%2Fpackage`).", "in": "path", "name": "item_type", "required": true, "schema": { "enum": [ "virtual_items", "virtual_currency", "virtual_currency/package", "game/key", "bundle", "game", "value_points", "subscription_plans" ], "example": "virtual_items", "type": "string" } }, "limit-query-param": { "description": "Nombre maximal d'éléments sur une page.", "example": 50, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "minimum": 1, "type": "integer" } }, "locale-query-param": { "description": "Response language. Two-letter lowercase language code per ISO 639-1 (for example, `en`). Five-character locale codes (for example, `en-US`) are supported in localization fields such as `name` and `description`, but are normalized to two-letter codes in responses. You can find the full list of supported languages in the [documentation](https://developers.xsolla.com/fr/doc/shop-builder/references/supported-languages/).", "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" } }, "merchant_id-path-param": { "description": "ID de commerçant.", "in": "path", "name": "merchant_id", "required": true, "schema": { "example": 121212, "type": "integer" } }, "offset-query-param": { "description": "Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).", "example": 0, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "minimum": 0, "type": "integer" } }, "order_id-path-param": { "description": "ID de commande.", "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" } }, "platform-query-param": { "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`.", "in": "query", "name": "platform", "required": false, "schema": { "default": "xsolla", "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" ], "type": "string" } }, "project_id-path-param": { "description": "Project ID. You can find this parameter in your [Publisher Account](https://publisher.xsolla.com/0/projects/0/) next to the project name and in the browser address bar when working with a project. The URL has the following format: `https://publisher.xsolla.com//projects/`.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" } }, "project_id_59080-path-param": { "description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 59080, "type": "integer" } }, "promo_code-query-param": { "description": "Code unique sensible à la casse. Comprend des lettres et des chiffres.", "in": "query", "name": "promo_code", "required": false, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "quantity-query-param": { "description": "Quantité de codes.", "in": "query", "name": "quantity", "required": true, "schema": { "example": 100, "type": "integer" } }, "reason-query-param": { "description": "Raison pour laquelle les codes sont reçus.", "in": "query", "name": "reason", "required": true, "schema": { "example": "Very important", "type": "string" } }, "region_id-path-param": { "description": "ID de la région. Identifiant unique de la région au sein du projet.", "in": "path", "name": "region_id", "required": true, "schema": { "example": 42, "type": "integer" } }, "region_id-query-param": { "description": "ID de la région.", "in": "query", "name": "region_id", "required": false, "schema": { "default": 1, "type": "integer" } }, "sandbox-query-param": { "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.", "in": "query", "name": "sandbox", "required": false, "schema": { "default": 0, "type": "integer" } }, "show_inactive_time_limited_items-query-param": { "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é.", "in": "query", "name": "show_inactive_time_limited_items", "required": false, "schema": { "default": 0, "example": 1, "type": "integer" } }, "sku-path-param": { "description": "UGS du lot.", "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" } }, "user_email-query-param": { "description": "Adresse e-mail de l'utilisateur.", "in": "query", "name": "user_email", "required": true, "schema": { "example": "email@email.com", "type": "string" } }, "user_external_id-query-param": { "description": "External ID de l'utilisateur", "in": "query", "name": "user_external_id", "required": true, "schema": { "example": "d342dad2-9d59-11e9-a384-42010aa8003f", "type": "string" } }, "value_external_id-path-param": { "description": "External ID de la valeur de l'attribut.", "in": "path", "name": "value_external_id", "required": true, "schema": { "example": "value_id", "pattern": "^[-_\\.\\d\\w]+$", "type": "string" } }, "virtual_currency_package_sku-path-param": { "description": "UGS du package de monnaie virtuelle.", "in": "path", "name": "virtual_currency_package_sku", "required": true, "schema": { "example": "crystal-pack", "type": "string" } }, "virtual_currency_sku-path-param": { "description": "UGS de la monnaie virtuelle.", "in": "path", "name": "virtual_currency_sku", "required": true, "schema": { "example": "crystal", "type": "string" } }, "with_geo-query-param": { "description": "Whether to return the user's locale and country information in the response headers. If set to `true`, the response includes `X-User-Locale-Code` and `X-User-Country-Code` headers.", "in": "query", "name": "with_geo", "required": false, "schema": { "default": false, "type": "boolean" } }, "x-user-for-header": { "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).", "example": "ACCESS_TOKEN/LOGIN_JWT", "in": "header", "name": "x-user-for", "required": false, "schema": { "type": "string" } }, "x-user-id-header": { "description": "Vous pouvez utiliser votre propre ID utilisateur lorsque vous vendez un panier contenant des jeux.", "example": "UNIQUE_ID", "in": "header", "name": "x-user-id", "required": false, "schema": { "maxLength": 32, "type": "string" } } }, "requestBodies": { "Bundles_bundle": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "class", "name": { "en": "Class" }, "values": [ { "external_id": "soldier", "value": { "en": "Soldier" } }, { "external_id": "officer", "value": { "en": "Officer" } } ] } ], "content": [ { "quantity": 1, "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" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "groups": [ "chests" ], "image_url": "https://picture.bundle-with-many-stuff.png", "is_enabled": true, "is_free": true, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "de": "Brustpanzer", "en": "Chest of armour" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "9.99", "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": "9.99", "currency": "EUR", "is_default": false, "is_enabled": true } ], "sku": "com.xsolla.armour_chest_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_request" } } }, "description": "Objet contenant des données du lot", "required": true }, "Cart-Payment_admin-create-payment-token": { "content": { "application/json": { "examples": { "common": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/fr/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } }, "in-sandbox": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "sandbox": true, "settings": { "currency": "USD" }, "user": { "id": { "value": "user-id" } } } }, "with-custom-parameters": { "value": { "custom_parameters": { "user_os": "windows10", "user_public_id": "player1" }, "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/fr/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } } }, "schema": { "additionalProperties": false, "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters_token" }, "promo_code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "purchase": { "$ref": "#/components/schemas/Cart_admin_payment" }, "sandbox": { "$ref": "#/components/schemas/Cart-Payment_settings_sandbox" }, "settings": { "additionalProperties": false, "description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.", "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "external_id": { "$ref": "#/components/schemas/Cart-Payment_settings_external_id" }, "language": { "$ref": "#/components/schemas/Cart-Payment_settings_locale" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" }, "user": { "$ref": "#/components/schemas/Cart-Payment_admin-user-request-body" } }, "required": [ "user", "purchase" ], "type": "object" } } } }, "Cart-Payment_admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "basic": { "value": { "currency": "USD", "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart" } } } }, "Cart-Payment_create-order-by-cart-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "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/).", "type": "string" }, "custom_parameters": { "description": "Paramètres spécifiques au projet.", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "Langue de la réponse.", "type": "string" }, "sandbox": { "default": false, "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.", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_create-order-with-specified-item-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "promo_code": "discount_code", "quantity": 5, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "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/).", "type": "string" }, "custom_parameters": { "description": "Paramètres spécifiques au projet.", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "Langue de la réponse.", "type": "string" }, "promo_code": { "description": "Échange le code d'une promotion par code promo contre un paiement.", "type": "string" }, "quantity": { "default": 1, "description": "Quantité de l'objet.", "minimum": 1, "type": "integer" }, "sandbox": { "default": false, "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.", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "Paramètres pour la configuration de la procédure de paiement et de l'interface de paiement pour l'utilisateur.", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_fill-cart-json-model": { "content": { "application/json": { "schema": { "example": { "items": [ { "quantity": 123, "sku": "com.xsolla.booster_mega_1" } ] }, "properties": { "items": { "description": "Liste des objets.", "items": { "minItems": 1, "properties": { "quantity": { "default": 123, "type": "number" }, "sku": { "default": "booster_mega_1", "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" } } } }, "Cart-Payment_put-item-by-cart-idJsonModel": { "content": { "application/json": { "schema": { "properties": { "quantity": { "default": 123, "description": "Quantité de l'objet.", "type": "number" } }, "type": "object" } } } }, "Game-Keys_create-update-game-model": { "content": { "application/json": { "schema": { "example": { "description": { "en-US": "Game description", "ru-RU": "Краткое описание игры" }, "groups": [ "new_games" ], "image_url": "http://image.png", "is_enabled": true, "is_show_in_store": true, "long_description": { "en-US": "Game long description", "ru-RU": "Полное описание игры" }, "media_list": [ { "type": "image", "url": "http://image.png" }, { "type": "video", "url": "http://video.png" } ], "name": { "en-US": "Game name", "ru-RU": "Название игры" }, "sku": "com.xsolla.game_1", "unit_items": [ { "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "total": 5 } }, "name": { "en-US": "Game key name", "ru-RU": "Название игрового ключа" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 35.5, "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_key_1", "vc_prices": [ { "amount": 35.5, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" } ] } ] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "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.", "type": "boolean" }, "is_show_in_store": { "description": "L'objet est disponible à l'achat.", "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "Type de média : `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "Fichier de ressources.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "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.", "example": "game_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "unit_items": { "description": "Clés de jeu pour différents DRM.", "items": { "description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_sku": { "description": "ID unique du DRM.", "example": "steam", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "is_enabled": { "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.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "L'objet est disponible à l'achat.", "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Game-key-item-limit" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "pre_order": { "description": "Paramètres de pré-commande.", "properties": { "description": { "description": "Informations supplémentaires pour la pré-commande, qui sera envoyée par e-mail.", "type": "string" }, "is_enabled": { "description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande.", "type": "boolean" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "type": "string" } }, "required": [ "release_date", "is_enabled" ], "type": "object" }, "prices": { "description": "Prix en devises réelles.", "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "RUB", "type": "string" }, "is_default": { "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.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "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.", "example": "game_1", "maxLength": 255, "minLength": 1, "type": "string" }, "vc_prices": { "items": { "properties": { "amount": { "type": "number" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "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.", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "drm_sku", "prices" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "name", "unit_items" ], "type": "object" } } }, "description": "Objet contenant des données de jeu.", "required": true }, "ItemGroup_create": { "content": { "application/json": { "example": { "description": { "de": "Spielerwaffen", "en": "Player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons.png", "isEnabled": true, "name": { "de": "Waffen", "en": "Weapons" }, "order": 1 }, "schema": { "$ref": "#/components/schemas/admin-group-create-request" } } }, "description": "Object with item group data.", "required": true }, "ItemGroup_item_order": { "content": { "application/json": { "example": [ { "item_id": 101, "order": 1 }, { "item_id": 102, "order": 2 }, { "item_id": 103, "order": 3 } ], "schema": { "items": { "$ref": "#/components/schemas/item-in-group-order-request-item" }, "type": "array", "uniqueItems": true } } }, "description": "Array of items with new order values in the group.", "required": true }, "ItemGroup_order": { "content": { "application/json": { "examples": { "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 } ] }, "by_id": { "summary": "Identify groups by ID", "value": [ { "id": 1, "order": 1 }, { "id": 2, "order": 2 }, { "id": 3, "order": 3 } ] } }, "schema": { "oneOf": [ { "items": { "additionalProperties": false, "properties": { "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "id", "order" ], "type": "object" }, "title": "Identify by ID", "type": "array", "uniqueItems": true }, { "items": { "additionalProperties": false, "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "minLength": 1, "type": "string" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "external_id", "order" ], "type": "object" }, "title": "Identify by external_id", "type": "array", "uniqueItems": true } ] } } }, "description": "Array of groups with new order values. All items must use the same identification method (either all by `id` or all by `external_id`).", "required": true }, "ItemGroup_update": { "content": { "application/json": { "example": { "description": { "de": "Aktualisierte Spielerwaffen", "en": "Updated player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons-new.png", "isEnabled": true, "name": { "de": "Waffen Aktualisiert", "en": "Weapons Updated" }, "order": 2 }, "schema": { "$ref": "#/components/schemas/admin-group-update-request" } } }, "description": "Object with item group data to update.", "required": true }, "Virtual-Items-Currency_admin-create-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "material", "name": { "en-US": "Material" }, "values": [ { "external_id": "gold", "value": { "en-US": "Gold" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "de-DE": "Die Hauptwährung deines Königreichs", "en-US": "The main currency of your kingdom" }, "groups": [ "gold" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "limits": { "per_item": 10000, "per_user": 5 }, "name": { "de-DE": "Goldmünze", "en-US": "Gold coin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.coin_1" }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency" } } } }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "content": { "application/json": { "example": { "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" } } ] } ], "content": [ { "quantity": 500, "sku": "com.xsolla.novigrad_crown" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms", "ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах" }, "groups": [ "witcher" ], "image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "en-US": "Long Test new", "ru-RU": "Длинное описание" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "en-US": "500x Novigradian crown", "ru-RU": "500x Новиградских крон" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 99.99, "currency": "USD", "is_default": true }, { "amount": 80.03, "currency": "EUR", "is_enabled": false } ], "sku": "com.xsolla.novigrad_crown_500", "vc_prices": null }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package" } } } }, "Virtual-Items-Currency_admin-create-virtual-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "craft-materials", "name": { "en": "Craft materials" }, "values": [ { "external_id": "steel", "value": { "en-US": "5" } }, { "external_id": "leather", "value": { "en-US": "1" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "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.", "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." }, "groups": [ "weapons" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": 100, "per_user": 5 }, "name": { "de": "Schwert", "en": "Sword" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 200, "country_iso": "CZ", "currency": "CZK", "is_default": true, "is_enabled": false } ], "sku": "com.xsolla.sword_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item" } } } }, "admin-order-search": { "content": { "application/json": { "example": { "created_date_from": "2018-01-07T00:00:00+03:00", "created_date_until": "2018-01-09T16:00:00+03:00", "limit": 5, "offset": 0 }, "schema": { "properties": { "created_date_from": { "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).", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "created_date_until": { "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": "2020-04-16T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "limit": { "default": 10, "description": "Limite sur le nombre de commandes incluses dans la réponse.", "maximum": 10, "minimum": 1, "nullable": false, "type": "integer" }, "offset": { "default": 0, "description": "Numéro de commande à partir de laquelle la liste est générée (le décompte commence à 0).", "minimum": 0, "nullable": false, "type": "integer" } }, "type": "object" } } }, "description": "Paramètres de recherche des commandes" }, "connector-import-items-body": { "content": { "application/json": { "schema": { "properties": { "connector_external_id": { "description": "Valeur fixe déterminant le type d'opération pour l'importation d'objets.", "enum": [ "import_items" ], "type": "string" }, "file_url": { "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", "type": "string" }, "mode": { "default": "create_and_update", "description": "Import actions:\n\nPossible values:\n- `create` — Add new items.\n- `create_and_update` — Add new items and update existing ones.\n- `sync` — Add new, update existing, and disable missing items.", "enum": [ "create", "create_and_update", "sync" ], "type": "string" } }, "required": [ "connector_external_id", "file_url" ], "type": "object" } } } }, "create-update-attribute": { "content": { "application/json": { "example": { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "create-update-attribute-value": { "content": { "application/json": { "example": { "external_id": "weapon_class_sword_value", "value": { "de": "Schwert", "en": "Sword" } }, "schema": { "$ref": "#/components/schemas/request-attribute-value" } } } }, "create-update-region": { "content": { "application/json": { "schema": { "example": { "countries": [ "JP", "CN", "VN" ], "name": { "de-DE": "Asien", "en-US": "Asia" } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "required": [ "countries", "name" ], "type": "object" } } } }, "reset-user-limits": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user" ], "type": "object" } } } }, "reset-user-limits-flexible": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user_flexible" } }, "required": [ "user" ], "type": "object" } } } }, "update-user-limits-flexible": { "content": { "application/json": { "example": { "available": 0, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available_flexible" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } }, "update-user-limits-strict": { "content": { "application/json": { "example": { "available": 1, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } } }, "responses": { "200-admin-get-attribute": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin_attribute_response" } } }, "description": "L'attribut spécifié a été reçu avec succès." }, "200-admin-get-attribute-list-response": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "size", "name": { "de": "Größe", "en": "Size" } }, { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ], "total_count": 2 } } }, "schema": { "description": "Informations sur les objets.", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/admin_attribute_response" }, "type": "array" }, "total_count": { "type": "integer" } }, "type": "object" } } }, "description": "La liste des attributs a été reçue avec succès." }, "200-admin-get-region": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions_200-region-model" } } }, "description": "La région spécifiée a été reçue avec succès." }, "200-admin-get-regions-list": { "content": { "application/json": { "examples": { "response": { "value": { "regions": [ { "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } }, { "id": 45, "name": { "de-DE": "GUS", "en-US": "CIS" } } ] } } }, "schema": { "description": "Informations sur les objets.", "properties": { "regions": { "items": { "$ref": "#/components/schemas/Regions_200-region-short-model" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des régions a été reçue avec succès." }, "200-admin-get-user-item-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-item" } } }, "description": "Les limites d'achat pour un utilisateur ont été reçues avec succès." }, "200-admin-order-search": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "orders": [ { "date_created": "2018-01-08T15:32:06+03:00", "is_free": true, "items": [ { "description": { "description": "yes", "image_url": "http://example.com/image.jpg", "name": "bla" }, "is_bonus": false, "is_free": true, "item_id": 1005111, "order_item_id": 29, "quantity": 1, "region_id": 1, "sku": "com.xsolla.1005111", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005112, "order_item_id": 30, "quantity": 3, "region_id": 1, "sku": "com.xsolla.1005112", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100511, "project_id": 101, "status": "done", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": 1 } }, { "coupons": [ { "code": "OPQRSTUVWX", "coupon_id": 100510, "sku": "com.xsolla.100510", "type": "promocode" } ], "date_created": "2018-01-07T15:32:06+03:00", "invoice_id": "100510", "is_free": false, "items": [ { "description": null, "is_bonus": false, "is_free": false, "item_id": 1005101, "order_item_id": 27, "price": { "amount": "67.3400", "amount_without_discount": "67.3400", "currency": "USD", "is_virtual_currency": false }, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005101", "tax_category": "DG00001", "type": "game_key" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005102, "order_item_id": 28, "quantity": 2, "region_id": null, "sku": "com.xsolla.1005102", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100510, "price": { "amount": "67.3400", "amount_without_discount": "72.3400", "currency": "USD", "is_virtual_currency": false }, "project_id": 101, "promotions": [ { "promotion_id": 1005101 } ], "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } }, { "date_created": "2018-01-02T15:32:06+03:00", "is_free": false, "items": [ { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005051, "order_item_id": 17, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005051", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005052, "order_item_id": 18, "quantity": 3, "region_id": null, "sku": "com.xsolla.1005052", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100505, "price": { "amount": "78.2300", "amount_without_discount": "78.2300", "currency": "popugi", "is_virtual_currency": true }, "project_id": 101, "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } } ], "total_items_count": 11 } } }, "schema": { "properties": { "has_more": { "description": "Détermine la présence de pages supplémentaires.", "example": true, "type": "boolean" }, "orders": { "description": "Liste des commandes.", "items": { "properties": { "coupons": { "description": "Liste de coupons appliqués à la commande.", "items": { "properties": { "code": { "description": "Code du coupon utilisé. Code unique sensible à la casse. Contient des lettres et des chiffres.", "type": "string" }, "coupon_id": { "description": "ID du coupon, généré par Xsolla lors de la création d'une promotion par coupon.", "type": "integer" }, "sku": { "description": "UGS du coupon, générée par Xsolla lors de la création d'une promotion par coupon.", "type": "string" }, "type": { "description": "Type de coupon.", "enum": [ "unique_catalog_offer", "coupon", "promocode" ], "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "date_created": { "description": "Date de création de la commande ou code date-heure selon la norme [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "invoice_id": { "description": "ID de facture.", "type": "string" }, "is_free": { "description": "Détermine la gratuité de la commande.", "example": false, "type": "boolean" }, "items": { "description": "Liste des objets.", "items": { "properties": { "description": { "description": "Objet contenant des informations sur le bien.", "properties": { "description": { "description": "Description de l'objet.", "type": "string" }, "image_url": { "description": "URL de l'image de l'objet.", "format": "uri", "type": "string" }, "name": { "description": "Nom de l'objet.", "type": "string" } }, "type": [ "object", "null" ] }, "is_bonus": { "description": "Détermine si l'objet est un bonus.", "example": false, "type": "boolean" }, "is_free": { "default": false, "description": "Détermine la gratuité de l'objet.", "example": false, "type": "boolean" }, "item_id": { "description": "ID d'objet. Il est généré par Xsolla lors de la création d'un objet.", "example": 1, "type": "integer" }, "order_item_id": { "description": "ID de l'objet dans la commande. Il est généré par Xsolla lors de la création de la commande.", "type": "integer" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet sans remise.", "example": "30", "type": "string" }, "currency": { "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/).", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "Détermine si la monnaie est virtuelle.", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "quantity": { "description": "Quantité de l'objet.", "example": 1, "type": "integer" }, "region_id": { "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.", "type": [ "integer", "null" ] }, "sku": { "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.", "example": "elven_shield", "type": "string" }, "tax_category": { "description": "Catégorie fiscale.", "example": "DG00002", "type": "string" }, "type": { "description": "Type d'objet.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point" ], "example": "virtual_good", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "description": "Mode de création de commandes.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "order_id": { "description": "ID de commande.", "example": 1, "type": "integer" }, "price": { "description": "Prix de la commande.", "properties": { "amount": { "description": "Prix final de la commande.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de commande sans remise.", "example": "30", "type": "string" }, "currency": { "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/).", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "Détermine si la monnaie est virtuelle.", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "project_id": { "description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet.", "example": 44056, "type": "integer" }, "promotions": { "description": "Liste des promotions appliquées à la commande.", "items": { "properties": { "promotion_id": { "description": "ID de la promotion au sein du projet.", "example": 111425, "type": "integer" } }, "type": "object" }, "type": [ "array", "null" ] }, "status": { "description": "Statut de la commande.", "enum": [ "new", "paid", "done", "canceled", "expired" ], "example": "paid", "type": "string" }, "user": { "properties": { "country": { "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", "type": "string" }, "email": { "description": "Adresse e-mail de l'utilisateur formatée selon le protocole [RFC 822](https://www.w3.org/Protocols/rfc822/#z8).", "example": "user@xsolla.com", "format": "email", "type": "string" }, "id": { "description": "ID utilisateur passé lors de la création de la commande.", "example": "07e653a2b15011e6818f005056a54369", "type": "string" }, "region_id": { "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/).", "example": 12, "type": [ "integer", "null" ] } }, "type": "object" } }, "type": "object" }, "type": "array" }, "total_items_count": { "description": "Nombre total de commandes pour la période spécifiée.", "example": 1, "type": "integer" } }, "type": "object" } } }, "description": "La liste des commandes a été récupérée avec succès." }, "200-items-import-status-model": { "content": { "application/json": { "schema": { "example": { "date_completed": "2024-11-19T15:27:31+03:00", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "error": null, "error_code": null, "progress": 100, "result": { "errors_by_sku": [ { "error_code": 4055, "error_message": "[0401-4055]: Item default price not set", "sku": "com.xsolla.sword_1", "type": "virtual_items" }, { "error_code": 1817, "error_message": "[0410-1817]: SKU can't be empty", "sku": "", "type": null } ], "errors_count": 2, "total_entities_count": 10 }, "status": "error" }, "properties": { "date_completed": { "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.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_created": { "description": "Date de création de l'opération d'importation dans le fuseau horaire GMT+3.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_updated": { "description": "Date d'interruption de l'importation en raison d'une erreur dans le fuseau horaire GMT+3.", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "error": { "description": "Description de l'erreur générale d'importation.", "type": "string" }, "error_code": { "description": "Code de l'erreur générale d'importation.", "type": "string" }, "progress": { "description": "État d'avancement de l'exécution de l'importation en pourcentage.", "example": 100, "type": "integer" }, "result": { "description": "Objet contenant des données sur les résultats et les erreurs d'importation pour chaque UGS spécifique.", "properties": { "errors_by_sku": { "description": "Tableau d'objets contenant des données sur les erreurs d'importation pour des UGS spécifiques.", "items": { "properties": { "error_code": { "description": "Code d'erreur d'importation pour une UGS spécifique.", "example": 1001, "type": "integer" }, "error_message": { "description": "Description de l'erreur d'importation pour une UGS spécifique.", "example": "Something went wrong", "type": "string" }, "sku": { "description": "UGS de l'objet importé.", "example": "sku_1", "type": "string" }, "type": { "description": "Type d'objet.", "enum": [ "virtual_good", "virtual_currency", "virtual_currency_packages", "bundle" ], "example": "vi", "type": "string" } }, "type": "object" }, "type": "array" }, "errors_count": { "description": "Nombre d'objets ayant des erreurs lors de l'importation.", "example": 3, "type": "integer" }, "total_entities_count": { "description": "Nombre total d'objets importés.", "example": 11, "type": "integer" } }, "type": "object" }, "status": { "description": "Import status.\n\nPossible values:\n- `initialized` — Import has been initiated.\n- `process` — Import is in progress.\n- `done` — Import was successfull.\n- `error` — Due to errors, the import was not completed or only partially completed.", "enum": [ "initialized", "process", "done", "error" ], "example": "error", "type": "string" } }, "type": "object" } } }, "description": "Statut d'importation récupéré avec succès." }, "201-admin-create-attribute": { "content": { "application/json": { "example": { "external_id": "genre" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" } }, "type": "object" } } }, "description": "L'attribut a été créé avec succès." }, "201-admin-create-attribute-value": { "content": { "application/json": { "example": { "external_id": "rpg" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" } }, "type": "object" } } }, "description": "La valeur de l'attribut a été créée avec succès." }, "201-admin-create-region": { "content": { "application/json": { "example": { "region_id": 42 }, "schema": { "properties": { "region_id": { "$ref": "#/components/schemas/Regions_region_id" } }, "type": "object" } } }, "description": "La région a été créée avec succès." }, "204-admin-delete-region": { "content": {}, "description": "La région a été supprimée avec succès." }, "204-admin-update-attribute": { "content": {}, "description": "L'attribut a été mis à jour avec succès." }, "204-admin-update-region": { "content": {}, "description": "La région a été mise à jour avec succès." }, "401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "L'en-tête d'autorisation n'a pas été passé." }, "404-attribute-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 9901, "type": "integer" }, "errorMessage": { "example": "[0401-9901]: Attribute not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Attribut non trouvé." }, "404-attribute-value-not-found": { "content": { "application/json": { "examples": { "Attribue value not found": { "$ref": "#/components/examples/404-attribute-value-not-found" }, "Attribute not found": { "$ref": "#/components/examples/404-attribute-not-found" } }, "schema": { "$ref": "#/components/schemas/404-not-found" } } }, "description": "Valeur d'attribut non trouvée." }, "404-region-not-found": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 9701, "type": "integer" }, "errorMessage": { "example": "[0401-9701]: Region not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Région non trouvée. Assurez-vous que le paramètre `id` est correct." }, "422-create-update-attribute-value": { "content": { "application/json": { "examples": { "external_id is duplicate": { "$ref": "#/components/examples/422-external-id-duplicate" }, "external_id is invalid": { "$ref": "#/components/examples/422-external-id-invalid" }, "external_id is required": { "$ref": "#/components/examples/422-external-id-required" }, "value is required": { "$ref": "#/components/examples/422-value-invalid" }, "value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" }, "value properties minimum length": { "$ref": "#/components/examples/422-value-properties-required" } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "Demande non valide." }, "422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "Demande non valide." }, "Bundles_200-admin-get-bundle": { "content": { "application/json": { "example": { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" } } }, "description": "Le lot spécifié a été reçu avec succès." }, "Bundles_200-admin-get-bundle-list": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "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", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "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", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "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", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "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", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "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", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "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", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-03-01T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677639600, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "Informations sur les objets.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de lots a été reçue avec succès." }, "Bundles_200-admin-get-bundle-list-in-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "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", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "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", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "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", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "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", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "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", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "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", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "day_of_week": 2, "displayable_reset_next_date": "2023-03-07T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "weekly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "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", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "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", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "Informations sur les objets.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de lots a été reçue avec succès." }, "Bundles_200-get-bundle-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle-list" } }, "schema": { "description": "Informations sur les objets.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Bundles_client_bundle" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de lots a été reçue avec succès." }, "Bundles_201-admin-create-bundle": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.kg_1" } } }, "schema": { "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "type": "object" } } }, "description": "Le lot a été créé avec succès." }, "Bundles_204-admin-delete-bundle": { "content": {}, "description": "Le lot a été supprimé avec succès." }, "Bundles_204-admin-hide-bundle": { "content": {}, "description": "Le lot a été masqué avec succès." }, "Bundles_204-admin-show-bundle": { "content": {}, "description": "Le lot a été affiché avec succès." }, "Bundles_204-admin-update-bundle": { "content": {}, "description": "Le lot a été mis à jour avec succès." }, "Bundles_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "Bundles_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "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" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Bundles_422-invalid-request" } } }, "description": "Demande non valide." }, "Cart-Free_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "ID de commande.", "type": "integer" } }, "type": "object" } } }, "description": "La commande gratuite a été créée avec succès." }, "Cart-Payment_200-admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "The cup of tea", "groups": [ { "external_id": "cups", "name": "Cups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 2, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "White T-shirt", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "3.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.t-shirt01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [ { "external_id": "clothes", "name": "Clothes" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": true, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cat's cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": null, "promotions": [], "quantity": 1, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found", "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "properties": { "cart_id": { "description": "ID de panier. Passez-le à la requête pour la page d'achat ou aux endpoints de l'API de paiement.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "Prix du panier.", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." }, "Cart-Payment_200-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "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_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "com.xsolla.booster_mega_21" } ] } } }, "schema": { "properties": { "cart_id": { "description": "ID de panier.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "Type d'objet.", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "Prix du panier.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." }, "Cart-Payment_200-get-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "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_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ] } } }, "schema": { "properties": { "cart_id": { "description": "ID de panier.", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "Type d'objet.", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "Prix du panier.", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" } }, "type": "object" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." }, "Cart-Payment_200-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "content": { "is_free": false, "items": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } }, "order_id": 1, "status": "paid" } } }, "schema": { "properties": { "content": { "description": "Détails de la commande.", "properties": { "is_free": { "description": "Si ce paramètre est défini sur `true`, la commande est gratuite.", "example": false, "type": "boolean" }, "items": { "description": "Liste des objets.", "example": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "items": { "properties": { "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "30", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "Quantité de l'objet.", "example": 1, "type": "integer" }, "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.", "example": "some_sku", "type": "string" } }, "type": "object" }, "type": "array" }, "price": { "description": "Prix de la commande.", "properties": { "amount": { "description": "Prix de la commande réduit.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de la commande.", "example": "30", "type": "string" }, "currency": { "description": "Devise du prix de la commande. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "virtual_price": { "description": "Prix de la commande en monnaie virtuelle.", "properties": { "amount": { "description": "Prix de la commande réduit.", "example": "100", "type": "string" }, "amount_without_discount": { "description": "Prix de la commande.", "example": "150", "type": "string" }, "currency": { "description": "UGS de la monnaie virtuelle utilisée dans la commande.", "example": "test_vc", "type": "string" } }, "type": "object" } }, "type": "object" }, "order_id": { "default": "Order ID.", "description": "ID de commande.", "example": 1, "type": "integer" }, "status": { "description": "Statut de la commande : `new`/`paid`/`done`/`canceled`.", "example": "paid", "type": "string" } }, "type": "object" } } }, "description": "Requête de commande acceptée." }, "Cart-Payment_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } }, "schema": { "properties": { "order_id": { "description": "ID de commande.", "type": "integer" }, "token": { "description": "Jeton de paiement.", "type": "string" } }, "type": "object" } } }, "description": "La commande a été créée avec succès." }, "Cart-Payment_201-admin-create-payment-token": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" } } }, "schema": { "properties": { "order_id": { "description": "ID de commande.", "example": 1, "type": "integer" }, "token": { "description": "Jeton de paiement.", "type": "string" } }, "type": "object" } } }, "description": "La commande et le jeton de paiement ont été créés avec succès." }, "Cart-Payment_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "Cart-Payment_404-create-order-with-item-not-found-errors": { "content": { "application/json": { "examples": { "coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" }, "item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet ou coupon introuvable. Assurez-vous que les données utilisées sont correctes." }, "Cart-Payment_404-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9001, "type": "integer" }, "errorMessage": { "example": "[0401-9001]: Order not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Commande non trouvée. Assurez-vous que les paramètres `project_id` et `order_id` sont corrects." }, "Cart-Payment_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." }, "Cart-Payment_404-user": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 5008, "type": "integer" }, "errorMessage": { "example": "[0401-5008]: Could not find User", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "L'utilisateur n'a pas été trouvé. Assurez-vous que le jeton `x-user-for` ou `x-user-id` est correct." }, "Cart-Payment_422-admin-create-payment-token": { "content": { "application/json": { "examples": { "Empty cart": { "value": { "errorCode": 1417, "errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid cart": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Item is free": { "value": { "errorCode": 1421, "errorMessage": "[0401-1421]: Item is free", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "User country not provided": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request-2" } } }, "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." }, "Cart-Payment_422-can-put-only-virtual-good-to-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1421, "errorMessage": "Only Virtual Good Supported", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1421, "type": "integer" }, "errorMessage": { "example": "This type of item cannot be put to the cart. Select another type of item.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "Ce type d'objet ne peut pas être mis dans le panier. Sélectionnez un autre type d'objet." }, "Cart-Payment_422-create-order-with-item-invalid": { "content": { "application/json": { "examples": { "code expired": { "value": { "errorCode": 9810, "errorMessage": "[0401-9810]: Sorry, this code is expired.", "statusCode": 422 } }, "code redemption limit": { "value": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 } }, "invalid item": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } }, "regionally restricted": { "value": { "errorCode": 9808, "errorMessage": "[0401-9808]: Coupon is not available in your region.", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "Erreur non valide." }, "Cart-Payment_422-invalid-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1401, "type": "integer" }, "errorMessage": { "example": "[0401-1401]: Invalid cart", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "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." }, "Cart-Payment_422-invalid-item": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "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." }, "Cart-Payment_422-non-negative-quantity": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "Item quantity must be non-negative integer.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "La quantité de l'objet doit être un nombre entier non négatif." }, "Common_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "Game-Keys_200-admin-get-game-by-sku": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] } } }, "schema": { "description": "Informations sur le jeu.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "Type de média : `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "Fichier de ressources.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "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.", "example": "game_1", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `unit`.", "example": "unit", "type": "string" }, "unit_items": { "description": "Clés de jeu pour différents DRM.", "items": { "description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).", "properties": { "drm_id": { "description": "Internal ID unique du DRM.", "example": 1, "type": "integer" }, "drm_image": { "description": "Icône du DRM de la clé de jeu.", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "Nom du DRM de la clé de jeu.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID unique du DRM.", "example": "steam", "type": "string" }, "is_enabled": { "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.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "Si `true`, la clé de jeu a été achetée par les utilisateurs.", "type": "boolean" }, "is_show_in_store": { "description": "L'objet est disponible à l'achat.", "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "Nombre de clés disponibles à l'achat.", "type": "integer" }, "total": { "description": "Nombre total de clés téléchargées.", "type": "integer" }, "used": { "description": "Nombre de clés vendues.", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "Paramètres de pré-commande.", "properties": { "description": { "description": "Informations supplémentaires pour la pré-commande, qui sera envoyée par e-mail.", "type": [ "string", "null" ] }, "is_enabled": { "description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande.", "type": "boolean" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "Prix en devises réelles.", "example": [ { "amount": 1299.99, "country_is": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "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": "US", "type": [ "string", "null" ] }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "RUB", "type": "string" }, "is_default": { "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.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "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.", "example": "game_1", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "Objet contenant des versions localisées de la description du jeu. Les clés sont spécifiées selon la norme ISO 3166-1.", "example": { "en": "Game 1 Example" }, "type": "object" }, "image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "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.", "example": { "en": "Gold" }, "type": "object" }, "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.", "example": "gold", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `virtual_currency`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Le jeu a été reçu avec succès." }, "Game-Keys_200-admin-get-games-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [], "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "groups": [], "is_enabled": true, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "name": { "en": "Game 1 Key 2" }, "order": 1, "periods": [], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] }, { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 2" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 2, "long_description": { "en": "Example game's long description" }, "media_list": [], "name": { "en": "Game 2" }, "order": 1, "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": false, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 5, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [], "sku": "com.xsolla.game_2_key_2", "type": "game_key", "virtual_prices": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ] } ] } ] } } }, "schema": { "description": "Objet contenant des jeux.", "properties": { "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "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.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "L'objet est disponible à l'achat.", "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "Ressources supplémentaires du jeu, telles que des captures d'écran, des vidéos de gameplay, etc.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "Type de média : `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "Fichier de ressources.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "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.", "example": "game_1", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `unit`.", "example": "unit", "type": "string" }, "unit_items": { "description": "Clés de jeu pour différents DRM.", "items": { "description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (steam, gog, etc.).", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_id": { "description": "Internal ID unique du DRM.", "example": 1, "type": "integer" }, "drm_image": { "description": "Icône du DRM de la clé de jeu.", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "Nom du DRM de la clé de jeu.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID unique du DRM.", "example": "steam", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "is_enabled": { "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.", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "Si `true`, la clé de jeu a été achetée par les utilisateurs.", "type": "boolean" }, "is_show_in_store": { "description": "L'objet est disponible à l'achat.", "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "Nombre de clés disponibles à l'achat.", "type": "integer" }, "total": { "description": "Nombre total de clés téléchargées.", "type": "integer" }, "used": { "description": "Nombre de clés vendues.", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "Ordre de priorité des jeux dans la liste.", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "Paramètres de pré-commande.", "properties": { "description": { "description": "Informations supplémentaires pour la pré-commande, qui sera envoyée par e-mail.", "type": [ "string", "null" ] }, "is_enabled": { "description": "Si ce paramètre est désactivé, l'objet n'est pas une pré-commande.", "type": "boolean" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "Prix en devises réelles.", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "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": "US", "type": [ "string", "null" ] }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "RUB", "type": "string" }, "is_default": { "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.", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "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.", "example": "game_1", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "Objet contenant des versions localisées de la description du jeu. Les clés sont spécifiées selon la norme ISO 3166-1.", "example": { "en": "Game 1 Example" }, "type": [ "object", "null" ] }, "image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "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.", "example": { "en": "Gold" }, "type": "object" }, "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.", "example": "gold", "type": "string" }, "type": { "description": "Type d'objet. Dans ce cas, il s'agit toujours de `virtual_currency`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de jeux a été reçue avec succès." }, "Game-Keys_200-get-codes": { "content": { "text/plain": { "examples": { "response": { "value": "PIN-CODE-ALL PIN-CODE-ALL-3" } }, "schema": { "example": "PIN-CODE-ALL PIN-CODE-ALL-3", "type": "string" } } }, "description": "Les codes ont été reçus avec succès." }, "Game-Keys_200-get-drm-list": { "content": { "application/json": { "examples": { "response": { "value": { "drm": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ] } } }, "schema": { "description": "Objet contenant des jeux.", "properties": { "drm": { "example": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ], "items": { "properties": { "drm_id": { "description": "ID du DRM.", "example": 1, "type": "number" }, "image": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "Lien d'échange.", "example": "https://support.us.playstation.com", "type": [ "string", "null" ] }, "name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "Lien d'instructions d'échange.", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "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.", "example": "steam", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des DRM a été reçue avec succès." }, "Game-Keys_200-get-game-keys-by-group-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ] } } }, "schema": { "description": "Objet contenant des jeux.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "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.", "example": "steam", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "2.9900", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "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.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des clés de jeu a été reçue avec succès." }, "Game-Keys_200-get-games-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } ] } } }, "schema": { "description": "Objet contenant des jeux.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "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.", "example": "steam", "type": "string" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "2.9900", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "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.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "Type d'unité : `game`.", "example": "game", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de jeux a été reçue avec succès." }, "Game-Keys_200-session-information": { "content": { "application/json": { "examples": { "response": { "value": { "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" } } }, "schema": { "properties": { "count_skipped": { "example": 10, "type": "integer" }, "count_total": { "example": 100, "type": "integer" }, "count_uploaded": { "example": 0, "type": "integer" }, "session_id": { "example": "fc7105b6e8ee01339582970b37697242", "type": "string" }, "status": { "example": "processing", "type": "string" } }, "type": "object" } } }, "description": "Les informations sur la session de chargement des codes ont été reçues avec succès." }, "Game-Keys_200-user-entitlement-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "description": "Description of the greatest game in the world.", "drm": "drmfree", "game_sku": "com.xsolla.key_1", "image_url": "https://none", "is_pre_order": false, "name": "The Greatest Game in the World", "project_id": 30810 } ], "total_items_count": 1 } } }, "schema": { "description": "Informations sur le jeu.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Game-Keys_entitlement_item" }, "type": "array" }, "total_items_count": { "$ref": "#/components/schemas/Pagination_total-items-count" } }, "type": "object" } } }, "description": "Une liste de clés de jeu en possession de l'utilisateur a été reçue avec succès." }, "Game-Keys_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "Game-Keys_403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "L'en-tête d'autorisation n'a pas été passé." }, "Game-Keys_422-invalid-request": { "content": { "application/json": { "examples": { "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" }, "The property `drm_sku` is required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required", "statusCode": 422 } }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Game-Keys_422-invalid-request" } } }, "description": "Demande non valide." }, "ItemGroup_200-admin-get-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group" } }, "schema": { "$ref": "#/components/schemas/admin-group-response-base" } } }, "description": "Item group was successfully retrieved." }, "ItemGroup_200-admin-get-group-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-by-item-type" } }, "schema": { "$ref": "#/components/schemas/admin-group-detail-response-by-item-type" } } }, "description": "Item group was successfully retrieved, with `items_count` filtered by the specified item type." }, "ItemGroup_200-admin-get-group-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-base" }, "type": "array" } }, "type": "object" } } }, "description": "Item groups list was successfully retrieved." }, "ItemGroup_200-admin-get-group-list-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list-by-item-type" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-by-item-type" }, "type": "array" } }, "type": "object" } } }, "description": "Item group list was successfully retrieved. `items_count` field includes only items of the specified type." }, "ItemGroup_201-admin-create-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/201-admin-create-group" } }, "schema": { "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" } }, "type": "object" } } }, "description": "Item group was successfully created." }, "ItemGroup_204-admin-delete-group": { "description": "Item group was successfully deleted." }, "ItemGroup_204-admin-reorder-groups": { "description": "Item groups were successfully reordered." }, "ItemGroup_204-admin-reorder-items": { "description": "Items within the group were successfully reordered." }, "ItemGroup_204-admin-update-group": { "description": "Item group was successfully updated." }, "ItemGroup_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/error-response-base" } } }, "description": "Basic authentication failed or invalid credentials were provided. Ensure that you use basic authentication and correct credentials." }, "ItemGroup_404-group-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Items or group not found (reorder endpoints)": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-groups-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `id` or `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-items-by-external-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `external_id` doesn't exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_404-reorder-items-by-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `id` does not exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_422-create-update": { "content": { "application/json": { "examples": { "Group already exists": { "value": { "errorCode": 4401, "errorMessage": "[0401-4401]: Item group already exists", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group cannot be its own parent": { "value": { "errorCode": 4404, "errorMessage": "[0401-4404]: Group can't be self parent", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Reserved external_id value": { "value": { "errorCode": 4516, "errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "The property `external_id` is required": { "$ref": "#/components/examples/422-property-external-id-required" } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Returned for validation errors or if the data violates system rules." }, "ItemGroup_422-delete": { "content": { "application/json": { "examples": { "Cannot delete group with items": { "value": { "errorCode": 4402, "errorMessage": "[0401-4402]: Item group with items cannot be deleted.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Cannot delete a group that contains items." }, "ItemGroup_422-ordering": { "content": { "application/json": { "examples": { "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Object value found, but an array is required", "property": "" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Request body failed validation." }, "Virtual-Items-Currency_200-admin-get-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "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" }, "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } }, { "external_id": "weapon", "name": { "en": "weapon" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "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" }, "media_list": [], "name": { "en": "Sword Xsolla Skin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } }, "description": "L'objet virtuel spécifié a été reçu avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-currencies": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, { "attributes": [], "description": { "en": "Money for in-store purchases" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Gold", "ru": "Gold" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de monnaies virtuelles a été reçue avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" } } }, "description": "La monnaie virtuelle spécifiée a été reçue avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-currency-package": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" } } }, "description": "Le package de monnaie virtuelle spécifié a été reçu avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-currency-packages": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 1500, "sku": "com.xsolla.crystal_3", "type": "virtual_currency" } ], "description": { "en": "Crystals x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Massive crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_3", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 100, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": { "en": "Gold x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 500, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": { "en": "Gold x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 1500, "sku": "com.xsolla.gold_3", "type": "virtual_currency" } ], "description": { "en": "Gold x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Large gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_3", "type": "bundle", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de packages de monnaie virtuelle a été reçue avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-items": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Suit up with flair showcasing your allegiance to Xsolla" }, "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" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle." }, "media_list": [], "name": { "en": "Maximum Armor Xsolla Skin" }, "order": 1, "periods": [], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "A strong armor forged to withstand heavy attacks." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_large_3", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "La liste d'objets virtuels a été reçue avec succès." }, "Virtual-Items-Currency_200-admin-get-virtual-items-by-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "A strong armor forged to withstand heavy attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "day_of_month": 28, "day_of_week": null, "displayable_reset_next_date": "2023-03-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "monthly", "reset_next_date": 1679972400, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_lrg_2", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "La liste d'objets virtuels a été reçue avec succès." }, "Virtual-Items-Currency_200-get-all-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "Accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ] } } }, "schema": { "description": "Informations sur les objets virtuels.", "properties": { "items": { "example": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ], "items": { "properties": { "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "properties": { "external_id": { "example": "weapons", "type": "string" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" } }, "type": "array" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "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.", "example": "com.xsolla.big_rocket_1", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste de tous les objets virtuels a été reçue avec succès." }, "Virtual-Items-Currency_200-get-item-by-sku": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": "VALUE" }, { "external_id": "val2", "value": "VALUE2" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "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" }, "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_free": false, "item_id": 488833, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1761840000 }, "total": 3 } }, "name": { "en": "Sword Xsolla Skin" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [], "vp_rewards": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" } } }, "description": "L'objet virtuel a été reçu avec succès." }, "Virtual-Items-Currency_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_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" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "can_be_bought": true, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_item": null, "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ] }, { "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" ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "weapons" } } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "Type d'objet : `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste d'objets du groupe spécifié a été reçue avec succès." }, "Virtual-Items-Currency_200-get-items-groups": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": "https://example.com/groups/weapons.png", "name": "Weapons", "order": 1 }, { "description": "Protective equipment", "external_id": "armor", "image_url": "https://example.com/groups/armor.png", "name": "Armor", "order": 2 }, { "description": "Potions, food, and other single-use items", "external_id": "consumables", "image_url": null, "name": "Consumables", "order": 3 } ] } } }, "schema": { "properties": { "groups": { "example": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": null, "name": "Weapons", "order": 1 }, { "description": "Super description", "external_id": "group_external_id", "image_url": null, "name": "Super", "order": 1 } ], "items": { "properties": { "children": { "description": "Groupes enfant.", "example": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "image_url": null, "level": 1, "name": "Background", "order": 1, "parent_external_id": "weapons" } ], "items": { "properties": { "children": { "description": "Groupes enfant.", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "properties": { "children": { "description": "Groupes enfant.", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "Accessory", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "accessory", "type": "string" }, "image_url": { "description": "URL de l'image.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 2, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Accessory", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "example": "background", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "Background description", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "background", "type": "string" }, "image_url": { "description": "URL de l'image du groupe.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 1, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Background", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "example": "weapons", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "All weapons available in the game", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "weapons", "type": "string" }, "image_url": { "description": "URL de l'image.", "example": null, "type": [ "string", "null" ] }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 0, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Weapons", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "example": null, "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des groupes a été reçue avec succès." }, "Virtual-Items-Currency_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Big Rocket - description" }, "groups": [ { "external_id": "accessory", "item_order_in_group": 1, "name": "accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": { "en": "Big Rocket" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" }, { "quantity": 1, "sku": "com.xsolla.phys_good_1", "type": "physical_good" }, { "bundle_type": "standard", "image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png", "name": "Super Lootbox with items", "quantity": 1, "sku": "com.xsolla.SuperLootboxBundle_1", "type": "bundle" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": null, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "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" } ] } ], "can_be_bought": true, "description": { "en": "description" }, "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "Weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": { "en": "description" }, "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item-list" } } }, "description": "La liste d'objets virtuels a été reçue avec succès." }, "Virtual-Items-Currency_200-get-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystals - short description", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_free": false, "item_id": 451414, "limits": null, "name": "Crystals", "periods": [ { "date_from": "2023-08-11T10:00:00+03:00", "date_until": "2023-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "virtual_prices": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" } } }, "description": "La monnaie virtuelle a été reçue avec succès." }, "Virtual-Items-Currency_200-get-virtual-currency-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - short description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": null, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "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" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "description", "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_3", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list" } } }, "description": "La liste de monnaies virtuelles a été reçue avec succès." }, "Virtual-Items-Currency_200-get-virtual-currency-package": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Crystal - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "item_id": 488831, "limits": null, "name": "Crystals", "quantity": 10, "sku": "com.xsolla.crystals_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystal Pack Short Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "item_id": 488832, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1690732800 }, "total": 1 } }, "name": "Crystal Pack", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" } } }, "description": "Le package de monnaie virtuelle a été reçu avec succès." }, "Virtual-Items-Currency_200-get-virtual-currency-packages-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Big Rocket", "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 1, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name first package", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "description", "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 2, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name third package", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_3", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages" } } }, "description": "La liste de packages de monnaie virtuelle a été reçue avec succès." }, "Virtual-Items-Currency_200-quick-purchase": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "ID de commande.", "type": "integer" } }, "type": "object" } } }, "description": "Achat rapide virtuel réussi." }, "Virtual-Items-Currency_201-created": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.item_1" } } }, "schema": { "example": { "sku": "com.xsolla.item_1" }, "properties": { "sku": { "example": "new-sku", "type": "string" } }, "type": "object" } } }, "description": "L'objet virtuel a été créé avec succès." }, "Virtual-Items-Currency_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401 } } }, "schema": { "properties": { "errorCode": { "example": 1020, "type": "integer" }, "errorMessage": { "example": "[0401-1020]: Error in Authentication method occurred", "type": "string" }, "statusCode": { "example": 401, "type": "integer" } }, "type": "object" } } }, "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." }, "Virtual-Items-Currency_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." }, "Virtual-Items-Currency_404-item-group": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4403, "type": "integer" }, "errorMessage": { "example": "[0401-4403]: Item group not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "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é." }, "Virtual-Items-Currency_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "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" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request" } } }, "description": "Demande non valide." }, "Virtual-Items-Currency_422-not-enough-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 5006, "errorMessage": "[0401-5006]: Not enough virtual currency", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 5006, "type": "integer" }, "errorMessage": { "example": "[0401-5006]: Not enough virtual currency", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "Monnaie virtuelle insuffisante." }, "connector-422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1803, "errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 1803, "type": "integer" }, "errorMessage": { "example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Erreur de validation basée sur le corps de la requête, les propriétés du fichier ou le contenu du fichier." }, "sellable-item-by-id_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 259774 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_id` sont corrects." }, "sellable-item-by-sku_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'electric_shiel' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `sku` sont corrects." }, "sellable_items_200-get-item-by-id": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 10, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } } }, "schema": { "description": "Informations sur l'objet vendable.", "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "Si `true`, l'utilisateur peut acheter l'objet.", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Electric shield", "type": "string" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "9.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "electric_shield", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "Description de la monnaie virtuelle.", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Gold", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "gold", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" } } }, "description": "L'objet vendable a été reçu avec succès." }, "sellable_items_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shields_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "clan_value_point_sku_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "Si `true`, l'utilisateur peut acheter l'objet.", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Electric shield", "type": [ "string", "null" ] }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Electric shield", "type": "string" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "9.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "com.xsolla.electric_shield_1", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "Description de la monnaie virtuelle.", "example": null, "type": [ "string", "null" ] }, "image_url": { "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Gold", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des objets vendables du groupe spécifié a été reçue avec succès." }, "sellable_items_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": null, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_2", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "item_order_in_group": 1, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "item_order_in_group": 2, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "item_order_in_group": 1, "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.royal_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_13", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "description": "Informations sur les objets vendables.", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "limits": null, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "limits": null, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "limits": null, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_1", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "limits": null, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "limits": null, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "limits": null, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "limits": null, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "limits": null, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_14", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "Type de lot. Renvoyé si le type d'objet est un lot.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "can_be_bought": { "description": "Si `true`, l'utilisateur peut acheter l'objet.", "example": true, "type": "boolean" }, "content": { "items": { "items": { "$ref": "#/components/schemas/Bundles_client_content" }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Electric shield", "type": "string" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "9.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "com.xsolla.electric_shield_1", "type": "string" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "Description de la monnaie virtuelle.", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "item_id": { "description": "Internal ID unique de l'objet, fourni lors de la création de l'objet.", "example": 259774, "type": "integer" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Gold", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La liste des objets vendables a été reçue avec succès." } }, "schemas": { "404-not-found": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0000-0000]: Entity not found", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "422-invalid-request": { "properties": { "errorCode": { "description": "Code d'erreur.", "example": 1102, "type": "integer" }, "errorMessage": { "description": "Short error description.", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "$ref": "#/components/schemas/error-message-extended-validation" }, "statusCode": { "description": "HTTP response status.", "example": 422, "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "required": [ "statusCode", "errorCode", "errorMessage", "transactionId" ], "type": "object" }, "422-invalid-request-2": { "properties": { "errorCode": { "description": "Code d'erreur.", "example": 1102, "type": "number" }, "errorMessage": { "description": "Message d'erreur lisible.", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "description": "Code d'état de la réponse.", "example": 422, "type": "number" }, "transactionId": { "description": "ID unique de la demande.", "example": "da145238620011eb8e24fe6913ff226a", "type": "string" } }, "type": "object" }, "Bundles_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Bundles_admin-attributes": { "description": "Liste des attributs.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Bundles_admin-post-put-attributes": { "description": "Liste des attributs.\n
Attention. 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" }, "maxItems": 20, "type": "array" }, "Bundles_admin-regions": { "items": { "properties": { "id": { "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Bundles_admin-response-virtual_price": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_default": { "$ref": "#/components/schemas/Bundles_currency-is_default" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_vc-type" } }, "type": "object" }, "Bundles_admin_bundle_request": { "description": "Le lot spécifié.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-post-put-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "content": { "$ref": "#/components/schemas/Bundles_admin_content_request" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_request" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/bundle-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "vc_prices": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_vc_prices" }, { "type": "null" } ] } }, "required": [ "sku", "name", "description" ], "type": "object" }, "Bundles_admin_bundle_response": { "description": "Le lot spécifié.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-attributes" }, "bundle_type": { "$ref": "#/components/schemas/bundle_type" }, "content": { "items": { "$ref": "#/components/schemas/Bundles_admin_content_response" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "items": { "$ref": "#/components/schemas/Bundles_admin-response-virtual_price" }, "type": "array" } }, "type": "object" }, "Bundles_admin_content_request": { "items": { "example": { "quantity": 1, "sku": "com.xsolla.kg_1" }, "properties": { "quantity": { "default": 1, "description": "Quantité des objets sélectionnés dans le lot.", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "required": [ "sku" ], "type": "object" }, "minItems": 1, "type": "array" }, "Bundles_admin_content_response": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "default": 1, "description": "Quantité du type d'objet dans le lot.", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_type" } }, "type": "object" }, "Bundles_amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_bundle_type": { "default": "standard", "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).", "enum": [ "standard", "partner_side_content" ], "example": "standard", "type": "string" }, "Bundles_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_bundle": { "description": "Le lot spécifié.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "$ref": "#/components/schemas/Bundles_client_content" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/Bundles_client_description" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Bundles_media_list" }, "name": { "$ref": "#/components/schemas/Bundles_client_name" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "$ref": "#/components/schemas/Bundles_price" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Bundles_client_content": { "description": "Contenu du lot.", "example": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "items": { "description": "Objet dans le package.", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "quantity": { "description": "Quantité de l'objet dans le package.", "example": 250, "type": "integer" }, "sku": { "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.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet en monnaie virtuelle avec remise.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_description": { "description": "Description de l'objet.", "example": "Big Rocket - description.", "type": [ "string", "null" ] }, "Bundles_client_name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "Bundles_currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" }, "Bundles_currency-is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "Bundles_groups_request": { "default": [], "description": "Groupes auxquels l'objet appartient.\n
Note. La valeur de la chaîne correspond à l'`external_id` du groupe.
", "example": [ "honor" ], "items": { "type": "string" }, "type": "array" }, "Bundles_groups_response": { "default": [], "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "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": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Bundles_image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": [ "string", "null" ] }, "Bundles_is_enabled": { "default": true, "description": "Si ce paramètre est désactivé, l'objet ne peut pas être trouvé ni acheté.", "example": true, "type": "boolean" }, "Bundles_is_show_in_store": { "default": false, "description": "L'objet est disponible à l'achat.", "example": true, "type": "boolean" }, "Bundles_item_id": { "description": "Internal ID unique de l'objet.", "example": 1, "maxLength": 255, "minLength": 1, "type": "integer" }, "Bundles_media_list": { "description": "Ressources supplémentaires du lot.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "Type de média : `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "Fichier de ressources.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Bundles_order": { "default": 1, "description": "Ordre de priorité des lots dans la liste.", "example": 1, "type": "integer" }, "Bundles_price": { "description": "Prix de l'objet.", "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "required": [ "amount", "amount_without_discount", "currency" ], "type": [ "object", "null" ] }, "Bundles_prices": { "description": "Prix en devises réelles.", "items": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "country_iso": { "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": "US", "type": [ "string", "null" ] }, "currency": { "$ref": "#/components/schemas/Bundles_currency" }, "is_default": { "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.", "type": "boolean" }, "is_enabled": { "description": "Le prix est activé.", "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_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.", "example": "bundle_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Bundles_total_content_price": { "description": "Somme des prix du contenu du lot.", "properties": { "amount": { "description": "Somme des prix du contenu du lot avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Somme des prix du contenu du lot.", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "type": [ "object", "null" ] }, "Bundles_type": { "description": "Type d'objet.", "example": "bundle", "type": "string" }, "Bundles_vc-type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" }, "Bundles_vc_prices": { "items": { "properties": { "amount": { "type": "integer" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "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.", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet en monnaie virtuelle avec remise.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet en monnaie virtuelle.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Most popular gold", "type": [ "string", "null" ] }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": [ "string", "null" ] }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Gold", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "gold", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "Can_be_bought": { "description": "Si `true`, l'utilisateur peut acheter l'objet.", "example": true, "type": "boolean" }, "Cart": { "additionalProperties": false, "properties": { "country": { "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", "maxLength": 2, "minLength": 2, "type": "string" }, "currency": { "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/).", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "items": { "items": { "properties": { "quantity": { "description": "Quantité de l'objet.", "example": 2, "minimum": 1, "type": "number" }, "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.", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Cart-Payment_admin-user-request-body": { "additionalProperties": false, "properties": { "age": { "description": "Âge de l'utilisateur.", "type": "integer" }, "country": { "properties": { "allow_modify": { "default": false, "description": "Indique si l'utilisateur peut changer de pays dans l'interface de paiement.", "example": false, "type": "boolean" }, "value": { "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", "type": "string" } }, "type": "object" }, "email": { "properties": { "value": { "description": "Adresse e-mail utilisateur. Doit être valide selon le protocole RFC 822.", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "type": "object" }, "id": { "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/).", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "is_legal": { "description": "Détermine si l'utilisateur est une personne morale.", "type": "boolean" }, "legal": { "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": { "address": { "description": "Adresse légale complète.", "type": "string" }, "country": { "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).", "type": "string" }, "name": { "description": "Nom légal complet.", "type": "string" }, "vat_id": { "description": "Numéro d'identification fiscal.", "type": "string" } }, "type": "object" }, "name": { "properties": { "value": { "description": "Pseudo de l'utilisateur.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "phone": { "properties": { "allow_modify": { "default": false, "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`.", "example": false, "type": "boolean" }, "hidden": { "default": true, "example": false, "type": "boolean" }, "value": { "description": "Numéro de téléphone de l'utilisateur.", "type": "string" } }, "required": [ "value" ], "type": "object" }, "steam_id": { "properties": { "value": { "description": "ID Steam.", "maxLength": 17, "minLength": 17, "pattern": "^\\d{17}$", "type": "string" } }, "required": [ "value" ], "type": "object" }, "tracking_id": { "properties": { "value": { "description": "ID unique de suivi (utilisé dans les campagnes de marketing).", "maxLength": 32, "minLength": 32, "pattern": "^[A-Za-z0-9]{32}$", "type": "string" } }, "required": [ "value" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "Cart-Payment_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Cart-Payment_custom_parameters": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "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/).", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_custom_parameters_token": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "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/).", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "number_param": 12.5, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_redirect_policy": { "properties": { "delay": { "description": "Délai après lequel l'utilisateur est automatiquement redirigé vers l'URL de retour.", "example": 0, "type": "integer" }, "redirect_button_caption": { "description": "Légendes localisées des boutons de redirection.", "example": "Text button", "type": "string" }, "redirect_conditions": { "description": "Statut du paiement déclenchant la redirection de l'utilisateur vers l'URL de retour.", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" }, "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.", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" } }, "type": "object" }, "Cart-Payment_settings_currency": { "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/).", "type": "string" }, "Cart-Payment_settings_external_id": { "description": "External ID de la transaction.", "maxLength": 255, "minLength": 1, "type": "string" }, "Cart-Payment_settings_locale": { "description": "Langue d'interface. [Code de langue](https://developers.xsolla.com/fr/doc/pay-station/features/localization/) à deux lettres minuscules.", "type": "string" }, "Cart-Payment_settings_payment_method": { "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, "type": "integer" }, "Cart-Payment_settings_return_url": { "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.", "format": "uri", "maxLength": 1000, "type": "string" }, "Cart-Payment_settings_sandbox": { "default": false, "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.", "type": "boolean" }, "Cart-Payment_settings_ui": { "additionalProperties": false, "description": "Paramètres d'interface.", "properties": { "currency_format": { "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.", "type": "string" }, "desktop": { "additionalProperties": false, "description": "Paramètres de l'interface pour la version de bureau.", "properties": { "header": { "additionalProperties": false, "description": "Paramètres de l'en-tête.", "properties": { "close_button": { "default": false, "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.", "type": "boolean" }, "is_visible": { "description": "Détermine l'affichage de l'en-tête dans l'interface de paiement.", "type": "boolean" }, "type": { "default": "normal", "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).", "enum": [ "compact", "normal" ], "type": "string" }, "visible_logo": { "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.", "type": "boolean" }, "visible_name": { "description": "Détermine l'affichage du nom du projet dans l'en-tête.", "type": "boolean" }, "visible_purchase": { "default": true, "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.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "header": { "properties": { "visible_virtual_currency_balance": { "additionalProperties": false, "default": true, "description": "Détermine l'affichage de cet élément dans l'interface de paiement.", "type": "boolean" } }, "type": "object" }, "is_cart_open_by_default": { "default": false, "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.", "type": "boolean" }, "is_independent_windows": { "default": false, "description": "Détermine la redirection des utilisateurs du navigateur du lanceur intégré (WebView) vers leur navigateur par défaut pour effectuer un achat.", "type": "boolean" }, "is_payment_methods_list_mode": { "default": false, "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.", "type": "boolean" }, "is_prevent_external_link_open": { "default": false, "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`.", "type": "boolean" }, "is_show_close_widget_warning": { "default": true, "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.", "type": "boolean" }, "is_three_ds_independent_windows": { "default": false, "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).", "type": "boolean" }, "layout": { "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" ], "type": "string" }, "mobile": { "properties": { "header": { "additionalProperties": false, "properties": { "close_button": { "default": false, "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`.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "mode": { "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.", "enum": [ "user_account" ], "type": "string" }, "theme": { "default": "63295a9a2e47fab76f7708e1", "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.", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ], "type": "string" }, "user_account": { "additionalProperties": false, "description": "Informations de compte utilisateur.", "properties": { "info": { "additionalProperties": false, "description": "Page **My account**.", "properties": { "enable": { "default": false, "description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`.", "type": "boolean" }, "order": { "description": "Position du sous-menu dans le menu.", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" }, "payment_accounts": { "additionalProperties": false, "description": "Le sous-menu **Mes comptes de paiement**.", "properties": { "enable": { "default": false, "description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`.", "type": "boolean" } }, "required": [ "enable" ], "type": "object" }, "subscriptions": { "additionalProperties": false, "description": "Sous-menu **Gestion des abonnements**.", "properties": { "enable": { "default": false, "description": "Détermine l'affichage du sous-menu. La valeur par défaut est `false`.", "type": "boolean" }, "order": { "description": "Position du sous-menu dans le menu.", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "Cart_admin_payment": { "additionalProperties": false, "properties": { "items": { "items": { "properties": { "quantity": { "description": "Quantité de l'objet.", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.\n
Attention

To sell one SKU multiple times, specify the required quantity in the purchase.items[].quantity parameter. Duplicate SKUs within the array are not supported — only the first occurrence is used when creating the token. No error is returned in this case.
", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Catalog_cart_promotions": { "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": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "Type de lot bonus. Disponible uniquement pour le type d'objet `bundle`.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "URL de l'image de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`.", "type": "string" }, "name": { "description": "Nom de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`.", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "Type d'objet bonus.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Catalog_item_limits": { "description": "Limites d'objets.", "properties": { "per_item": { "description": "Informations sur les limites pour un objet.", "properties": { "available": { "description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.", "example": 3, "type": "integer" }, "total": { "description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "Limites d'objets pour un utilisateur.", "properties": { "available": { "description": "Nombre d'objets restants que l'utilisateur actuel peut acheter.", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_limits_with_hourly": { "description": "Limites d'objets.", "properties": { "per_item": { "description": "Informations sur les limites pour un objet.", "properties": { "available": { "description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.", "example": 3, "type": "integer" }, "total": { "description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "Limites d'objets pour un utilisateur.", "properties": { "available": { "description": "Nombre d'objets restants que l'utilisateur actuel peut acheter.", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_promotions": { "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": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "Type de lot bonus. Disponible uniquement pour le type d'objet `bundle`.", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "URL de l'image de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`.", "type": "string" }, "name": { "description": "Nom de l'objet bonus. Non disponible pour le type d'objet bonus `physical_good`.", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "Type d'objet bonus.", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Common_admin-image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "Game-Keys_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Game-Keys_admin-attribute-external_id": { "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.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Game-Keys_admin-attributes": { "description": "Liste des attributs.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Game-Keys_admin-post-put-attributes": { "description": "Liste des attributs.\n
Attention. 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" }, "maxItems": 20, "type": "array" }, "Game-Keys_client-attributes": { "default": [], "description": "Liste des attributs et de leurs valeurs correspondantes pour le jeu.\n\n
Attention. 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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_client_name": { "description": "Nom du package de jeu.", "example": "The Greatest Game in the World", "type": "string" }, "Game-Keys_description": { "description": "Description du jeu.", "example": "Description of the greatest game in the world.", "type": "string" }, "Game-Keys_drm_sku": { "description": "ID unique du DRM.", "enum": [ "steam", "playstation", "xbox", "uplay", "origin", "drmfree", "gog", "epicgames", "nintendo_eshop", "discord_game_store", "oculus", "rockstar", "viveport", "stadia" ], "example": "steam", "type": "string" }, "Game-Keys_entitlement_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_client-attributes" }, "description": { "$ref": "#/components/schemas/Game-Keys_description" }, "drm": { "$ref": "#/components/schemas/Game-Keys_drm_sku" }, "game_sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" }, "image_url": { "$ref": "#/components/schemas/Game-Keys_image_url" }, "is_pre_order": { "description": "Détermine si le jeu est en pré-commande.", "example": false, "type": "boolean" }, "name": { "$ref": "#/components/schemas/Game-Keys_client_name" }, "project_id": { "$ref": "#/components/schemas/Game-Keys_project_id" } }, "type": "object" }, "Game-Keys_game_sku": { "description": "ID unique du package de clés.", "example": "theGreatestGameSku", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Game-Keys_image_url": { "description": "URL de l'image.", "example": "https://none", "type": "string" }, "Game-Keys_project_id": { "description": "ID de projet. Ce paramètre se trouve dans le [Compte éditeur](https://publisher.xsolla.com/) à côté du nom du projet.", "example": 44056, "type": "integer" }, "Game-Keys_regions": { "items": { "properties": { "id": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Game-Keys_schemas-client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_value-external_id": { "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.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Game-key-item-limit": { "description": "Limites d'objets.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/game_key_recurrent_schedule" } }, "type": "object" }, "Pagination_has-more": { "description": "Utilisé pour indiquer qu'il y a plus de pages.", "example": true, "type": "boolean" }, "Pagination_total-items-count": { "description": "Nombre total d'objets dans le système.", "example": 10, "type": "integer" }, "Promotions_coupon_code": { "default": "WINTER2021", "description": "Code unique sensible à la casse. Comprend des lettres et des chiffres.", "example": "WINTER2021", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "Regions_200-region-model": { "example": { "value": { "countries": [ "JP", "CN", "VN" ], "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_200-region-short-model": { "properties": { "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_countries": { "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" }, "type": "array" }, "Regions_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Asien", "en-US": "Asia" }, "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.", "example": { "de-DE": "Asien", "en-US": "Asia" }, "type": "object" }, "Regions_region_id": { "description": "ID de la région. Identifiant unique de la région au sein du projet.", "example": 42, "type": "integer" }, "User-limit-item": { "properties": { "per_user": { "properties": { "available": { "description": "Nombre restant d'objets qu'un utilisateur peut acheter.", "example": 9, "type": "integer" }, "total": { "description": "Nombre maximum d'objets qu'un utilisateur peut acheter.", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit_available": { "description": "Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée.", "minimum": 1, "type": "integer" }, "User-limit_available_flexible": { "description": "Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée.", "minimum": 0, "type": "integer" }, "User-limit_user": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "required": [ "user_external_id" ], "type": "object" }, "User-limit_user-external-id": { "description": "External ID de l'utilisateur", "minLength": 1, "pattern": "^\\S+$", "type": "string" }, "User-limit_user_flexible": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "type": [ "object", "null" ] }, "Virtual-Currency-Package-item-limit": { "description": "Limites d'objets.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule" } }, "type": "object" }, "Virtual-Currency-item-limit": { "description": "Limites d'objets.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_recurrent_schedule" } }, "type": "object" }, "Virtual-Item-item-limit": { "description": "Limites d'objets.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_item_recurrent_schedule" } }, "type": "object" }, "Virtual-Items-Currency_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Virtual-Items-Currency_admin-attributes": { "allOf": [ { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes" }, { "description": "Liste des attributs." } ] }, "Virtual-Items-Currency_admin-create-vc_prices": { "description": "Array of virtual currency prices.", "items": { "example": { "amount": 10, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "Prix de l'objet en monnaie virtuelle.", "type": "integer" }, "is_default": { "default": false, "description": "Whether it is the default price in virtual currency.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used.", "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "amount", "sku", "is_default", "is_enabled" ], "type": "object" }, "type": [ "array", "null" ] }, "Virtual-Items-Currency_admin-create-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "anyOf": [ { "required": [ "prices" ] }, { "required": [ "vc_prices" ] } ], "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "content": { "description": "Le package de monnaie virtuelle ne doit contenir qu'une seule position de monnaie virtuelle.", "items": { "properties": { "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" } }, "type": "object" }, "maxLength": 1, "minLength": 1, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-Package-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name", "description", "content" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Item-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-get-vc_prices": { "items": { "example": { "amount": 10, "is_default": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "Montant.", "exclusiveMinimum": 0, "type": "number" }, "is_default": { "default": false, "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "sku", "amount" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-create": { "description": "List of [group external IDs](/fr/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) the item belongs to.\n\nExample: [\"horror\", \"action\"]", "items": { "properties": { "external_id": { "example": "accessory", "type": "string" }, "name": { "example": "Accessory", "type": "string" } }, "type": "string" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-response": { "default": [], "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "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": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-image_url": { "description": "URL de l'image.", "type": "string" }, "Virtual-Items-Currency_admin-media_list": { "description": "Ressources supplémentaires de l'objet, telles que des captures d'écran, des vidéos de gameplay, etc.", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "Type de média : `image`/`video`.", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "Fichier de ressources.", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-post-put-attributes": { "description": "Liste des attributs.\n
Attention. 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" }, "maxItems": 20, "type": "array" }, "Virtual-Items-Currency_admin-prices": { "items": { "example": { "amount": 10.5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "Item price in real currency.", "example": 10.5, "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "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": "US", "type": [ "string", "null" ] }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" }, "is_default": { "default": false, "description": "Whether it is the default price in real currency. Refer to our [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used and another price is applied. Refer to our [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "example": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-regions": { "description": "Array of regions where the item is available. If the array is empty or not passed, the item is available in all regions.", "items": { "properties": { "id": { "description": "Region ID within the project.\n\nRefer to the [regional sale restriction documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/regional-restrictions/) and [region management API calls](https://developers.xsolla.com/fr/api/catalog/common-regions) for detailed information.", "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "bundle_type": { "default": "virtual_currency_package", "example": "virtual_currency_package", "type": "string" }, "content": { "items": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "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" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_client-attributes": { "default": [], "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" } ] } }, "items": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "Nom de l'attribut.", "example": "Genre", "type": "object" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_is_enabled": { "default": true, "description": "Whether the item is available. If `false`, the item can't be purchased in the store or obtained as part of a bundle or within a marketing campaign. Refer to our [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_is_show_in_store": { "default": false, "description": "Whether the item is displayed in the catalog. If `false` and `is_enabled: true`, the item is not visible in the catalog but can be obtained as part of a bundle or within marketing campaigns. Refer to our [documentation](https://developers.xsolla.com/fr/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "object" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "ID de l'objet", "type": "number" }, "limits": { "$ref": "#/components/schemas/client-item-limit-response" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "Nom de l'objet.", "example": "Big Rocket", "type": "object" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Virtual-Items-Currency_item-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_order": { "default": 1, "description": "Item display order in the catalog. The higher the value, the lower the item appears in the list.\nIf the values are the same, items are sorted by creation date, with newer items displayed higher.", "example": 1, "type": "integer" }, "Virtual-Items-Currency_schemas-admin-attributes": { "description": "Liste des attributs.", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Virtual-Items-Currency_schemas-admin-image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "type": "string" }, "Virtual-Items-Currency_schemas-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.", "example": "bundle_1", "type": "string" }, "Virtual-Items-Currency_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.", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Virtual-Items-Currency_type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "type": "string" }, "Virtual-Items-Currency_virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Crystals - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "com.xsolla.crystals_1" } ], "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Crystals - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Crystals", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "Type de lot : `standard`/`virtual_currency_package`.", "example": "virtual_currency_package", "type": "string" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "description": "Contenu du package de monnaie virtuelle.", "example": [ { "description": "Crystal Pack - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Crystal Pack", "quantity": 100, "sku": "com.xsolla.crystal_pack_1", "type": "virtual_currency" } ], "items": { "description": "Monnaie virtuelle dans le package.", "properties": { "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "Quantité de la monnaie virtuelle dans le package.", "example": 250, "type": "integer" }, "sku": { "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.", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "Description de l'objet.", "example": "Crystal Pack Description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Crystal Pack", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "crystal-pack", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-packages": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" }, "type": "array" } }, "type": "object" }, "Virtual-Items_admin-prices": { "items": { "example": { "amount": 10.5, "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "Montant.", "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "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", "type": "string" }, "currency": { "description": "Devise du prix de l'article. 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/).", "example": "USD", "type": "string" }, "is_default": { "default": false, "type": "boolean" }, "is_enabled": { "default": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "admin-attribute-external_id": { "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.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "admin-attribute-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Genre", "en": "Genre" }, "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.", "example": { "de": "Genre", "en": "Genre" }, "type": "object" }, "admin-group-create-request": { "description": "Item group data.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External ID of the item group. Can contain only alphanumeric characters, hyphens, and underscores.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ], "default": true }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-group-detail-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-response-base": { "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" }, "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "type": "integer" }, "image_url": { "$ref": "#/components/schemas/group-image-url" }, "is_enabled": { "$ref": "#/components/schemas/group-is-enabled" }, "items_count": { "description": "Total number of items in the group.", "example": 5, "type": "integer" }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "$ref": "#/components/schemas/group-display-order" } }, "required": [ "id", "external_id", "name", "is_enabled" ], "type": "object" }, "admin-group-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-update-request": { "description": "Item group data to update. The `external_id` and `name` fields are required in every request. Other fields are optional — omitted fields will retain their current values.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "Unique group external ID. Can contain only alphanumeric characters, hyphens, and underscores. Can be used to rename the group's external ID.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ] }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-item-limit-response": { "description": "Limites d'objets.", "properties": { "per_item": { "description": "Limites globales d'objets.", "properties": { "available": { "description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.", "type": "integer" }, "reserved": { "type": "integer" }, "sold": { "type": "integer" }, "total": { "description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "Limites d'objets pour un utilisateur spécifique.", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "type": "integer" } }, "type": [ "object", "null" ] }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule_response" } }, "type": [ "object", "null" ] }, "admin-post-put-attribute-item": { "maxItems": 6, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "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.
", "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "admin_attribute_response": { "example": { "value": [ { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "type": "object" }, "admin_recurrent_schedule_response": { "description": "Délai d'actualisation des limites.", "properties": { "per_user": { "description": "Délai d'actualisation des limites pour un utilisateur.", "oneOf": [ { "description": "Type quotidien d'actualisation des limites pour l'utilisateur.", "properties": { "displayable_reset_next_date": { "description": "Date et heure de réinitialisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "Date et heure de la première actualisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "Date et heure d'actualisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = daily", "type": "object" }, { "description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.", "properties": { "day_of_week": { "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`.", "maximum": 7, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "Date et heure de réinitialisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "Date et heure de la première actualisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure d'actualisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "Type mensuel d'actualisation des limites pour l'utilisateur.", "properties": { "day_of_month": { "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`.", "maximum": 31, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "Date et heure de réinitialisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "Date et heure de la première actualisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure d'actualisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "Réinitialisation des limites de l'utilisateur effectuée selon l'intervalle de temps spécifié, en heures.", "properties": { "displayable_reset_next_date": { "description": "Date et heure de réinitialisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "Date et heure de la première actualisation des limites (ISO 8601).", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "hours_interval": { "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\"`.", "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure d'actualisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" } }, "title": "interval_type = horaire", "type": "object" } ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "attribute": { "example": { "external_id": "attribute_external_id", "name": { "de": "Attributname", "en": "Attribute name" }, "values": [ { "external_id": "value_1", "name": { "de": "wert 1", "en": "value 1" } }, { "external_id": "value_2", "name": { "de": "wert 2", "en": "value 2" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "attribute-value": { "example": { "external_id": "value_external_id", "name": { "de": "Wert 1", "en": "Value 1" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "value", "external_id" ], "type": "object" }, "bundle-item-limit": { "description": "Limites d'objets.", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/bundle_recurrent_schedule" } }, "type": "object" }, "bundle_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "bundle_type": { "description": "Type de lot. Renvoyé si le type d'objet est un lot.", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ], "type": "string" }, "catalog_recurrent_schedule_client_response": { "description": "Délai d'actualisation récurrent des limites d'un objet pour un utilisateur.", "oneOf": [ { "description": "Type quotidien d'actualisation des limites pour l'utilisateur.", "properties": { "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "Date et heure de la réinitialisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" } }, "title": "interval_type = daily", "type": "object" }, { "description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.", "properties": { "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure de la réinitialisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "Type mensuel d'actualisation des limites pour l'utilisateur.", "properties": { "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure de la réinitialisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "Réinitialisation des limites de l'utilisateur effectuée selon l'intervalle de temps spécifié, en heures.", "properties": { "interval_type": { "description": "Type de délai d'actualisation récurrent.", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "Date et heure de la réinitialisation des limites (horodatage Unix).", "example": 1677553200, "type": "integer" } }, "title": "interval_type = horaire", "type": "object" } ], "type": [ "object", "null" ] }, "client-item-limit-response": { "description": "Limites d'objets.", "properties": { "per_item": { "description": "Limites globales d'objets.", "properties": { "available": { "description": "Nombre d'objets restants que tous les utilisateurs peuvent acheter.", "type": "integer" }, "total": { "description": "Nombre maximal d'objets que tous les utilisateurs peuvent acheter.", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "Limites d'objets pour un utilisateur spécifique.", "properties": { "available": { "description": "Nombre d'objets restants que l'utilisateur actuel peut acheter.", "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "client-item-value-point-reward": { "description": "Récompense en points de valeur pour l'objet.", "items": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" }, "type": "array" }, "description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "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.", "type": [ "object", "null" ] }, "error-message-extended-validation": { "description": "Validation error details. Contains an array of property-level errors describing which fields failed validation and why.", "items": { "properties": { "message": { "description": "Validation error message for the field.", "example": "The property external_id is required", "type": "string" }, "property": { "description": "Name of the field that failed validation.", "example": "external_id", "type": "string" } }, "type": "object" }, "type": "array" }, "error-response-base": { "properties": { "errorCode": { "description": "Code d'erreur.", "type": "integer" }, "errorMessage": { "description": "Short error description.", "type": "string" }, "statusCode": { "description": "HTTP response status.", "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "type": "string" } }, "type": "object" }, "five-letter-locale": { "description": "Codes régionaux à cinq caractères.", "properties": { "ar-AE": { "description": "Arabe", "type": [ "string", "null" ] }, "bg-BG": { "description": "Bulgare", "type": [ "string", "null" ] }, "cs-CZ": { "description": "Tchèque", "type": [ "string", "null" ] }, "de-DE": { "description": "Allemand", "type": [ "string", "null" ] }, "en-US": { "description": "Anglais", "type": [ "string", "null" ] }, "es-ES": { "description": "Espagnol (Espagne)", "type": [ "string", "null" ] }, "fr-FR": { "description": "Français", "type": [ "string", "null" ] }, "he-IL": { "description": "Hébreu", "type": [ "string", "null" ] }, "id-ID": { "description": "Indonésien", "type": [ "string", "null" ] }, "it-IT": { "description": "Italien", "type": [ "string", "null" ] }, "ja-JP": { "description": "Japonais", "type": [ "string", "null" ] }, "km-KH": { "description": "Khmer", "type": [ "string", "null" ] }, "ko-KR": { "description": "Coréen", "type": [ "string", "null" ] }, "lo-LA": { "description": "Laotien", "type": [ "string", "null" ] }, "my-MM": { "description": "Birman", "type": [ "string", "null" ] }, "ne-NP": { "description": "Népalais", "type": [ "string", "null" ] }, "ph-PH": { "description": "Philippin", "type": [ "string", "null" ] }, "pl-PL": { "description": "Polonais", "type": [ "string", "null" ] }, "pt-BR": { "description": "Portugais (Brésil)", "type": [ "string", "null" ] }, "ro-RO": { "description": "Roumain", "type": [ "string", "null" ] }, "ru-RU": { "description": "Russe", "type": [ "string", "null" ] }, "th-TH": { "description": "Thaï", "type": [ "string", "null" ] }, "tr-TR": { "description": "Turc", "type": [ "string", "null" ] }, "vi-VN": { "description": "Vietnamien", "type": [ "string", "null" ] }, "zh-CN": { "description": "Chinois (simplifié)", "type": [ "string", "null" ] }, "zh-TW": { "description": "Chinois (traditionnel)", "type": [ "string", "null" ] } }, "title": "five-letter", "type": [ "object", "null" ] }, "game_key_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "group-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group'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/).", "type": [ "object", "null" ] }, "group-display-order": { "default": 1, "description": "Display order of the item group in the catalog. The higher the value, the lower the group appears in the list. If the values are the same, groups are sorted by creation date, with newer groups displayed higher.", "example": 1, "type": "integer" }, "group-image-url": { "description": "URL of the item group image.", "example": "https://example.com/weapons.png", "type": [ "string", "null" ] }, "group-is-contains-any-items": { "description": "Whether the group contains any items, regardless of the specified `item_type`. A group can have `items_count: 0` for the specified type, while `is_contains_any_items` is `true` if the group contains items of other types.", "example": true, "type": "boolean" }, "group-is-enabled": { "default": true, "description": "Whether the item group is enabled in the catalog.", "example": true, "type": "boolean" }, "group-name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group's name. 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/).", "type": [ "object", "null" ] }, "hours_interval": { "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type_hourly": { "description": "Délai d'actualisation récurrent.", "enum": [ "hourly" ], "type": "string" }, "is_clan": { "description": "Détermine l'utilisation du point de valeur dans les chaînes de récompense de clan.", "example": true, "type": "boolean" }, "item-custom-attributes": { "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, "type": "object" }, "item-custom-attributes-response": { "description": "Un JSON contenant les attributs de l'objet et leurs valeurs.", "format": "json", "type": "object" }, "item-in-group-order-request-item": { "additionalProperties": false, "properties": { "item_id": { "description": "Internal item ID assigned by Xsolla. Use the item ID returned in the [item catalog API call](/fr/api/catalog/common-catalog) responses.", "example": 101, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "item_id", "order" ], "type": "object" }, "item-periods": { "description": "Période de vente d'objets.", "items": { "properties": { "date_from": { "description": "Date de mise en vente de l'objet spécifié.", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "date_until": { "description": "Date de retrait de la vente de l'objet spécifié. Peut prendre la valeur `null`.", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "item-periods-response": { "description": "Période de vente d'objets.", "items": { "properties": { "date_from": { "description": "Date de mise en vente de l'objet spécifié.", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] }, "date_until": { "description": "Date de retrait de la vente de l'objet spécifié. Peut prendre la valeur `null`.", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "item_id": { "description": "Internal ID unique de l'objet.", "example": 1, "type": "integer" }, "items_client_groups_response": { "default": [], "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "exclusive", "name": "Exclusive" } ], "items": { "properties": { "external_id": { "description": "Identifiant unique du groupe, généralement utilisé pour le référencer dans les requêtes API ou les systèmes externes.", "example": "exclusive", "type": "string" }, "item_order_in_group": { "description": "Position de l'objet dans le groupe, utilisée pour déterminer son ordre d'affichage.\nCe champ n'est inclus dans la réponse que si elle est demandée via le paramètre de requête additional_fields[].", "example": 1, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Exclusive", "type": "string" } }, "type": "object" }, "type": "array" }, "limit_exceeded_visibility": { "default": "show", "description": "Determines the visibility of the item in the catalog after the purchase limit is reached, until the next limit reset.\n\nApplies to items for which recurring limit resets are configured in the `recurrent_schedule` array.\n\nIf limit resets are not configured, the item doesn't appear in the catalog after the purchase limit is reached,\nregardless of the `limit_exceeded_visibility` value.\n\nPossible values:\n- `show` — The item is returned in catalog retrieval API calls after the purchase limit is reached. In client-side\ncatalog retrieval API calls, once the limit is reached, the item is returned with the `can_be_bought: false` flag. The\nnext reset date is returned in `reset_next_date`.\n- `hide` — The item is not returned in catalog retrieval API calls after the purchase limit is reached, until the\nlimit is reset.", "enum": [ "show", "hide" ], "example": "show", "type": "string" }, "limit_per_item": { "description": "Limites globales d'objets.", "example": 10, "type": [ "integer", "null" ] }, "limit_per_user": { "anyOf": [ { "description": "No per-user item purchase limit.", "type": "null" }, { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "example": 5, "type": "integer" }, { "description": "Configuration détaillée des limites d'achat.", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "Nombre maximal d'objets qu'un utilisateur unique peut acheter.", "example": 5, "type": "integer" } }, "type": "object" } ], "description": "Limites d'objets pour un utilisateur spécifique." }, "long-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "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.", "type": [ "object", "null" ] }, "name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "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.", "type": [ "object", "null" ] }, "per_user_daily": { "description": "Type quotidien d'actualisation des limites pour l'utilisateur.", "properties": { "interval_type": { "description": "Délai d'actualisation récurrent.", "enum": [ "daily" ], "type": "string" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "02:00:00+03:00", "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])", "type": "string" } }, "required": [ "interval_type", "time" ], "title": "interval_type = daily", "type": "object" }, "per_user_hourly_bundle": { "properties": { "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\"`." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = horaire", "type": "object" }, "per_user_hourly_vc": { "properties": { "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\"`." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = horaire", "type": "object" }, "per_user_hourly_vcp": { "properties": { "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\"`." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = horaire", "type": "object" }, "per_user_hourly_vi": { "properties": { "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\"`." } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = horaire", "type": "object" }, "per_user_monthly": { "description": "Type mensuel d'actualisation des limites pour l'utilisateur.", "properties": { "day_of_month": { "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.", "maximum": 31, "minimum": 1, "type": "integer" }, "interval_type": { "description": "Délai d'actualisation récurrent.", "enum": [ "monthly" ], "type": "string" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "23:00:00+03:00", "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])", "type": "string" } }, "required": [ "interval_type", "time", "day_of_month" ], "title": "interval_type = monthly", "type": "object" }, "per_user_weekly": { "description": "Type hebdomadaire d'actualisation des limites pour l'utilisateur.", "properties": { "day_of_week": { "description": "Jour de la semaine où les limites sont actualisées. Où 1 correspond au lundi et 7 au dimanche.", "maximum": 7, "minimum": 1, "type": "integer" }, "interval_type": { "description": "Délai d'actualisation récurrent.", "enum": [ "weekly" ], "type": "string" }, "time": { "description": "Heure d'actualisation des limites dans le fuseau horaire souhaité (arrondie en heures).", "example": "11:00:00+03:00", "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])", "type": "string" } }, "title": "interval_type = weekly", "type": "object" }, "request-attribute-value": { "example": { "external_id": "value_id", "value": { "de": "Wert", "en": "Value" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "external_id", "value" ], "type": "object" }, "schemas-422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "two-letter-locale": { "description": "Codes de langue à deux lettres minuscules.", "properties": { "ar": { "description": "Arabe", "type": [ "string", "null" ] }, "bg": { "description": "Bulgare", "type": [ "string", "null" ] }, "cn": { "description": "Chinois (simplifié)", "type": [ "string", "null" ] }, "cs": { "description": "Tchèque", "type": [ "string", "null" ] }, "de": { "description": "Allemand", "type": [ "string", "null" ] }, "en": { "description": "Anglais", "type": [ "string", "null" ] }, "es": { "description": "Espagnol (Espagne)", "type": [ "string", "null" ] }, "fr": { "description": "Français", "type": [ "string", "null" ] }, "he": { "description": "Hébreu", "type": [ "string", "null" ] }, "id": { "description": "Indonésien", "type": [ "string", "null" ] }, "it": { "description": "Italien", "type": [ "string", "null" ] }, "ja": { "description": "Japonais", "type": [ "string", "null" ] }, "km": { "description": "Khmer", "type": [ "string", "null" ] }, "ko": { "description": "Coréen", "type": [ "string", "null" ] }, "lo": { "description": "Laotien", "type": [ "string", "null" ] }, "my": { "description": "Birman", "type": [ "string", "null" ] }, "ne": { "description": "Népalais", "type": [ "string", "null" ] }, "ph": { "description": "Philippin", "type": [ "string", "null" ] }, "pl": { "description": "Polonais", "type": [ "string", "null" ] }, "pt": { "description": "Portugais", "type": [ "string", "null" ] }, "ro": { "description": "Roumain", "type": [ "string", "null" ] }, "ru": { "description": "Russe", "type": [ "string", "null" ] }, "th": { "description": "Thaï", "type": [ "string", "null" ] }, "tr": { "description": "Turc", "type": [ "string", "null" ] }, "tw": { "description": "Chinois (traditionnel)", "type": [ "string", "null" ] }, "vi": { "description": "Vietnamien", "type": [ "string", "null" ] } }, "title": "two-letter", "type": [ "object", "null" ] }, "value-cart_is_free": { "default": false, "description": "Si ce paramètre est défini sur `true`, le panier est gratuit.", "example": false, "type": "boolean" }, "value-external_id": { "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.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "value-is_free": { "default": false, "description": "Détermine la gratuité de l'objet.", "example": false, "type": "boolean" }, "value-is_paid_randomized_reward": { "default": false, "description": "Si l’objet est une récompense payante aléatoire (par exemple, une boîte à butin).", "example": false, "type": "boolean" }, "value-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Strategie", "en": "Strategy" }, "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.", "example": { "de": "Strategie", "en": "Strategy" }, "type": "object" }, "value-point-amount": { "description": "Montant des points de valeur.", "type": "integer" }, "value-point-name": { "description": "Nom du point de valeur.", "type": "string" }, "value-point-sku": { "description": "ID unique du point de valeur.", "type": "string" }, "virtual_currency_package_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "virtual_currency_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] }, "virtual_item_recurrent_schedule": { "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" } ] } }, "type": [ "object", "null" ] } }, "securitySchemes": { "AuthForCart": { "description": "The `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\n\n1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data.\n\nAlternatively, you can use a [token for opening the payment UI](/fr/api/pay-station/token/create-token).\n\n2. Simplified mode without `Authorization` header. This mode is used only for unauthorized users and can be applied only for [selling game keys](/fr/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n* `x-unauthorized-id` with a request ID\n* `x-user` with the user’s email address encoded in Base64.", "scheme": "bearer", "type": "http" }, "XsollaLoginUserJWT": { "bearerFormat": "JWT", "description": "Client-side calls use the `XsollaLoginUserJWT` authentication scheme. The request must include the user's JWT in the `Authorization` header in the following format: Bearer ``. The token identifies the user and provides access to personalized data. For details on how to create a token, refer to the [Xsolla Login API documentation](/fr/api/login/authentication-schemes#getting-user-token).\n\nAlternatively, you can use a [token for opening the payment UI](/fr/api/pay-station/token/create-token).", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "Server-side calls use the `basicAuth` authentication scheme. All requests to API must\ncontain the `Authorization: Basic `\nheader, where `your_authorization_basic_key` is the `project_id:api_key`\npair encoded according to the Base64 standard.\n\nYou can use `merchant_id` instead of `project_id` if you need. It doesn't affect functionality.\n\nGo to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:\n\n* `merchant_id` is shown:\n * In the **Company settings > Company** section\n * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:\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**Notice**\n\nIf a required API call doesn't include the `project_id` path parameter, use an API key that is valid across all company projects for authorization.\n{% /html %}\n\n* `project_id` is shown:\n * In Publisher Account next to the name of the project.\n * In the URL in the browser address bar when working on project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n\nFor more information about working with API keys, see the [API reference](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview).", "scheme": "basic", "type": "http" }, "basicMerchantAuth": { "description": "Server-side calls use the `basicMerchantAuth` authentication scheme. All requests to API must\ncontain the `Authorization: Basic `\nheader, where `your_authorization_basic_key` is the `merchant_id:api_key`\npair encoded according to the Base64 standard.\n\nGo to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters:\n\n* `merchant_id` is shown:\n * In the **Company settings > Company** section\n * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`\n* `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) section.\n\nFor more information about working with API keys, see the [API reference](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview).", "scheme": "basic", "type": "http" } } }, "info": { "description": "# Overview\n\n- **Version:** 2.0.0\n- **Servers:** `https://store.xsolla.com/api`\n- [Contact Us by Email](mailto:integration@xsolla.com)\n- **Contact URL:** https://xsolla.com/\n- **Required TLS version:** 1.2\n\nThe Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.\n\nThe API allows you to manage the following catalog entities:\n\n* **Virtual items** — in-game items such as weapons, skins, boosters.\n* **Virtual currency** — virtual money used to purchase virtual goods.\n* **Virtual currency packages** — predefined bundles of virtual currency.\n* **Bundles** — combined packages of virtual items, currency, or game keys sold as a single SKU.\n* **Game keys** — keys for games and DLCs distributed via platforms like Steam or other DRM providers.\n* **Groups** — logical groupings for organizing and sorting items within the catalog.\n\n## API calls\n\nThe API is divided into the following groups:\n\n* **Admin** — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via [basic access authentication](https://developers.xsolla.com/fr/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials. Not intended for storefront use.\n* **Catalog** — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.\n\n# Authentication\n\nAPI calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call.\n\n## Authentication using user's JWT\n\nUser's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/fr/api/login/authentication-schemes#getting-user-token).\n\nThe token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data.\n\nAlternatively, you can use a [token for opening the payment UI](/fr/api/pay-station/token/create-token).\n\n## Basic HTTP authentication\n\nBasic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/fr/api/getting-started/#api_keys_overview) is typically used.\n\n
Note

The API key is confidential and must not be stored or used in client applications.
\n\nWith basic server-side authentication, all API requests must include the following header:\n\n- for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64\n- for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64\n\nYou can find the parameter values in [Publisher Account](https://publisher.xsolla.com/):\n\n- `merchant_id` is displayed:\n - In **Company settings > Company**.\n - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n- `project_id` is displayed:\n - Next to the project name in Publisher Account.\n - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n- `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:\n - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
\n\nFor more information about working with API keys, see the [API references](/fr/api/getting-started/#api_keys_overview).\n\n## Authentication with guest access support\n\nThe `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\n\n1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data.\nAlternatively, you can use a [token for opening the payment UI](/fr/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/fr/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\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\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\n
Note

Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/fr/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\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# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/fr/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/fr/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/fr/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/fr/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/fr/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n
\n Notice

\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.\n
\n
\n\nExample API calls:\n- [Get virtual items list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/fr/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/fr/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/fr/api/catalog/common-catalog/get-sellable-items)\n\n
\n Note

\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/fr/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/fr/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/fr/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/fr/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n
\n Note

\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/fr/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/fr/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/fr/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n
\n Note

\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/fr/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/fr/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/fr/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/fr/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n
\n Note

\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
\n\nTo enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.\n\nPossible order statuses:\n- `new` — order created\n- `paid` — payment received\n- `done` — item delivered\n- `canceled` — order canceled\n- `expired` — payment expired\n\nTrack order status using one of the following methods:\n- [webhooks configured on your server](/fr/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking)\n- [short-polling](/fr/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling)\n- [WebSocket API](/fr/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api)\n\n## Useful links\n\n- Authentication\n- [API calls by interaction model](/fr/api/catalog/section/authentication)\n- [Payment testing](/fr/dev-resources/testing/general-info/#general_overview)\n- [Set up order status tracking](/fr/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking)\n- [Webhooks](/fr/webhooks/overview)\n- [Rate limits](/fr/api/login/rate-limits)\n- [Errors handling](/fr/api/getting-started/#api_errors_handling)\n- [API keys](/fr/api/getting-started/#api_keys_overview)\n\n# Pagination\n\nAPI calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.\n\nUse the following parameters to control the number of returned items:\n\n- `limit` — number of items per page\n- `offset` — index of the first item on the page (numbering starts from 0)\n- `has_more` — indicates whether another page is available\n- `total_items_count` — total number of items\n\nExample request:\n\n```\nGET /items?limit=20&offset=40\n```\n\nResponse example:\n\n```json\n{\n \"items\": [...],\n \"has_more\": true,\n \"total_items_count\": 135\n}\n```\n\nIt is recommended to send subsequent requests until the response returns `has_more = false`.\n\n# Date and time format\n\nDates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n\nThe following are supported:\n\n- UTC offset\n- `null` value when there is no time restriction for displaying an item\n- [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields\n\nFormat: `YYYY-MM-DDTHH:MM:SS±HH:MM`\n\nExample: `2026-03-16T10:00:00+03:00`\n\n# Localization\n\nXsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/fr/doc/shop-builder/references/supported-languages/).\n\n**Supported fields**\n\nLocalization can be specified for the following parameters:\n\n- `name`\n- `description`\n- `long_description`\n\n**Locale format**\n\nThe locale key can be specified in one of the following formats:\n\n- Two-letter language code: `en`, `ru`\n- Five-letter language code: `en-US`, `ru-RU`, `de-DE`\n\n**Examples**\n\nExample with a two-letter language code:\n\n```json\n{\n \"name\": {\n \"en\": \"Starter Pack\",\n \"ru\": \"Стартовый набор\"\n }\n}\n```\n\nExample with a five-letter language code:\n\n```json\n{\n \"description\": {\n \"en-US\": \"Premium bundle\",\n \"de-DE\": \"Premium-Paket\"\n }\n}\n```\n\n# Error response format\n\nIf an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/fr/dev-resources/references/errors/store-errors/).\n\n**Response example:**\n\n```json\n{\n \"errorCode\": 1102,\n \"errorMessage\": \"Validation error\",\n \"statusCode\": 422,\n \"transactionId\": \"c9e1a...\"\n}\n```\n\n- `errorCode` — error code.\n- `errorMessage` — short error description.\n- `statusCode` — HTTP response status.\n- `transactionId` — request ID. Returned only in some cases.\n- `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases.\n\n**Extended response example:**\n\n```json\n{\n \"errorCode\": 7001,\n \"errorMessage\": \"Chain not found\",\n \"errorMessageExtended\": {\n \"chain_id\": \"test_chain_id\",\n \"project_id\": \"test_project_id\",\n \"step_number\": 2\n },\n \"statusCode\": 404\n}\n```\n\n**Common HTTP status codes**\n\n- `400` — invalid request\n- `401` — authentication error\n- `403` — insufficient permissions\n- `404` — resource not found\n- `422` — validation error\n- `429` — rate limit exceeded\n\n**Recommendations**\n\n- Handle the HTTP status and the response body together.\n- Use `errorCode` to process errors related to application logic.\n- Use `transactionId` to identify requests more quickly when analyzing errors.", "title": "Catalog API", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/v1/admin/projects/{project_id}/connectors/import_items/import/status": { "get": { "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.", "operationId": "get-items-import-status", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-items-import-status-model" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "Lire le statut de l'importation d'objets", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v1/projects/{project_id}/import/from_external_file": { "post": { "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/).", "operationId": "import-items-from-external-file", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/connector-import-items-body" }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "import_id": { "description": "ID de l'opération d'importation. Si vous rencontrez des difficultés lors de l'importation du fichier JSON, signalez cet ID à votre responsable de la réussite client ou envoyez un e-mail à csm@xsolla.com.", "example": "af9f3638a16e11ef880da2cd677d2d24", "type": "string" } }, "type": "object" } } }, "description": "Fichier importé avec succès, traitement en cours." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/connector-422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "Importer des objets via un fichier JSON", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/admin/project/{project_id}/cart/fill": { "put": { "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", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Remplir le panier d'objets", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/admin/project/{project_id}/cart/{cart_id}/fill": { "put": { "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", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Remplir le panier d'objets par ID de panier", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/merchant/{merchant_id}/projects": { "get": { "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
", "operationId": "get-projects", "parameters": [ { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/merchant_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "project_id": 17558 }, { "project_id": 17559 } ], "total_items_count": 2 } } }, "schema": { "properties": { "has_more": { "example": true, "type": "boolean" }, "items": { "properties": { "project_id": { "example": 17558, "type": "integer" } }, "type": "array" }, "total_items_count": { "example": 3, "type": "integer" } }, "type": "object" } } }, "description": "Les informations sur les projets ont été reçues avec succès." }, "401": { "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." }, "422": { "description": "Paramètres de requête `limit` ou `offset` non valides." } }, "security": [ { "basicMerchantAuth": [] } ], "summary": "Lire les projets", "tags": [ "common-merchant" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute": { "get": { "description": "Récupère la liste des attributs au sein d'un projet à des fins d'administration.", "operationId": "admin-get-attribute-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute-list-response" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des attributs (administrateur)", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée un attribut.", "operationId": "admin-create-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}": { "delete": { "description": "Supprime un attribut.\n
Note

Si vous supprimez un attribut de bien, toutes ses données et connexions avec les objets seront perdues.
", "operationId": "delete-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "L'attribut a été supprimé avec succès." }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur un attribut spécifique.", "operationId": "admin-get-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-attribute-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un attribut spécifique", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour un attribut.", "operationId": "admin-update-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value": { "delete": { "description": "Supprime toutes les valeurs de l'attribut.
Note

Si 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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer toutes les valeurs d'un attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée une valeur d'attribut.\n\n
Attention

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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer une valeur d'attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": { "delete": { "description": "Supprime une valeur de l'attribut.
Note

Si 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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_external_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer une valeur d'attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour les valeurs d'un attribut.", "operationId": "admin-update-attribute-value", "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" }, "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour une valeur d'attribut", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/grant": { "post": { "description": "Accorde un droit à l'utilisateur.\n\n
Attention

Seuls les codes de jeu ou les jeux pour une plateforme sans DRM peuvent être accordés.
", "operationId": "grant-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "code": "AAAA-BBBB-CCCC-DDDD", "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_country": "US", "user_external_id": "user-external-id" }, "properties": { "code": { "description": "Code du jeu.", "example": "AAAA-BBBB-CCCC-DDDD", "type": [ "string", "null" ] }, "drm": { "description": "Objet contenant des propriétés du DRM.", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "Objet contenant des propriétés de jeu.", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "Quel type de droit doit être accordé. Si le paramètre est défini sur `sandbox`, le droit est accordé à l'utilisateur en mode bac à sable. Si le paramètre est défini sur `default`, le droit est accordé à l'utilisateur en mode de production.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_country": { "description": "Pays de l'utilisateur.", "example": "US", "type": [ "string", "null" ] }, "user_external_id": { "description": "ID unique de l'utilisateur.", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "Le droit a été accordé." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" }, "Game not found": { "value": { "errorCode": 4604, "errorMessage": "[0401-4604]: Game not found.", "statusCode": 404, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Code de jeu non trouvé. Assurez-vous que les paramètres `code` et `project_id` sont corrects." }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Accorder un droit (administrateur)", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/revoke": { "post": { "description": "Retire les droits à l'utilisateur.\n\n
Attention

Seuls les codes de jeu ou les jeux pour une plateforme sans DRM peuvent être retirés.
", "operationId": "revoke-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_external_id": "user-external-id" }, "properties": { "drm": { "description": "Objet contenant des propriétés du DRM.", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "Objet contenant des propriétés de jeu.", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "Quel type de droit doit être retiré. Si le paramètre est défini sur `sandbox`, le droit est retiré à l'utilisateur en mode bac à sable. Si le paramètre est défini sur `default`, le droit est retiré à l'utilisateur en mode de production.", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_external_id": { "description": "ID unique de l'utilisateur.", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "Révoqué avec succès." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Révoquer un droit (administrateur)", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/id/{id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its internal numeric ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/order": { "put": { "description": "Sets the display order for item groups within a project. Pass an array of groups with their new order values.", "operationId": "admin-reorder-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder item groups", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/{external_id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by external ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle": { "get": { "description": "Récupère la liste des lots au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-bundle-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire une liste de lots", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée un lot.", "operationId": "admin-create-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un lot", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": { "get": { "description": "Récupère la liste des lots au sein d'un groupe à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-bundle-list-in-group-by-external-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des lots par external ID d'un groupe spécifique", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": { "get": { "description": "Récupère la liste des lots au sein d'un groupe à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-bundle-list-in-group-by-id", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des lots par ID d'un groupe spécifique", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}": { "delete": { "description": "Supprime un lot.", "operationId": "admin-delete-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-delete-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un lot", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur un lot au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un lot", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour un lot.", "operationId": "admin-update-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un lot", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": { "put": { "description": "Masque un lot dans un catalogue.", "operationId": "admin-hide-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-hide-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Masquer un lot dans le catalogue", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": { "put": { "description": "Affiche un lot dans un catalogue.", "operationId": "admin-show-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-show-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Afficher un lot dans le catalogue", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game": { "get": { "description": "Récupère la liste des jeux 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\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-game-list", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-games-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des jeux (administrateur)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée un jeu dans le projet.", "operationId": "admin-create-game", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "item_id": 101, "sku": "com.xsolla.game_1" } } }, "schema": { "properties": { "item_id": { "example": 101, "type": "integer" }, "sku": { "example": "com.xsolla.game_1", "type": "string" } }, "type": "object" } } }, "description": "Le jeu a été créé avec succès." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un jeu", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/id/{item_id}": { "delete": { "description": "Supprime un jeu du projet par son ID.", "operationId": "admin-delete-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "responses": { "204": { "description": "Le jeu a été supprimé avec succès." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un jeu par ID", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "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\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Jeu non trouvé." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un jeu par ID (administrateur)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour les informations d'un jeu dans le projet par son ID.", "operationId": "admin-update-game-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Jeu non trouvé." }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un jeu par ID", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": { "delete": { "description": "Supprime tous les codes par ID de clé de jeu.", "operationId": "admin-delete-codes-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer des codes par ID", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": { "delete": { "description": "Supprime tous les codes par UGS de clé de jeu.", "operationId": "admin-delete-codes-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer les codes", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": { "get": { "description": "Récupère un certain nombre de codes par ID de clé de jeu.", "operationId": "admin-get-codes-by-id", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire des codes par ID", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": { "get": { "description": "Récupère un certain nombre de codes par UGS de clé de jeu.", "operationId": "admin-get-codes-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire des codes", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": { "post": { "description": "Télécharge des codes par ID de clé de jeu.", "operationId": "admin-upload-codes-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "Fichier avec codes.", "format": "binary", "type": "string" }, "region_id": { "description": "ID de la région.", "type": "integer" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Télécharger des codes par ID", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": { "get": { "description": "Récupère des informations sur la session de chargement des codes.", "operationId": "admin-get-codes-session", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "ID de la session.", "in": "path", "name": "session_id", "required": true, "schema": { "default": "fc7105b6e8ee01339582970b37697242", "type": "string" } } ], "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." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire des informations sur la session de chargement des codes", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": { "post": { "description": "Télécharge des codes par UGS de clé de jeu.", "operationId": "admin-upload-codes-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "Fichier avec codes.", "format": "binary", "type": "string" }, "region_id": { "description": "ID de la région.", "type": "integer" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu ou région introuvable." } }, "security": [ { "basicAuth": [] } ], "summary": "Télécharger des codes", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/sku/{item_sku}": { "delete": { "description": "Supprime un jeu dans le projet par UGS.", "operationId": "admin-delete-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "Le jeu a été supprimé avec succès." }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un jeu par UGS", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "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\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Jeu non trouvé." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un jeu (administrateur)", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour les informations d'un jeu dans le projet par UGS.", "operationId": "admin-update-game-by-sku", "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": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Jeu non trouvé." }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un jeu par UGS", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups": { "get": { "description": "Retrieves the full list of item groups within a project without pagination. For administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des groupes d'objets", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Creates an item group within a project.\nTo retrieve item groups for building a catalog, use the Get item group list client-side endpoint.", "operationId": "admin-create-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Create item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups/{external_id}": { "delete": { "description": "Deletes an item group by its external ID.", "operationId": "admin-delete-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Delete item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Retrieves an item group by its external ID for administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Updates an item group by its external ID.", "operationId": "admin-update-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Update item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": { "delete": { "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}", "operationId": "remove-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "Quantité à supprimer.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "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é." } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer une quantité de la limite de pré-commande pour un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "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}", "operationId": "get-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 } } }, "schema": { "properties": { "available": { "example": 431, "type": "integer" }, "is_pre_order_limit_enabled": { "example": true, "type": "boolean" }, "item_id": { "example": 1, "type": "integer" }, "reserved": { "example": 13, "type": "integer" }, "sku": { "example": "com.xsolla.item_1", "type": "string" }, "sold": { "example": 556, "type": "integer" } }, "type": "object" } } }, "description": "Les informations relatives à la limite de pré-commande de l'objet ont été reçues avec succès." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "Objet non trouvé." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire des informations sur la limite de pré-commande d'un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "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}", "operationId": "add-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "Quantité à ajouter.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "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é." } }, "security": [ { "basicAuth": [] } ], "summary": "Ajouter une quantité à la limite de pré-commande pour un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "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}", "operationId": "set-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "Quantité à définir.", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "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é." } }, "security": [ { "basicAuth": [] } ], "summary": "Définir une quantité de la limite de pré-commande pour un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": { "delete": { "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}", "operationId": "remove-all-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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é." } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer toute la quantité de la limite de pré-commande pour un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": { "put": { "description": "Active/désactive 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}", "operationId": "toggle-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "is_pre_order_limit_enabled": true }, "schema": { "properties": { "is_pre_order_limit_enabled": { "type": "boolean" } }, "required": [ "is_pre_order_limit_enabled" ], "type": "object" } } } }, "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é." } }, "security": [ { "basicAuth": [] } ], "summary": "Basculer la limite de pré-commande pour un objet", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency": { "get": { "description": "Récupère la liste des monnaies virtuelles au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-currencies-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des monnaies virtuelles", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée une monnaie virtuelle.", "operationId": "admin-create-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer une monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package": { "get": { "description": "Récupère la liste des packages de monnaie virtuelle au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-currency-packages-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des packages de monnaie virtuelle (administrateur)", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée un package de monnaie virtuelle.", "operationId": "admin-create-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un package de monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": { "delete": { "description": "Supprime un package de monnaie virtuelle.", "operationId": "admin-delete-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un package de monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur un package de monnaie virtuelle au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un package de monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour un package de monnaie virtuelle.", "operationId": "admin-update-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un package de monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": { "delete": { "description": "Supprime une monnaie virtuelle.", "operationId": "admin-delete-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "La monnaie virtuelle a été supprimée avec succès." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer une monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur une monnaie virtuelle au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-currency", "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire une monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour une monnaie virtuelle.", "operationId": "admin-update-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "204": { "content": {}, "description": "La monnaie virtuelle a été mise à 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" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour une monnaie virtuelle", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items": { "get": { "description": "Récupère la liste des objets virtuels au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-items-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des objets virtuels", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée un objet virtuel.", "operationId": "admin-create-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un objet virtuel", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": { "get": { "description": "Récupère la liste des objets virtuels au sein d'un groupe à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-items-list-by-group-external-id", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des objets virtuels par external ID d'un groupe spécifique", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": { "get": { "description": "Récupère la liste des objets virtuels au sein d'un groupe à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-items-list-by-group-id", "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" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des objets virtuels par ID d'un groupe spécifique", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": { "delete": { "description": "Supprime un objet virtuel.", "operationId": "admin-delete-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "L'objet virtuel a été supprimé avec succès." }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer un objet virtuel", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur un objet virtuel au sein d'un projet à des fins d'administration.\n\n
Note

N'utilisez pas cet endpoint pour créer un catalogue de magasin.
", "operationId": "admin-get-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire un objet virtuel", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour un objet virtuel.", "operationId": "admin-update-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "204": { "content": {}, "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un objet virtuel", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups": { "get": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group list filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": { "get": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region": { "get": { "description": "Récupère la liste des régions.\n\nUtilisez les régions pour gérer les restrictions régionales.", "operationId": "admin-get-regions", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-regions-list" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des régions", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Crée une région.\n\nUtilisez les régions pour gérer les restrictions régionales.", "operationId": "admin-create-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer une région", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region/{region_id}": { "delete": { "description": "Supprime une région spécifique.", "operationId": "admin-delete-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/204-admin-delete-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Supprimer une région", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère des informations sur une région spécifique.\n\nUtilisez les régions pour gérer les restrictions régionales.", "operationId": "admin-get-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire une région", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Met à jour les informations sur une région spécifique.\n\nUtilisez les régions pour gérer les restrictions régionales.", "operationId": "admin-update-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour une région", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/all": { "delete": { "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/)", "operationId": "reset-all-user-items-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits" }, "responses": { "200": { "description": "La limite a été actualisée avec succès." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "User not found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "items": { "properties": { "message": { "type": "string" }, "property": { "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Actualiser toutes les limites d'achat pour un utilisateur spécifique", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": { "delete": { "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/)", "operationId": "remove-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Réduire le nombre d'objets offerts pour un utilisateur spécifique", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Récupère 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/)", "operationId": "get-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Lire le nombre d'objets offerts pour un utilisateur spécifique", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "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/)", "operationId": "add-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Augmenter le nombre d'objets offerts pour un utilisateur spécifique", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "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/)", "operationId": "set-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-flexible" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Définir le nombre d'objets offerts pour un utilisateur spécifique", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": { "delete": { "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/)", "operationId": "reset-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits-flexible" }, "responses": { "200": { "description": "La limite a été actualisée avec succès." }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Objet non trouvé." }, "422": { "content": { "application/json": { "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" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "basicAuth": [] } ], "summary": "Actualiser la limite d'achat", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "Renvoie le panier de l'utilisateur actuel.", "operationId": "get-user-cart", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "Lire le panier de l'utilisateur actuel", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "Supprime tous les objets du panier.", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "204": { "description": "Le panier a été vidé avec succès." } }, "security": [ { "AuthForCart": [] } ], "summary": "Supprimer tous les objets du panier actuel", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "Remplit d'objets le panier. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.", "operationId": "cart-fill", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "Remplir le panier d'objets", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "Supprime un objet du panier.", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "L'objet a été supprimé du panier avec succès." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "Supprimer un objet du panier actuel", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "Met à jour un objet de panier existant ou en crée un nouveau dans le panier.", "operationId": "put-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "Le panier a été mis à jour avec succès." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-can-put-only-virtual-good-to-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "Mettre à jour un objet du panier actuel", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "Renvoie le panier de l'utilisateur par son ID de panier.", "operationId": "get-cart-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "Lire le panier par ID de panier", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "Supprime tous les objets du panier.", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "responses": { "204": { "description": "Le panier a été vidé avec succès." } }, "security": [ { "AuthForCart": [] } ], "summary": "Supprimer tous les objets du panier par ID de panier", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "Remplit d'objets un panier spécifique. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.", "operationId": "cart-fill-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "Remplir un panier spécifique d'objets", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "Supprime un objet du panier.", "operationId": "delete-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "L'objet a été supprimé du panier avec succès." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "Supprimer un objet du panier par ID de panier", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "Met à jour un objet de panier existant ou en crée un nouveau dans le panier.", "operationId": "put-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "Le panier a été mis à jour avec succès." }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-non-negative-quantity" } }, "security": [ { "AuthForCart": [] } ], "summary": "Mettre à jour un objet du panier par ID de panier", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement": { "get": { "description": "Get the list of games owned by the user. The response will contain an array of games owned by a particular user.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-user-games", "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire la liste des jeux qu'un utilisateur détient", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement/redeem": { "post": { "description": "Grants entitlement by a provided game code.\n
\n Notice

\n You can redeem codes only for the DRM-free platform.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "redeem-game-pin-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "Code du jeu.", "example": "AAAA-BBBB-CCCC-DDDD", "type": "string" }, "sandbox": { "default": false, "description": "Échange un code de jeu en mode bac à sable. L'option est disponible pour les utilisateurs spécifiés dans la liste des utilisateurs de l'entreprise.", "example": false, "type": "boolean" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "201": { "description": "Échange réussi." }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Code de jeu non trouvé. Assurez-vous que les paramètres `code` et `project_id` sont corrects." }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "Game code is already activated": { "value": { "errorCode": 5107, "errorMessage": "[0401-5107]: Game code has been already activated", "statusCode": 422, "transactionId": "transaction id" } }, "Game is in pre-order state": { "value": { "errorCode": 5106, "errorMessage": "[0401-5106]: Item: game_sku is in pre-order state and can not be redeemed", "statusCode": 422, "transactionId": "transaction id" } }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "Demande non valide." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Échanger un code de jeu côté client", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart": { "post": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "Créer une commande à partir d'un panier gratuit", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart/{cart_id}": { "post": { "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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "Créer une commande à partir d'un panier gratuit spécifique", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/item/{item_sku}": { "post": { "description": "Creates an order with a specified free item. The created order will get a `done` order status.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-free-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-item" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Créer une commande à partir d'un bien gratuit spécifique", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items": { "get": { "description": "Gets a sellable items list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste d'objets vendables", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle": { "get": { "description": "Gets a list of bundles for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de lots", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/group/{external_id}": { "get": { "description": "Gets a list of bundles within a group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list-in-group", "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" }, { "$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" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de lots par groupe spécifique", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "description": "Gets a specified bundle.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle" } }, "schema": { "$ref": "#/components/schemas/Bundles_client_bundle" } } }, "description": "Le lot spécifié a été reçu avec succès." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un lot spécifique", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game": { "get": { "description": "Gets a games list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-list", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de jeux", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "Récupère la liste des DRM disponibles.", "operationId": "get-drm-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-drm-list" } }, "security": [], "summary": "Lire la liste des DRM", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "description": "Gets a games list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-group", "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" }, { "$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" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de jeux par groupe spécifique", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "description": "Gets a game key list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-keys-group", "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" }, { "$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" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-game-keys-by-group-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de clés de jeu par groupe spécifique", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "description": "Gets a game key for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-key-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "UGS de l'objet.", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "xsollus_basic_edition_steam", "type": "string" } }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] } } }, "schema": { "description": "Informations sur les clés du jeu.", "example": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "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.", "example": "steam_key_1", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "2.9900", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "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.", "example": "com.xsolla.game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "La clé de jeu a été reçue avec succès." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_key_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Clé de jeu non trouvée." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une clé de jeu pour le catalogue", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "description": "Gets a game for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "UGS de l'objet.", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "full_game_1", "type": "string" } }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "9c5774997fc072b973bd5c231075c13841413f62", "value": "Casual, Logic" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "limits": null, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } } }, "schema": { "description": "Informations sur le jeu.", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "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.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "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.", "example": "steam", "type": "string" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "2.9900", "type": "string" }, "currency": { "description": "Devise du prix de l'article. Code à trois lettres selon [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "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.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "Type d'unité : `game`.", "example": "game", "type": "string" } }, "type": "object" } } }, "description": "Le jeu a été reçu avec succès." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "Jeu non trouvé." } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un jeu pour le catalogue", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/group/{external_id}": { "get": { "description": "Gets a sellable items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items-group", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/external_id_59080-group-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" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste d'objets vendables par groupe spécifique", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/groups": { "get": { "description": "Retrieves an item group list for building a catalog without pagination.\n
Note

The use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.
", "operationId": "get-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/with_geo-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups" } }, "security": [], "summary": "Lire la liste des groupes d'objets", "tags": [ "item-groups-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/id/{item_id}": { "get": { "description": "Gets a sellable item by its ID.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_id_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-id_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un objet vendable par ID", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/sku/{sku}": { "get": { "description": "Gets a sellable item by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_sku_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un objet vendable par UGS", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "description": "Gets a virtual currency list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de monnaies virtuelles", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "description": "Gets a virtual currency packages list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-packages-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste de packages de monnaie virtuelle", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}": { "get": { "description": "Gets a virtual currency packages by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_package_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-package" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un package de monnaie virtuelle par UGS", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}": { "get": { "description": "Gets a virtual currency by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une monnaie virtuelle par UGS", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "description": "Gets a virtual items list for building a catalog.\n
\n Notice

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n

See also: The Get all virtual items list API call for client-side search or indexing.", "operationId": "get-virtual-items", "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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste d'objets virtuels", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/all": { "get": { "description": "Gets a list of all virtual items for searching on client-side.\n
\n Notice

\n Returns only item SKU, name, groups and description.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n

See also: The Get virtual items list API call for retrieving detailed item data with pagination.", "operationId": "get-all-virtual-items", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire la liste de tous les objets virtuels", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "description": "Gets an items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-group", "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" }, { "$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" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire une liste d'objets par groupe spécifique", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": { "get": { "description": "Gets a virtual item by SKU for building a catalog.\n
\n Notice

\n This API call returns generic item\n catalog data when used without authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-item-by-sku" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Lire un objet virtuel par UGS", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/order/{order_id}": { "get": { "description": "Récupère des informations sur une commande spécifique.", "operationId": "get-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/order_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-order" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-get-order" } }, "security": [ { "AuthForCart": [] } ], "summary": "Lire une commande", "tags": [ "order" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart": { "post": { "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\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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "Créer une commande à partir de tous les objets du panier actuel", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart/{cart_id}": { "post": { "description": "Utilisé pour l'intégration client-serveur. Crée une commande à partir de tous les objets d'un panier spécifique 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\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", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "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" } }, "security": [ { "AuthForCart": [] } ], "summary": "Créer une commande à partir de tous les objets d'un panier spécifique", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}": { "post": { "description": "Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the `new` order status.\n\nThe client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n
Notice

As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station.

\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "create-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "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" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Créer une commande à partir d'un objet spécifique", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": { "post": { "description": "Creates item purchase using virtual currency.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-order-with-item-for-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/platform-query-param" } ], "requestBody": { "content": { "application/json": { "example": { "custom_parameters": { "array_param": [ { "object1": { "param": "https://xsolla.com" }, "property": { "int_property": 112, "string_property": "xsolla" } }, { "object2": { "param": "https://developers.xsolla.com/fr" }, "property": { "int_property": 112, "string_property": "email@example.com" } } ], "bool_param": true, "int_param": 100, "null_param": null, "object_param": { "key": "value" } } }, "schema": { "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters" } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-quick-purchase" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-not-enough-virtual-currency" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "Créer une commande à partir d'un objet spécifique en monnaie virtuelle", "tags": [ "virtual-payment" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v3/project/{project_id}/admin/order/search": { "post": { "description": "Récupère la liste des commandes, triées par date de création dans un ordre croissant.", "operationId": "admin-order-search", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/admin-order-search" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-order-search" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Lire la liste des commandes pour la période spécifiée", "tags": [ "order" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/payment/token": { "post": { "description": "Génère une commande et un jeton de paiement pour celle-ci. La commande est générée sur la base des objets passés dans le corps de la requête.\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\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
", "operationId": "admin-create-payment-token", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "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" } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un jeton de paiement pour un achat", "tags": [ "payment-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } } }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "description": "You can use virtual items and virtual currency to build an in-game store and configure how it is displayed to users. The following item types are available:\n\n* Virtual items — in-game goods such as weapons, skins, or boosters. Can be sold for real money or virtual currency.\n* Virtual currency — in-game currency used to purchase virtual items. Can be sold for real money or virtual currency.\n* Virtual currency packages — a fixed amount of virtual currency. Can be sold for real money or virtual currency.\n\nGroups are used to organize items in the catalog. They allow you to logically group items and manage how they are displayed.\n\nUse API calls from the Admin subsection to create, update, and delete items.\n\nUse API calls from the Catalog subsection to retrieve lists of items and display them to users.\n\n
\n Notice

\n Do not use API calls from the Admin subsection to build a store catalog.\n
\n
\n
\n Note

\n The Get virtual items list API call returns detailed item data, including prices and attributes, and supports pagination. Use it to display catalog pages in the storefront.\n

\n The Get all virtual items list API call returns item SKU, name, description, as well as group ID and name without pagination. Use it for client-side search or indexing.\n
\n
\n\nFor purchases with virtual currency, use the [Create order with specified item purchased by virtual currency](/fr/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required — the charge is processed when the API call is executed.\n\nExample of a purchase flow with virtual currency:\n\n![Purchase flow with virtual currency example](https://cdn.xsolla.net/developers/current/images/api_docs/virtual-items-currency-overview.png)", "name": "virtual-items-currency-overview", "x-displayName": "Overview" }, { "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-catalog", "x-displayName": "Catalogue" }, { "name": "game-keys-entitlement", "x-displayName": "Droit" }, { "name": "game-keys-admin", "x-displayName": "Administrateur" }, { "name": "bundles-admin", "x-displayName": "Administrateur" }, { "name": "bundles-catalog", "x-displayName": "Catalogue" }, { "name": "cart-client-side", "x-displayName": "Panier (côté client)" }, { "name": "cart-server-side", "x-displayName": "Panier (côté serveur)" }, { "name": "payment-client-side", "x-displayName": "Paiement (côté client)" }, { "name": "payment-server-side", "x-displayName": "Paiement (côté serveur)" }, { "name": "order", "x-displayName": "Commande" }, { "name": "free-item", "x-displayName": "Biens gratuits" }, { "description": "Purchase limits allow you to restrict the quantity of items available for purchase by a single user or all users. You can also configure scheduled limit resets.\n\nLimits are stored on the Xsolla side and are configured at the individual item level in [Publisher Account](https://publisher.xsolla.com/0/projects/0/storefront/virtual-items) or via the `limits` object in the following API calls:\n* [Create virtual item](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n* [Create game](/fr/api/catalog/game-keys-admin/admin-create-game)\n* [Create virtual currency](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n* [Create virtual currency package](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package)\n* [Create bundle](/fr/api/catalog/bundles-admin/admin-create-bundle)\n\nLimit information is returned in the `items.limits` array in the following API calls for retrieving the items catalog:\n* [Get virtual items list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n* [Get virtual currency list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-currency)\n* [Get virtual currency packages list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-currency-packages)\n* [Get bundles list](/fr/api/catalog/bundles-catalog/get-bundle-list)\n* [Get games list](/fr/api/catalog/game-keys-catalog/get-games-list)\n\nThe API calls in the **Management** subsection of the **Limits** group allow you to retrieve the current state of limits and update them for a specific user — for example, reset the counter after a quest is completed or manually adjust the remaining quantity.\n\n
\n Note

\n For detailed information on configuring limits in the catalog, refer to the Item purchase limits section.\n
\n\n## Limit types\n\nYou can configure the following limit types:\n* [limits.per_item](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item#virtual-items-currency-admin/admin-create-virtual-item/t=request&path=limits/per_item) — a global item purchase limit. Defines the maximum quantity that all users can purchase in total.\n* [limits.per_user](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item#virtual-items-currency-admin/admin-create-virtual-item/t=request&path=limits/per_user) — a purchase limit for a single user:\n * Unauthenticated users always see the maximum quantity of items they can purchase.\n * Authenticated users see the remaining quantity with the active limit applied.\n\nThe following additional settings are available for `limits.per_user`:\n* [limits.recurrent_schedule](/fr/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list#virtual-items-currency-admin/admin-get-virtual-currencies-list/t=response&c=200&path=items/limits/recurrent_schedule) — the scheduled limit reset period: daily, weekly, or monthly.\n* [limits.per_user.limit_exceeded_visibility](/fr/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list#virtual-items-currency-admin/admin-get-virtual-currencies-list/t=response&c=200&path=items/limits/per_user/limit_exceeded_visibility) — whether the item remains visible in the catalog after the purchase limit is reached. Available only when `limits.recurrent_schedule` is configured.\n\n## Limit configuration and enforcement scenario\n\nThe example below describes a scenario for configuring a purchase limit for a specific user. The item is configured with `limit_exceeded_visibility: hide` — once the limit is reached, the item is no longer returned in the API calls for retrieving the catalog until the next scheduled reset.\n\n1. You create items using the API calls from the **Admin** subsection of the [Virtual Items & Currency](/fr/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/fr/api/catalog/bundles-admin/admin-create-bundle), or [Game Keys](/fr/api/catalog/game-keys-admin) groups and pass the `limits` object.\n```json\n{\n \"limits\": {\n \"per_user\": {\n \"total\": 5,\n \"limit_exceeded_visibility\": \"hide\"\n },\n \"recurrent_schedule\": {\n \"per_user\": {\n \"interval_type\": \"weekly\",\n \"time\": \"10:00:00+08:00\",\n \"day_of_week\": 5\n }\n }\n }\n}\n```\n2. You request the catalog for an unauthenticated user — the response returns the maximum quantity of items they can purchase.\n3. The user logs in.\n4. You request the catalog with the user's authorization data — the response returns the remaining quantity of items with the active limit applied.\n5. The user selects an item and makes a purchase.\n6. After successful payment, Xsolla updates the `per_user` value. When `per_user` reaches `0`, the item is no longer returned in the API calls for retrieving the catalog for that user.\n7. You can update the limit using the API calls from the **Management** subsection: [refresh all purchase limits for the user](/fr/api/catalog/user-limits-admin/reset-all-user-items-limit/), [set a specific value](/fr/api/catalog/user-limits-admin/set-user-item-limit/), [increase](/fr/api/catalog/user-limits-admin/add-user-item-limit/), or [decrease the available quantity](/fr/api/catalog/user-limits-admin/remove-user-item-limit/).\n8. You retrieve the updated limit value in `items.limits` on the next catalog request made with the user's authorization data and display it to the user.\n\n![Item limits](https://cdn.xsolla.net/developers/current/images/api_docs/api-item-limits.png)", "name": "limits-overview", "x-displayName": "Overview" }, { "name": "user-limits-admin", "x-displayName": "Gestion" }, { "name": "connector-admin", "x-displayName": "Administrateur" }, { "name": "common-pre-orders", "x-displayName": "Pré-commandes" }, { "name": "common-merchant", "x-displayName": "Commerçant" }, { "description": "Cette API permet de récupérer tout type d'objet vendable ou tout objet spécifique.", "name": "common-catalog", "x-displayName": "Catalogue" }, { "name": "common-regions", "x-displayName": "Régions communes" }, { "name": "attribute-admin", "x-displayName": "Administrateur" }, { "name": "item-groups-admin", "x-displayName": "Administrateur" }, { "name": "item-groups-catalog", "x-displayName": "Catalogue" } ], "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-catalog", "game-keys-entitlement", "game-keys-admin" ] }, { "name": "LOTS", "tags": [ "bundles-admin", "bundles-catalog" ] }, { "name": "PANIER ET PAIEMENT", "tags": [ "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" ] }, { "name": "ATTRIBUTS DE BIEN", "tags": [ "attribute-admin" ] }, { "name": "ITEM GROUPS", "tags": [ "item-groups-admin", "item-groups-catalog" ] } ] }