{ "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": "附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。可用字段`attributes`。", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "additional_fields-query-param": { "description": "附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。", "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。", "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" } }, "country-query-param": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。 请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)和[国家/地区的判断流程](https://developers.xsolla.com/zh/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": "购物车中显示的商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" } }, "external_id-attr-path-param": { "description": "属性外部ID。", "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": "组外部ID。", "in": "path", "name": "external_id", "required": true, "schema": { "default": "armour", "type": "string" } }, "group_id-path-param": { "description": "组ID。", "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。", "in": "path", "name": "item_id", "required": true, "schema": { "example": "656", "type": "string" } }, "item_id_59080-path-param": { "description": "物品ID。", "in": "path", "name": "item_id", "required": true, "schema": { "example": "259774", "type": "string" } }, "item_sku-path-param": { "description": "商品SKU。", "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" } }, "item_sku_59080-path-param": { "description": "物品 SKU。", "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": "页面上元素数量的限制。", "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/zh/doc/shop-builder/references/supported-languages/).", "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" } }, "merchant_id-path-param": { "description": "商户ID。", "in": "path", "name": "merchant_id", "required": true, "schema": { "example": 121212, "type": "integer" } }, "offset-query-param": { "description": "元素编号，从该元素开始生成列表（从0开始数）。", "example": 0, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "minimum": 0, "type": "integer" } }, "order_id-path-param": { "description": "订单ID。", "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" } }, "platform-query-param": { "description": "用户玩游戏的发布平台：`xsolla`（默认）、`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。您可以在您的[发布商帐户](https://publisher.xsolla.com/)项目名称旁边找到。", "in": "path", "name": "project_id", "required": true, "schema": { "example": 59080, "type": "integer" } }, "promo_code-query-param": { "description": "区分大小写的唯一券码。包含字母和数字。", "in": "query", "name": "promo_code", "required": false, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "quantity-query-param": { "description": "密钥数量。", "in": "query", "name": "quantity", "required": true, "schema": { "example": 100, "type": "integer" } }, "reason-query-param": { "description": "收到密钥的原因。", "in": "query", "name": "reason", "required": true, "schema": { "example": "Very important", "type": "string" } }, "region_id-path-param": { "description": "区域ID。项目内的唯一区域标识符。", "in": "path", "name": "region_id", "required": true, "schema": { "example": 42, "type": "integer" } }, "region_id-query-param": { "description": "区域ID。", "in": "query", "name": "region_id", "required": false, "schema": { "default": 1, "type": "integer" } }, "sandbox-query-param": { "description": "应返回何种类型的权利。如果该参数设置为1，则仅返回用户在沙盒模式下收到的权限。如果未传递该参数或设置为0，则仅返回用户在实时模式下收到的权利。", "in": "query", "name": "sandbox", "required": false, "schema": { "default": 0, "type": "integer" } }, "show_inactive_time_limited_items-query-param": { "description": "显示用户不可用的时效性商品。此类商品的有效期尚未开始或已过期。", "in": "query", "name": "show_inactive_time_limited_items", "required": false, "schema": { "default": 0, "example": 1, "type": "integer" } }, "sku-path-param": { "description": "捆绑包SKU。", "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" } }, "user_email-query-param": { "description": "用户电子邮件。", "in": "query", "name": "user_email", "required": true, "schema": { "example": "email@email.com", "type": "string" } }, "user_external_id-query-param": { "description": "用户外部ID", "in": "query", "name": "user_external_id", "required": true, "schema": { "example": "d342dad2-9d59-11e9-a384-42010aa8003f", "type": "string" } }, "value_external_id-path-param": { "description": "属性值外部ID。", "in": "path", "name": "value_external_id", "required": true, "schema": { "example": "value_id", "pattern": "^[-_\\.\\d\\w]+$", "type": "string" } }, "virtual_currency_package_sku-path-param": { "description": "虚拟货币套餐SKU。", "in": "path", "name": "virtual_currency_package_sku", "required": true, "schema": { "example": "crystal-pack", "type": "string" } }, "virtual_currency_sku-path-param": { "description": "虚拟货币SKU。", "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": "可以使用艾克索拉登录管理器用户JWT或[支付中心访问令牌](https://developers.xsolla.com/zh/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": "使用购物车销售游戏时可以使用您自己的用户ID。", "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": "包含捆绑包数据的对象。", "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/zh/", "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/zh/", "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": "为用户配置支付流程和支付UI的设置。", "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": "订单价格货币。每笔订单的三个字母的货币代码[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "type": "string" }, "custom_parameters": { "description": "项目特定参数。", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "响应语言。", "type": "string" }, "sandbox": { "default": false, "description": "在沙盒模式下创建订单。该选项适用于公司用户列表中指定的那些用户。", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "为用户配置支付流程和支付UI的设置。", "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": "订单价格货币。每笔订单的三个字母的货币代码[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "type": "string" }, "custom_parameters": { "description": "项目特定参数。", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "响应语言。", "type": "string" }, "promo_code": { "description": "随支付兑换促销码活动代码。", "type": "string" }, "quantity": { "default": 1, "description": "商品数量。", "minimum": 1, "type": "integer" }, "sandbox": { "default": false, "description": "在沙盒模式下创建订单。该选项适用于公司用户列表中指定的那些用户。", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "为用户配置支付流程和支付UI的设置。", "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": "商品清单。", "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": "商品数量。", "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": "商品所属分组。", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "如果禁用，则无法通过物品库购买和访问商品。", "type": "boolean" }, "is_show_in_store": { "description": "商品可供购买。", "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "游戏附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "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": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "unit_items": { "description": "用于不同DRM的游戏密钥。", "items": { "description": "游戏密钥商品。它代表某个平台（steam、gog 等）上的游戏。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_sku": { "description": "DRM唯一ID。", "example": "steam", "type": "string" }, "groups": { "description": "商品所属分组。", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "is_enabled": { "description": "如果禁用，则无法通过物品库购买和访问商品。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "商品可供购买。", "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Game-key-item-limit" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "pre_order": { "description": "预订设置。", "properties": { "description": { "description": "预订的附加信息，将通过电子邮件发送。", "type": "string" }, "is_enabled": { "description": "如果禁用，则该商品不是预订商品。", "type": "boolean" }, "release_date": { "description": "游戏密钥发行日期按照ISO 8601规定的格式。", "type": "string" } }, "required": [ "release_date", "is_enabled" ], "type": "object" }, "prices": { "description": "以真实货币表示的价格。", "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "RUB", "type": "string" }, "is_default": { "description": "如果未指定以用户货币为单位的价格，则使用默认价格来生成目录。", "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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "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": "包含游戏数据的对象。", "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": "订单创建时间段的开始日期或日期加时间（[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": "订单创建时间段的结束日期或日期加时间（[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": "响应中包含的订单数量限制。", "maximum": 10, "minimum": 1, "nullable": false, "type": "integer" }, "offset": { "default": 0, "description": "订单编号，从该元素开始生成列表（从0开始数）。", "minimum": 0, "nullable": false, "type": "integer" } }, "type": "object" } } }, "description": "订单搜索参数" }, "connector-import-items-body": { "content": { "application/json": { "schema": { "properties": { "connector_external_id": { "description": "指定导入项操作类型的固定值。", "enum": [ "import_items" ], "type": "string" }, "file_url": { "description": "包含JSON格式数据的文件的URL。该文件应托管在具有公共访问权限的存储服务上。您可以在发布商帐户的[商店 > 虚拟物品 > 目录管理 > 导入商品 (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": "已成功接收指定的属性。" }, "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": "包含商品的对象。", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/admin_attribute_response" }, "type": "array" }, "total_count": { "type": "integer" } }, "type": "object" } } }, "description": "已成功接收属性列表。" }, "200-admin-get-region": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions_200-region-model" } } }, "description": "指定区域已成功接收。" }, "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": "包含商品的对象。", "properties": { "regions": { "items": { "$ref": "#/components/schemas/Regions_200-region-short-model" }, "type": "array" } }, "type": "object" } } }, "description": "区域列表已成功接收。" }, "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": "已成功收到用户的购买限制。" }, "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": "是否还有任何附加页面。", "example": true, "type": "boolean" }, "orders": { "description": "订单列表。", "items": { "properties": { "coupons": { "description": "对订单应用的优惠券列表。", "items": { "properties": { "code": { "description": "使用的优惠券代码。唯一且区分大小写的代码。包含字母和数字。", "type": "string" }, "coupon_id": { "description": "优惠券ID，由艾克索拉在创建优惠券促销活动时生成。", "type": "integer" }, "sku": { "description": "优惠券SKU，由艾克索拉在创建优惠券促销活动时生成。", "type": "string" }, "type": { "description": "优惠券类型。", "enum": [ "unique_catalog_offer", "coupon", "promocode" ], "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "date_created": { "description": "订单创建日期或日期加时间代码（[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。", "type": "string" }, "is_free": { "description": "该订单是否免费。", "example": false, "type": "boolean" }, "items": { "description": "商品列表。", "items": { "properties": { "description": { "description": "包含商品信息的对象。", "properties": { "description": { "description": "商品描述。", "type": "string" }, "image_url": { "description": "商品图片URL。", "format": "uri", "type": "string" }, "name": { "description": "商品名称。", "type": "string" } }, "type": [ "object", "null" ] }, "is_bonus": { "description": "该商品是否为奖励。", "example": false, "type": "boolean" }, "is_free": { "default": false, "description": "该商品是否免费。", "example": false, "type": "boolean" }, "item_id": { "description": "商品ID。由艾克索拉在创建商品时生成。", "example": 1, "type": "integer" }, "order_item_id": { "description": "订单中的商品ID。由艾克索拉在订单创建期间生成。", "type": "integer" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "不含折扣的商品价格。", "example": "30", "type": "string" }, "currency": { "description": "虚拟货币的SKU或[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准下的三字母代码。请查看文档详细了解[艾克索拉支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "该货币是否是虚拟货币。", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "quantity": { "description": "商品数量。", "example": 1, "type": "integer" }, "region_id": { "description": "商品可用区域的ID。请参阅[文档](https://developers.xsolla.com/zh/doc/shop-builder/features/regional-restrictions/)了解区域销售限制的更多信息。", "type": [ "integer", "null" ] }, "sku": { "description": "创建商品时指定的商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "elven_shield", "type": "string" }, "tax_category": { "description": "征税类别。", "example": "DG00002", "type": "string" }, "type": { "description": "商品类型。", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point" ], "example": "virtual_good", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "description": "订单创建模式。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "order_id": { "description": "订单ID。", "example": 1, "type": "integer" }, "price": { "description": "订单价格。", "properties": { "amount": { "description": "最终订单价格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "不含折扣的订单价格。", "example": "30", "type": "string" }, "currency": { "description": "虚拟货币的SKU或真实货币按照[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)格式的三字母代码。请查看文档详细了解[艾克索拉支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "该货币是否是虚拟货币。", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "project_id": { "description": "项目ID。您可以在您的[发布商帐户](https://publisher.xsolla.com/)项目名称旁边找到。", "example": 44056, "type": "integer" }, "promotions": { "description": "对订单应用的促销活动列表。", "items": { "properties": { "promotion_id": { "description": "项目内的促销活动ID。", "example": 111425, "type": "integer" } }, "type": "object" }, "type": [ "array", "null" ] }, "status": { "description": "订单状态。", "enum": [ "new", "paid", "done", "canceled", "expired" ], "example": "paid", "type": "string" }, "user": { "properties": { "country": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。 请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)。", "example": "US", "type": "string" }, "email": { "description": "用户电子邮箱，使用符合[RFC 822](https://www.w3.org/Protocols/rfc822/#z8)协议的格式。", "example": "user@xsolla.com", "format": "email", "type": "string" }, "id": { "description": "创建订单时传递的用户ID。", "example": "07e653a2b15011e6818f005056a54369", "type": "string" }, "region_id": { "description": "用户所在区域的ID，设置了区域销售限制时返回。创建订单时传入的用户国家/地区，与[创建区域](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-region/)时指定的国家/地区列表进行匹配，具体请参见[文档](https://developers.xsolla.com/zh/doc/shop-builder/features/regional-restrictions/)了解有关区域销售限制的更多信息。", "example": 12, "type": [ "integer", "null" ] } }, "type": "object" } }, "type": "object" }, "type": "array" }, "total_items_count": { "description": "指定时间段内的订单总数。", "example": 1, "type": "integer" } }, "type": "object" } } }, "description": "成功检索到订单列表。" }, "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": "导入操作完成的时间戳（GMT+3 时区）。如果导入因错误而中断且未导入任何项，则将返回空字符串。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_created": { "description": "创建导入操作的时间戳（GMT+3 时区）。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_updated": { "description": "由于错误而导致导入中断的时间戳（GMT+3 时区）。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "error": { "description": "一般导入错误的描述。", "type": "string" }, "error_code": { "description": "一般导入错误的代码。", "type": "string" }, "progress": { "description": "导入执行的进度（以百分比表示）。", "example": 100, "type": "integer" }, "result": { "description": "包含特定商品SKU的导入结果和导入错误数据的对象。", "properties": { "errors_by_sku": { "description": "包含特定商品SKU的导入错误数据的对象数组。", "items": { "properties": { "error_code": { "description": "特定商品SKU的导入错误代码。", "example": 1001, "type": "integer" }, "error_message": { "description": "特定商品SKU的导入错误描述。", "example": "Something went wrong", "type": "string" }, "sku": { "description": "导入商品的SKU。", "example": "sku_1", "type": "string" }, "type": { "description": "商品类型。", "enum": [ "virtual_good", "virtual_currency", "virtual_currency_packages", "bundle" ], "example": "vi", "type": "string" } }, "type": "object" }, "type": "array" }, "errors_count": { "description": "导入过程中出现错误的商品数。", "example": 3, "type": "integer" }, "total_entities_count": { "description": "导入的商品总数。", "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": "已成功检索导入状态。" }, "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": "已成功创建属性。" }, "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": "已成功创建属性值。" }, "201-admin-create-region": { "content": { "application/json": { "example": { "region_id": 42 }, "schema": { "properties": { "region_id": { "$ref": "#/components/schemas/Regions_region_id" } }, "type": "object" } } }, "description": "区域已成功创建。" }, "204-admin-delete-region": { "content": {}, "description": "区域已成功删除。" }, "204-admin-update-attribute": { "content": {}, "description": "属性已成功更新。" }, "204-admin-update-region": { "content": {}, "description": "区域已成功更新。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "未发送授权标头。" }, "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": "未找到属性。" }, "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": "未找到属性值。" }, "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": "未找到区域。请确保`id`正确无误。" }, "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": "无效的请求。" }, "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": "无效的请求。" }, "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": "指定的捆绑包已成功接收。" }, "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": "包含商品的对象。", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "捆绑包列表已成功接收。" }, "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": "包含商品的对象。", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "捆绑包列表已成功接收。" }, "Bundles_200-get-bundle-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle-list" } }, "schema": { "description": "包含商品的对象。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Bundles_client_bundle" }, "type": "array" } }, "type": "object" } } }, "description": "捆绑包列表已成功接收。" }, "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": "捆绑包已成功创建。" }, "Bundles_204-admin-delete-bundle": { "content": {}, "description": "捆绑已成功删除。" }, "Bundles_204-admin-hide-bundle": { "content": {}, "description": "捆绑已成功隐藏。" }, "Bundles_204-admin-show-bundle": { "content": {}, "description": "捆绑已成功显示。" }, "Bundles_204-admin-update-bundle": { "content": {}, "description": "捆绑包已成功更新。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "无效请求。" }, "Cart-Free_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "type": "integer" } }, "type": "object" } } }, "description": "成功创建免费订单。" }, "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。将其传入购买页面或支付API端点的查询。", "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": "商品价格。", "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": "购物车价格。", "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": "已成功返回含商品的购物车。" }, "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。", "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": "商品价格。", "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": "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": "购物车价格。", "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": "已成功返回含商品的购物车。" }, "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。", "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": "商品价格。", "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": "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": "购物车价格。", "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": "已成功返回含商品的购物车。" }, "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": "订单详细信息。", "properties": { "is_free": { "description": "如果为`true`，则订单是免费的。", "example": false, "type": "boolean" }, "items": { "description": "商品列表。", "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": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "30", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "商品数量。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "some_sku", "type": "string" } }, "type": "object" }, "type": "array" }, "price": { "description": "订单价格。", "properties": { "amount": { "description": "订单折扣价。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "订单价格。", "example": "30", "type": "string" }, "currency": { "description": "订单价格货币。每三个字母的代码[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": "object" }, "virtual_price": { "description": "以虚拟货币表示的订单价格。", "properties": { "amount": { "description": "订单折扣价。", "example": "100", "type": "string" }, "amount_without_discount": { "description": "订单价格。", "example": "150", "type": "string" }, "currency": { "description": "订单中使用的虚拟货币SKU。", "example": "test_vc", "type": "string" } }, "type": "object" } }, "type": "object" }, "order_id": { "default": "Order ID.", "description": "订单ID。", "example": 1, "type": "integer" }, "status": { "description": "订单状态：`new`/`paid`/`done`/`canceled`。", "example": "paid", "type": "string" } }, "type": "object" } } }, "description": "订单请求成功。" }, "Cart-Payment_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "type": "integer" }, "token": { "description": "支付令牌。", "type": "string" } }, "type": "object" } } }, "description": "订单已成功创建。" }, "Cart-Payment_201-admin-create-payment-token": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "example": 1, "type": "integer" }, "token": { "description": "支付令牌。", "type": "string" } }, "type": "object" } } }, "description": "成功创建支付令牌和订单。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "未找到商品或优惠券。请确保使用的数据正确无误。" }, "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": "未找到订单。请确保`project_id`和`order_id`正确无误。" }, "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": "未找到该商品。请确保`project_id`和`item_sku`正确无误。" }, "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": "未找到用户。请确保`x-user-for`或`x-user-id`令牌正确无误。" }, "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": "请求正文和创建购物车验证错误。\n- 无效购物车，根据传入的商品创建。请检查购物车是否为空，并且所有商品非免费商品。\n- 请求正文无效。" }, "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": "此类商品不能放入购物车。请选择其他类型的商品。" }, "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": "无效错误。" }, "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": "购物车无效。请检查购物车是否存在，内容不能为空，并且其中的所有商品均非免费。" }, "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": "商品无效。请检查该商品是否存在、未禁用、未删除且非免费。" }, "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": "商品数量必须是非负整数。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "包含游戏信息的对象。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "商品所属分组。", "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。", "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": "创建商品时提供的内部唯一商品ID。", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "游戏的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "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": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_1", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`unit`。", "example": "unit", "type": "string" }, "unit_items": { "description": "用于不同DRM的游戏密钥。", "items": { "description": "游戏密钥商品。它代表某个平台（steam、gog 等）上的游戏。", "properties": { "drm_id": { "description": "DRM内部唯一ID。", "example": 1, "type": "integer" }, "drm_image": { "description": "游戏密钥DRM图标。", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "游戏密钥DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRM唯一ID。", "example": "steam", "type": "string" }, "is_enabled": { "description": "如果禁用，则无法通过物品库购买和访问商品。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "如果为`true`，则用户已购买游戏密钥。", "type": "boolean" }, "is_show_in_store": { "description": "商品可供购买。", "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "可供购买的密钥数量。", "type": "integer" }, "total": { "description": "上传的密钥总数。", "type": "integer" }, "used": { "description": "已售密钥的数量。", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "order": { "description": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "预订设置。", "properties": { "description": { "description": "预订的附加信息，将通过电子邮件发送。", "type": [ "string", "null" ] }, "is_enabled": { "description": "如果禁用，则该商品不是预订商品。", "type": "boolean" }, "release_date": { "description": "游戏密钥发行日期按照ISO 8601规定的格式。", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "以真实货币表示的价格。", "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": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "RUB", "type": "string" }, "is_default": { "description": "如果未指定以用户货币为单位的价格，则使用默认价格来生成目录。", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_1", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`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": "包含本地化游戏描述的对象。编码按照ISO 3166-1的规定。", "example": { "en": "Game 1 Example" }, "type": "object" }, "image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "包含本地化虚拟货币名称的对象。编码按照ISO 3166-1的规定。", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "gold", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`virtual_currency`。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "成功收到游戏。" }, "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": "包含游戏的对象。", "properties": { "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "商品所属分组。", "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。", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "如果禁用，则无法通过物品库购买和访问商品。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "商品可供购买。", "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "游戏的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "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": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_1", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`unit`。", "example": "unit", "type": "string" }, "unit_items": { "description": "用于不同DRM的游戏密钥。", "items": { "description": "游戏密钥商品。它代表某个平台（steam、gog 等）上的游戏。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_id": { "description": "DRM内部唯一ID。", "example": 1, "type": "integer" }, "drm_image": { "description": "游戏密钥DRM图标。", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "游戏密钥DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRM唯一ID。", "example": "steam", "type": "string" }, "groups": { "description": "商品所属分组。", "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": "如果禁用，则无法通过物品库购买和访问商品。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "如果为`true`，则用户已购买游戏密钥。", "type": "boolean" }, "is_show_in_store": { "description": "商品可供购买。", "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "可供购买的密钥数量。", "type": "integer" }, "total": { "description": "上传的密钥总数。", "type": "integer" }, "used": { "description": "已售密钥的数量。", "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": "列表中的游戏顺序优先级。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "预订设置。", "properties": { "description": { "description": "预订的附加信息，将通过电子邮件发送。", "type": [ "string", "null" ] }, "is_enabled": { "description": "如果禁用，则该商品不是预订商品。", "type": "boolean" }, "release_date": { "description": "游戏密钥发行日期按照ISO 8601规定的格式。", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "以真实货币表示的价格。", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "description": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "RUB", "type": "string" }, "is_default": { "description": "如果未指定以用户货币为单位的价格，则使用默认价格来生成目录。", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_1", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`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": "包含本地化游戏描述的对象。编码按照ISO 3166-1的规定。", "example": { "en": "Game 1 Example" }, "type": [ "object", "null" ] }, "image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "包含本地化虚拟货币名称的对象。编码按照ISO 3166-1的规定。", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "gold", "type": "string" }, "type": { "description": "商品类型。此情况下始终为`virtual_currency`。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "游戏列表已成功接收。" }, "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": "密钥已成功接收。" }, "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": "包含游戏的对象。", "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": "DRM ID。", "example": 1, "type": "number" }, "image": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "兑换链接。", "example": "https://support.us.playstation.com", "type": [ "string", "null" ] }, "name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "兑换说明链接。", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "已成功接收DRM列表。" }, "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": "包含游戏的对象。", "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": "商品描述。", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "如果为`true`，则游戏密钥有供销售的密钥。", "example": false, "type": "boolean" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。", "example": true, "type": "boolean" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" } }, "type": "object" }, "release_date": { "description": "游戏密钥发行日期按照ISO 8601规定的格式。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "已成功接收游戏密钥列表。" }, "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": "包含游戏的对象。", "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": "商品描述。", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`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": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "has_keys": { "description": "如果为`true`，则游戏密钥有供销售的密钥。", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。", "example": true, "type": "boolean" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[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": "游戏密钥发行日期按照ISO 8601规定的格式。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "单位类型：`game`。", "example": "game", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "游戏列表已成功接收。" }, "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": "已成功接收密钥加载会话信息。" }, "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": "包含游戏信息的对象。", "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": "已成功接收用户拥有的游戏密钥的列表。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "未发送授权标头。" }, "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": "无效请求。" }, "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": "已成功收到指定的虚拟物品。" }, "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": "成功收到虚拟货币列表。" }, "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": "指定的虚拟货币已成功接收。" }, "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": "指定的虚拟货币套餐已成功接收。" }, "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": "已成功收到虚拟货币套餐列表。" }, "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": "已成功收到虚拟物品列表。" }, "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": "已成功收到虚拟物品列表。" }, "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": "含虚拟物品的对象。", "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": "商品描述。", "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": "商品名称。", "example": "Big Rocket", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "com.xsolla.big_rocket_1", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "已成功接收所有虚拟物品列表。" }, "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": "已成功接收虚拟物品。" }, "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": "商品描述。", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "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": "商品名称。", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "来自指定组的商品列表已成功接收。" }, "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": "子组。", "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": "子组。", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "properties": { "children": { "description": "子组。", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "组描述。", "example": "Accessory", "type": "string" }, "external_id": { "description": "外部组ID。", "example": "accessory", "type": "string" }, "image_url": { "description": "图像URL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "组嵌套层级。", "example": 2, "type": "integer" }, "name": { "description": "组名称。", "example": "Accessory", "type": "string" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "父外部组ID。", "example": "background", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "组描述。", "example": "Background description", "type": "string" }, "external_id": { "description": "外部组ID。", "example": "background", "type": "string" }, "image_url": { "description": "组图片URL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "组嵌套层级。", "example": 1, "type": "integer" }, "name": { "description": "组名称。", "example": "Background", "type": "string" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "父外部组ID。", "example": "weapons", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "组描述。", "example": "All weapons available in the game", "type": "string" }, "external_id": { "description": "外部组ID。", "example": "weapons", "type": "string" }, "image_url": { "description": "图像URL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "组嵌套层级。", "example": 0, "type": "integer" }, "name": { "description": "组名称。", "example": "Weapons", "type": "string" }, "order": { "description": "定义排列顺序。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "父外部组ID。", "example": null, "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "已成功接收组列表。" }, "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": "已成功收到虚拟物品列表。" }, "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": "已成功收到虚拟货币。" }, "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": "虚拟货币列表已成功接收。" }, "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": "已成功接收虚拟货币套餐。" }, "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": "已成功收到虚拟货币套餐列表。" }, "Virtual-Items-Currency_200-quick-purchase": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "订单ID。", "type": "integer" } }, "type": "object" } } }, "description": "快速虚拟购买成功。" }, "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": "虚拟物品已成功创建。" }, "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": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "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": "未找到该商品。请确保`project_id`和`item_sku`正确无误。" }, "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": "未找到该组。确保`external_id`正确并且该组没有被关闭或删除。" }, "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": "无效请求。" }, "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": "虚拟货币不足。" }, "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": "由于请求正文、文件属性或文件内容的参数不正确而导致的验证错误。" }, "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": "未找到商品。请确保`project_id`和`item_id`正确无误。" }, "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": "未找到商品。请确保`project_id`和`sku`正确无误。" }, "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": "包含可售商品的对象。", "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "如为`true`，则用户可以购买商品。", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "商品描述。", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "商品名称。", "example": "Electric shield", "type": "string" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品价格货币。每[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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "electric_shield", "type": "string" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "虚拟货币说明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "虚拟货币图像。", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "name": { "description": "虚拟货币名称。", "example": "Gold", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "gold", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" } } }, "description": "已成功接收可售商品。" }, "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": "如为`true`，则用户可以购买商品。", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "商品描述。", "example": "Electric shield", "type": [ "string", "null" ] }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "商品名称。", "example": "Electric shield", "type": "string" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品价格货币。每[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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "com.xsolla.electric_shield_1", "type": "string" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "虚拟货币说明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "name": { "description": "虚拟货币名称。", "example": "Gold", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "已成功接收指定组的可售商品列表。" }, "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": "包含可售商品的对象。", "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": "捆绑类型。商品类型是捆绑包时返回。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "can_be_bought": { "description": "如为`true`，则用户可以购买商品。", "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": "商品描述。", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "商品名称。", "example": "Electric shield", "type": "string" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品价格货币。每[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。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "com.xsolla.electric_shield_1", "type": "string" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "虚拟货币说明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "虚拟货币图像。", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "item_id": { "description": "创建商品时提供的内部唯一商品ID。", "example": 259774, "type": "integer" }, "name": { "description": "虚拟货币名称。", "example": "Gold", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "已成功接收可售商品列表。" } }, "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": "错误代码。", "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": "错误代码。", "example": 1102, "type": "number" }, "errorMessage": { "description": "可读的错误消息。", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "description": "响应状态码。", "example": 422, "type": "number" }, "transactionId": { "description": "请求的唯一ID。", "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": "属性列表。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Bundles_admin-post-put-attributes": { "description": "属性列表。\n
注意：为每个商品指定的属性不能超过20个。任何超出限制的尝试都会导致错误。
", "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": "指定的捆绑包。", "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": "指定的捆绑包。", "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": "所选商品在捆绑包中的数量。", "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": "商品类型在捆绑包中的数量。", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_type" } }, "type": "object" }, "Bundles_amount": { "description": "折扣后的商品价格。", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_amount_without_discount": { "description": "商品价格。", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_bundle_type": { "default": "standard", "description": "捆绑包类型。使用`standard`创建包含商品的捆绑包，并指定捆绑包中所含商品的SKU。\n使用`partner_side_content`创建一个空的捆绑包，并使用[Webhook](https://developers.xsolla.com/zh/webhooks/operation/personalized-partner-catalog/)在己侧添加商品。此类型仅用于[合作伙伴侧的目录个性化](https://developers.xsolla.com/zh/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side)。", "enum": [ "standard", "partner_side_content" ], "example": "standard", "type": "string" }, "Bundles_client-attributes": { "default": [], "description": "与商品对应的属性及其值的列表。可用于目录筛选。", "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": "属性名称。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_bundle": { "description": "指定的捆绑包。", "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": "捆绑包套餐内容。", "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": "套餐中的商品。", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "description": { "description": "商品描述。", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "description": "图像URL。", "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": "商品名称。", "example": "Big Rocket", "type": "string" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "quantity": { "description": "套餐中的商品数量。", "example": 250, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、破折号和下划线。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "以虚拟货币表示的折扣后商品价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "价格是否为商品的默认价格。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_description": { "description": "商品描述。", "example": "Big Rocket - description.", "type": [ "string", "null" ] }, "Bundles_client_name": { "description": "商品名称。", "example": "Big Rocket", "type": "string" }, "Bundles_currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。", "example": "USD", "type": "string" }, "Bundles_currency-is_default": { "description": "价格是否为商品的默认价格。", "example": true, "type": "boolean" }, "Bundles_groups_request": { "default": [], "description": "商品所属的组。\n
注：字符串值引用组`external_id`。
", "example": [ "honor" ], "items": { "type": "string" }, "type": "array" }, "Bundles_groups_response": { "default": [], "description": "商品所属分组。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}\"格式的区域设置，值是字符串。", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Bundles_image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": [ "string", "null" ] }, "Bundles_is_enabled": { "default": true, "description": "如果禁用，则无法找到和购买该商品。", "example": true, "type": "boolean" }, "Bundles_is_show_in_store": { "default": false, "description": "商品可供购买。", "example": true, "type": "boolean" }, "Bundles_item_id": { "description": "内部唯一物品ID。", "example": 1, "maxLength": 255, "minLength": 1, "type": "integer" }, "Bundles_media_list": { "description": "捆绑包的附加资源。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Bundles_order": { "default": 1, "description": "列表中的捆绑包顺序优先级。", "example": 1, "type": "integer" }, "Bundles_price": { "description": "商品价格。", "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": "以真实货币表示的价格。", "items": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "country_iso": { "description": "适用此价格的国家/地区。符合[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": "如果未指定用户货币下的价格，则使用默认价格来生成目录。", "type": "boolean" }, "is_enabled": { "description": "价格已启用。", "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "bundle_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Bundles_total_content_price": { "description": "捆绑包内容价格总和。", "properties": { "amount": { "description": "折扣后的捆绑包内容价格总和。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "捆绑包内容价格总和。", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "type": [ "object", "null" ] }, "Bundles_type": { "description": "商品类型。", "example": "bundle", "type": "string" }, "Bundles_vc-type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" }, "Bundles_vc_prices": { "items": { "properties": { "amount": { "type": "integer" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "以虚拟货币表示的折扣后商品价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "以虚拟货币表示的商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Most popular gold", "type": [ "string", "null" ] }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": [ "string", "null" ] }, "is_default": { "description": "价格是否为商品的默认价格。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "Gold", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "gold", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "Can_be_bought": { "description": "如为`true`，则用户可以购买商品。", "example": true, "type": "boolean" }, "Cart": { "additionalProperties": false, "properties": { "country": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。 请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)。
示例：`country=US`", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "currency": { "description": "购物车中显示的商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "items": { "items": { "properties": { "quantity": { "description": "商品的数量。", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "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": "用户年龄。", "type": "integer" }, "country": { "properties": { "allow_modify": { "default": false, "description": "用户是否可以在支付UI中更改国家/地区。", "example": false, "type": "boolean" }, "value": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。如未在`X-User-Ip`头中传入IP地址，则此属性为必需。请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)。
示例：`country=US`", "example": "US", "type": "string" } }, "type": "object" }, "email": { "properties": { "value": { "description": "用户邮箱。必须符合RFC 822协议。", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "type": "object" }, "id": { "properties": { "value": { "description": "用户身份。对于测试，您可以传递任意。如要接受真实付款，需使用您系统中的用户ID值。该ID在[用户验证](https://developers.xsolla.com/zh/webhooks/operation/user-validation/)Webhook中传递。", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "is_legal": { "description": "用户是否为法律实体。", "type": "boolean" }, "legal": { "description": "包含法律实体详细信息的对象。如果`user.is_legal`为`true`，则对象及其所有参数为必需。", "properties": { "address": { "description": "完整法定地址。", "type": "string" }, "country": { "description": "公司所在国家/地区。参照[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准的两个大写字母表示的国家/地区代码。", "type": "string" }, "name": { "description": "完整法定名称。", "type": "string" }, "vat_id": { "description": "个人纳税人识别号。", "type": "string" } }, "type": "object" }, "name": { "properties": { "value": { "description": "用户昵称。", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "phone": { "properties": { "allow_modify": { "default": false, "description": "用户是否可以在支付UI中更改手机号。如果令牌中传入了`phone.value`值，则值默认为`false`。", "example": false, "type": "boolean" }, "hidden": { "default": true, "example": false, "type": "boolean" }, "value": { "description": "用户手机号码。", "type": "string" } }, "required": [ "value" ], "type": "object" }, "steam_id": { "properties": { "value": { "description": "Steam ID。", "maxLength": 17, "minLength": 17, "pattern": "^\\d{17}$", "type": "string" } }, "required": [ "value" ], "type": "object" }, "tracking_id": { "properties": { "value": { "description": "唯一的跟踪ID（用于营销活动）。", "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": "与商品对应的属性及其值的列表。可用于目录筛选。", "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": "属性名称。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "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": "自定义参数的形式是一组有效的JSON键值对。
\n您可以通过此字段传入补充参数来配置反欺诈筛选条件。 [请参阅支付中心文档](https://developers.xsolla.com/zh/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": "自定义参数的形式是一组有效的JSON键值对。
\n您可以通过此字段传入补充参数来配置反欺诈筛选条件。 [请参阅支付中心文档](https://developers.xsolla.com/zh/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": "经过指定延迟时间后自动将用户重定向到返回URL。", "example": 0, "type": "integer" }, "redirect_button_caption": { "description": "本地化的重定向按钮文字。", "example": "Text button", "type": "string" }, "redirect_conditions": { "description": "触发将用户重定向到返回URL的支付状态。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" }, "status_for_manual_redirection": { "description": "触发显示重定向按钮的支付状态，用户单击该按钮后将被重定向到返回URL。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" } }, "type": "object" }, "Cart-Payment_settings_currency": { "description": "首选购买货币。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准下的三个字母的货币代码。请查看文档详细了解[艾克索拉支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "type": "string" }, "Cart-Payment_settings_external_id": { "description": "交易外部ID。", "maxLength": 255, "minLength": 1, "type": "string" }, "Cart-Payment_settings_locale": { "description": "界面语言。2字母（小写字母）[语言代码](https://developers.xsolla.com/zh/doc/pay-station/features/localization/)。", "type": "string" }, "Cart-Payment_settings_payment_method": { "description": "支付方式ID，它决定支付界面显示的货币，因为有些支付方式可能只支持某些特定的货币。", "minimum": 1, "type": "integer" }, "Cart-Payment_settings_return_url": { "description": "用户会在支付过后被重定向到此页面。参数`user_id`、`foreigninvoice`、`invoice_id`和`status`会被自动添加到此链接。", "format": "uri", "maxLength": 1000, "type": "string" }, "Cart-Payment_settings_sandbox": { "default": false, "description": "设置为`true`以测试付款流程。在这种情况下，请使用https://sandbox-secure.xsolla.com访问测试支付UI。", "type": "boolean" }, "Cart-Payment_settings_ui": { "additionalProperties": false, "description": "界面设置。", "properties": { "currency_format": { "description": "设置为`code`以在支付UI中显示三字母的[ISO 4217](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)货币代码。默认显示货币符号而不是三字母货币代码。", "type": "string" }, "desktop": { "additionalProperties": false, "description": "桌面版本的界面设置。", "properties": { "header": { "additionalProperties": false, "description": "页眉设置。", "properties": { "close_button": { "default": false, "description": "是否在桌面支付UI中显示**关闭**按钮。该按钮将关闭支付UI并将用户重定向到`settings.return_url`参数中指定的URL。默认为`false`。", "type": "boolean" }, "is_visible": { "description": "页眉在支付UI上是否可见。", "type": "boolean" }, "type": { "default": "normal", "description": "如何显示页眉。不能为`compact`（隐藏项目名称和用户ID）或`normal`（默认）。", "enum": [ "compact", "normal" ], "type": "string" }, "visible_logo": { "description": "如果`true`，徽标将显示在标题中。要上传图像，请在[发布者帐户](https://publisher.xsolla.com/)然后转到付款站 > 设置部分。", "type": "boolean" }, "visible_name": { "description": "页眉中是否显示项目名称。", "type": "boolean" }, "visible_purchase": { "default": true, "description": "是否在页眉中显示购买描述（`purchase.description.value`）。默认为`true`。", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "header": { "properties": { "visible_virtual_currency_balance": { "additionalProperties": false, "default": true, "description": "此元素是否可在支付UI上隐藏。", "type": "boolean" } }, "type": "object" }, "is_cart_open_by_default": { "default": false, "description": "打开支付UI移动版本时购物车商品列表的显示方式。如为`true`，列表以扩展视图显示。如为`false`（默认）或未传入此参数，列表以折叠视图显示。", "type": "boolean" }, "is_independent_windows": { "default": false, "description": "是否将用户从嵌入式启动器浏览器(WebView)跳转到其默认的浏览器来进行购买。", "type": "boolean" }, "is_payment_methods_list_mode": { "default": false, "description": "打开支付UI时是否显示在该用户所在国家/地区可用的支付方式。如为`false`（默认），将显示在`settings.payment_method`参数中传入的支付方式或[PayRank算法](https://developers.xsolla.com/zh/solutions/payments/payment-ui-management/top-payment-methods-management/)选择的支付方式。", "type": "boolean" }, "is_prevent_external_link_open": { "default": false, "description": "是否禁用将链接重定向至外部资源。点击外部链接时，将通过`postMessage`机制发送`external-link-open`事件。重定向链接的地址在`url`参数中传递。", "type": "boolean" }, "is_show_close_widget_warning": { "default": true, "description": "关闭支付页面前鼠标悬停在**×**图标时是否显示交易正在处理中的警告。如传入`false`，或未传入参数，则不显示警告。", "type": "boolean" }, "is_three_ds_independent_windows": { "default": false, "description": "是否在新浏览器窗口中打开3-D Secure检查。如果您的设置强制执行内容安全政策(CSP)，请设置为`true`。", "type": "boolean" }, "layout": { "description": "支付UI主要元素的位置。您可以在游戏内打开支付UI和/或交换订单信息和支付方式信息列的位置。详细信息请参阅[自定义说明](https://developers.xsolla.com/zh/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout)。", "enum": [ "embed", "column_reverse", "embed_column_reverse" ], "type": "string" }, "mobile": { "properties": { "header": { "additionalProperties": false, "properties": { "close_button": { "default": false, "description": "是否在移动支付UI中显示**关闭**按钮。该按钮将关闭支付UI并将用户重定向到`settings.return_url`参数中指定的URL。", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "mode": { "description": "支付UI的界面模式。只能是`user_account`。请注意，页眉仅包含用户帐户的导航菜单，而没有用于选择产品或进行付款的任何选项。“用户帐户”仅在桌面模式下可用。", "enum": [ "user_account" ], "type": "string" }, "theme": { "default": "63295a9a2e47fab76f7708e1", "description": "支付UI主题。可以是`63295a9a2e47fab76f7708e1`（浅色主题（默认）），或`63295aab2e47fab76f7708e3`（深色主题）。您也可以[创建自定义主题](https://developers.xsolla.com/zh/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)，然后在此参数中传入其ID。", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ], "type": "string" }, "user_account": { "additionalProperties": false, "description": "用户帐户详细信息。", "properties": { "info": { "additionalProperties": false, "description": "**我的账户**页面。", "properties": { "enable": { "default": false, "description": "是否显示子菜单。默认为`false`。", "type": "boolean" }, "order": { "description": "子菜单在菜单中的位置。", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" }, "payment_accounts": { "additionalProperties": false, "description": "**我的支付帐户**子菜单。", "properties": { "enable": { "default": false, "description": "是否显示子菜单。默认为`false`。", "type": "boolean" } }, "required": [ "enable" ], "type": "object" }, "subscriptions": { "additionalProperties": false, "description": "**管理订阅**子菜单。", "properties": { "enable": { "default": false, "description": "是否显示子菜单。默认为`false`。", "type": "boolean" }, "order": { "description": "子菜单在菜单中的位置。", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "Cart_admin_payment": { "additionalProperties": false, "properties": { "items": { "items": { "properties": { "quantity": { "description": "商品的数量。", "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": "应用于整个购物车的促销活动。仅在以下情况下返回该数组：\n\n* 促销活动影响购物车总金额，例如使用了**对购买项提供折扣设置**的促销码。\n\n* 促销活动为购物车添加了赠品。\n\n如果未应用任何订单级促销，则返回空数组。", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "奖励捆绑包商品类型。仅适用于`bundle`奖励品类型。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "奖励商品图片URL。不适用于`physical_good`奖励品类型。", "type": "string" }, "name": { "description": "奖励品名称。不适用于`physical_good`奖励品类型。", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "奖励品类型。", "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": "商品限制。", "properties": { "per_item": { "description": "商品的购买限制。", "properties": { "available": { "description": "所有用户可购买的剩余商品数量。", "example": 3, "type": "integer" }, "total": { "description": "所有用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "一个用户的购买数量限制。", "properties": { "available": { "description": "当前用户可购买的剩余商品数量。", "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": "单个用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_limits_with_hourly": { "description": "商品限制。", "properties": { "per_item": { "description": "商品的购买限制。", "properties": { "available": { "description": "所有用户可购买的剩余商品数量。", "example": 3, "type": "integer" }, "total": { "description": "所有用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "用户的购买限制。", "properties": { "available": { "description": "当前用户可购买的剩余商品数量。", "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": "单个用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_promotions": { "description": "应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：\n\n* 为某商品配置了折扣促销活动。\n\n* 应用了**对所选商品提供折扣**设置的促销码。\n\n如果未应用任何商品级促销活动，则返回空数组。", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "奖励捆绑包商品类型。仅适用于`bundle`奖励品类型。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "奖励商品图片URL。不适用于`physical_good`奖励品类型。", "type": "string" }, "name": { "description": "奖励品名称。不适用于`physical_good`奖励品类型。", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "奖励品类型。", "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。", "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。 `external_id`只能包含大小写英文字母和数字字符、破折号和下划线。", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Game-Keys_admin-attributes": { "description": "属性列表。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Game-Keys_admin-post-put-attributes": { "description": "属性列表。\n
注意：为每个商品指定的属性不能超过20个。任何超出限制的尝试都会导致错误。
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Game-Keys_client-attributes": { "default": [], "description": "游戏对应的属性及属性值列表。\n\n
注意：这部分响应仅在您发送`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": "属性名称。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_value-external_id" }, "value": { "description": "属性值。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_client_name": { "description": "游戏套餐名称。", "example": "The Greatest Game in the World", "type": "string" }, "Game-Keys_description": { "description": "游戏套餐描述。", "example": "Description of the greatest game in the world.", "type": "string" }, "Game-Keys_drm_sku": { "description": "唯一DRM ID。", "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": "游戏是否处于预订状态。", "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。", "example": "theGreatestGameSku", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Game-Keys_image_url": { "description": "图像URL。", "example": "https://none", "type": "string" }, "Game-Keys_project_id": { "description": "项目ID。您可以在您的[发布商帐户](https://publisher.xsolla.com/)项目名称旁边找到。", "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": "与商品对应的属性及其值的列表。可用于目录筛选。", "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": "属性名称。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_value-external_id": { "description": "属性的唯一值ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Game-key-item-limit": { "description": "商品限制。", "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": "用作指示还有更多页面。", "example": true, "type": "boolean" }, "Pagination_total-items-count": { "description": "系统中的商品总数。", "example": 10, "type": "integer" }, "Promotions_coupon_code": { "default": "WINTER2021", "description": "区分大小写的唯一券码。包含字母和数字。", "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": "要添加到区域的国家/地区列表。\n
[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。 \n请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)。\n
示例：`[\"JP\", \"CN\", \"VN\"]`", "items": { "type": "string" }, "type": "array" }, "Regions_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Asien", "en-US": "Asia" }, "description": "区域名称。应该包含键/值对，其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域位置，值是字符串。", "example": { "de-DE": "Asien", "en-US": "Asia" }, "type": "object" }, "Regions_region_id": { "description": "区域ID。项目内的唯一区域标识符。", "example": 42, "type": "integer" }, "User-limit-item": { "properties": { "per_user": { "properties": { "available": { "description": "用户可以购买的剩余商品数量。", "example": 9, "type": "integer" }, "total": { "description": "用户可以购买的最大商品数量。", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit_available": { "description": "在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。", "minimum": 1, "type": "integer" }, "User-limit_available_flexible": { "description": "在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。", "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": "用户外部ID。", "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": "商品限制。", "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": "商品限制。", "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": "商品限制。", "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": "属性列表。" } ] }, "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": "以虚拟货币表示的商品价格。", "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": "虚拟货币套餐应仅包含1个对象，即虚拟货币。", "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": "金额。", "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](/zh/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": "商品所属分组。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}\"格式的区域设置，值是字符串。", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-image_url": { "description": "图像URL。", "type": "string" }, "Virtual-Items-Currency_admin-media_list": { "description": "商品的附加资源，例如屏幕截图、游戏视频等。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "媒体类型：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "资源文件。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-post-put-attributes": { "description": "属性列表。\n
注意：为每个商品指定的属性不能超过20个。任何超出限制的尝试都会导致错误。
", "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": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/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/zh/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/zh/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/zh/items-catalog/catalog-features/regional-restrictions/) and [region management API calls](https://developers.xsolla.com/zh/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": "与商品对应的属性及其值的列表。可用于目录筛选。", "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": "属性名称。", "example": "Genre", "type": "object" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "description": "属性值。", "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/zh/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/zh/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": "商品描述。", "example": "Big Rocket - description", "type": "object" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "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。", "type": "number" }, "limits": { "$ref": "#/components/schemas/client-item-limit-response" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "商品名称。", "example": "Big Rocket", "type": "object" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "big_rocket", "type": "string" }, "type": { "description": "商品类型：`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": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "属性列表。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Virtual-Items-Currency_schemas-admin-image_url": { "description": "图像URL。", "example": "https://image.example.com", "type": "string" }, "Virtual-Items-Currency_schemas-sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "bundle_1", "type": "string" }, "Virtual-Items-Currency_sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Virtual-Items-Currency_type": { "description": "商品类型：`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": "商品描述。", "example": "Crystals - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "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": "商品名称。", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "big_rocket", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "com.xsolla.crystals_1" } ], "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Crystals - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "Crystals", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "捆绑包类型：`standard`/`virtual_currency_package`。", "example": "virtual_currency_package", "type": "string" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "description": "虚拟货币套餐内容。", "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": "套餐中的虚拟货币。", "properties": { "description": { "description": "商品描述。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "图像URL。", "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": "商品名称。", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "套餐中的虚拟货币数量。", "example": 250, "type": "integer" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、破折号和下划线。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "商品类型：`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": "商品描述。", "example": "Crystal Pack Description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "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": "商品名称。", "example": "Crystal Pack", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "crystal-pack", "type": "string" }, "type": { "description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "金额。", "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准下的两个大写字母的国家/地区代码。 请查看文档详细了解[艾克索拉支持的国家/地区](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-countries/)。
示例：`country=US`", "example": "US", "type": "string" }, "currency": { "description": "商品价格货币。每[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)。请查看文档以获取有关[Xsolla 支持的货币](https://developers.xsolla.com/zh/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。 `external_id`只能包含大小写英文字母和数字字符、破折号和下划线。", "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": "包含本地化属性名称的对象。编码按照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": "商品限制。", "properties": { "per_item": { "description": "全局商品限制。", "properties": { "available": { "description": "所有用户可购买的剩余商品数量。", "type": "integer" }, "reserved": { "type": "integer" }, "sold": { "type": "integer" }, "total": { "description": "所有用户可购买的最大商品数量。", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "用于单独用户的商品限制。", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "单个用户可购买的最大商品数量。", "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": "
注意：为每个属性创建的值不能超过6个。任何超出限制的尝试都会导致错误。
", "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": "限制次数刷新周期。", "properties": { "per_user": { "description": "用户限制刷新周期。", "oneOf": [ { "description": "每天类型的用户限制次数刷新。", "properties": { "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = daily", "type": "object" }, { "description": "每周类型的用户限制次数刷新。", "properties": { "day_of_week": { "description": "在一周中的哪一天刷新限制次数。其中1是星期一，7是星期日。仅针对`weekly`限制刷新周期类型不为`null`。", "maximum": 7, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "每月类型的用户限制次数刷新。", "properties": { "day_of_month": { "description": "在一个月中的哪一天刷新限制次数。如果由于较短的月没有选择具体哪一天，刷新将在该月的最后一天发生。仅针对`monthly`限制刷新周期类型不为`null`。", "maximum": 31, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行用户限制数重置。", "properties": { "displayable_reset_next_date": { "description": "应重置限制次数的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "第一次限制次数刷新的日期和时间 (ISO 8601)。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "hours_interval": { "description": "限制更新的小时间隔。

计时从商品首次在商店中显示的时刻开始，即date_from参数中指定的时间。

例如，若`date_from = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则该商品的购买限制将从\"2025-11-15T20:15:00+05:00\"开始每2小时刷新一次。", "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type": { "description": "循环刷新周期类型。", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "限制次数刷新的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = hourly", "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": "商品限制。", "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": "限制次数刷新周期。", "properties": { "per_user": { "description": "按指定小时间隔执行购买限制数重置。", "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": "捆绑类型。商品类型是捆绑包时返回。", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ], "type": "string" }, "catalog_recurrent_schedule_client_response": { "description": "用户的商品限制循环刷新周期。", "oneOf": [ { "description": "每天类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = daily", "type": "object" }, { "description": "每周类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = weekly", "type": "object" }, { "description": "每月类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = monthly", "type": "object" }, { "description": "按指定小时间隔执行用户限制数重置。", "properties": { "interval_type": { "description": "循环刷新周期类型。", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "重置限制次数的日期和时间（Unix时间戳）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = hourly", "type": "object" } ], "type": [ "object", "null" ] }, "client-item-limit-response": { "description": "商品限制。", "properties": { "per_item": { "description": "全局商品限制。", "properties": { "available": { "description": "所有用户可购买的剩余商品数量。", "type": "integer" }, "total": { "description": "所有用户可购买的最大商品数量。", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "用于单独用户的商品限制。", "properties": { "available": { "description": "当前用户可购买的剩余商品数量。", "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "单个用户可购买的最大商品数量。", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "client-item-value-point-reward": { "description": "奖励积分商品奖励。", "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": "包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "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": "错误代码。", "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": "五个字符的区域设置代码。", "properties": { "ar-AE": { "description": "阿拉伯语", "type": [ "string", "null" ] }, "bg-BG": { "description": "保加利亚语", "type": [ "string", "null" ] }, "cs-CZ": { "description": "捷克语", "type": [ "string", "null" ] }, "de-DE": { "description": "德语", "type": [ "string", "null" ] }, "en-US": { "description": "英语", "type": [ "string", "null" ] }, "es-ES": { "description": "西班牙语（西班牙）", "type": [ "string", "null" ] }, "fr-FR": { "description": "法语", "type": [ "string", "null" ] }, "he-IL": { "description": "希伯来语", "type": [ "string", "null" ] }, "id-ID": { "description": "印度尼西亚语", "type": [ "string", "null" ] }, "it-IT": { "description": "意大利语", "type": [ "string", "null" ] }, "ja-JP": { "description": "日语", "type": [ "string", "null" ] }, "km-KH": { "description": "高棉语", "type": [ "string", "null" ] }, "ko-KR": { "description": "韩语", "type": [ "string", "null" ] }, "lo-LA": { "description": "老挝语", "type": [ "string", "null" ] }, "my-MM": { "description": "缅甸语", "type": [ "string", "null" ] }, "ne-NP": { "description": "尼泊尔语", "type": [ "string", "null" ] }, "ph-PH": { "description": "菲律宾语", "type": [ "string", "null" ] }, "pl-PL": { "description": "波兰语", "type": [ "string", "null" ] }, "pt-BR": { "description": "葡萄牙语（巴西）", "type": [ "string", "null" ] }, "ro-RO": { "description": "罗马尼亚语", "type": [ "string", "null" ] }, "ru-RU": { "description": "俄语", "type": [ "string", "null" ] }, "th-TH": { "description": "泰语", "type": [ "string", "null" ] }, "tr-TR": { "description": "土耳其语", "type": [ "string", "null" ] }, "vi-VN": { "description": "越南语", "type": [ "string", "null" ] }, "zh-CN": { "description": "中文（简体）", "type": [ "string", "null" ] }, "zh-TW": { "description": "中文（繁体）", "type": [ "string", "null" ] } }, "title": "five-letter", "type": [ "object", "null" ] }, "game_key_recurrent_schedule": { "description": "限制次数刷新周期。", "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](/zh/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](/zh/doc/shop-builder/references/supported-languages/).", "type": [ "object", "null" ] }, "hours_interval": { "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type_hourly": { "description": "循环刷新周期。", "enum": [ "hourly" ], "type": "string" }, "is_clan": { "description": "该奖励积分是否用于公会奖励链。", "example": true, "type": "boolean" }, "item-custom-attributes": { "description": "包含商品属性和值的JSON对象。属性允许您向商品添加更多信息，例如玩家使用该商品所需的等级。属性可丰富游戏的内部逻辑，并且可以通过专用的GET方法和webhook进行访问。", "format": "json", "maxLength": 500, "type": "object" }, "item-custom-attributes-response": { "description": "包含商品属性和值的JSON对象。", "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](/zh/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": "商品促销时间段。", "items": { "properties": { "date_from": { "description": "指定商品促销开始的日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "date_until": { "description": "指定商品停止促销的日期。可以为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "item-periods-response": { "description": "商品促销时间段。", "items": { "properties": { "date_from": { "description": "指定商品促销开始的日期。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] }, "date_until": { "description": "指定商品停止促销的日期。可以为`null`。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "item_id": { "description": "内部唯一物品ID。", "example": 1, "type": "integer" }, "items_client_groups_response": { "default": [], "description": "商品所属分组。", "example": [ { "external_id": "exclusive", "name": "Exclusive" } ], "items": { "properties": { "external_id": { "description": "组的唯一标识符，通常用于在API请求或外部系统中引用该组。", "example": "exclusive", "type": "string" }, "item_order_in_group": { "description": "商品在组中的位置，用于确定其显示顺序。\n仅当通过additional_fields[]查询参数方式请求时，响应中才包含此字段。", "example": 1, "type": "integer" }, "name": { "description": "组名称。", "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": "全局商品限制。", "example": 10, "type": [ "integer", "null" ] }, "limit_per_user": { "anyOf": [ { "description": "No per-user item purchase limit.", "type": "null" }, { "description": "单个用户可购买的最大商品数量。", "example": 5, "type": "integer" }, { "description": "购买限制的详细配置。", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "单个用户可购买的最大商品数量。", "example": 5, "type": "integer" } }, "type": "object" } ], "description": "用于单独用户的商品限制。" }, "long-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "包含商品详细本地化描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "type": [ "object", "null" ] }, "name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的语言代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。", "type": [ "object", "null" ] }, "per_user_daily": { "description": "每天类型的用户限制次数刷新。", "properties": { "interval_type": { "description": "循环刷新周期。", "enum": [ "daily" ], "type": "string" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "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": "限制数重置的小时间隔。

计时从date_from参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则该商品的购买限制数将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" }, "per_user_hourly_vc": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "限制数重置的小时间隔。

计时从date_from参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则该商品的购买限制数将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" }, "per_user_hourly_vcp": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "限制数重置的小时间隔。

计时从date_from参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则该商品的购买限制数将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" }, "per_user_hourly_vi": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "限制数重置的小时间隔。

计时从date_from参数指定的时间开始。

例如，若`date_start = \"2025-11-15T18:15:00+05:00\"`且`hours_interval = 2`，则该商品的购买限制数将从`\"2025-11-15T20:15:00+05:00\"`开始每2小时重置一次。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = hourly", "type": "object" }, "per_user_monthly": { "description": "每月类型的用户限制次数刷新。", "properties": { "day_of_month": { "description": "在一个月中的哪一天刷新限制次数。如果由于较短的月没有选择具体哪一天，刷新将在该月的最后一天发生。", "maximum": 31, "minimum": 1, "type": "integer" }, "interval_type": { "description": "循环刷新周期。", "enum": [ "monthly" ], "type": "string" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "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": "每周类型的用户限制次数刷新。", "properties": { "day_of_week": { "description": "在一周中的哪一天刷新限制次数。其中1是星期一，7是星期日。", "maximum": 7, "minimum": 1, "type": "integer" }, "interval_type": { "description": "循环刷新周期。", "enum": [ "weekly" ], "type": "string" }, "time": { "description": "所需时区的限制次数刷新时间（四舍五入到小时）。", "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": "两个小写字母的语言代码。", "properties": { "ar": { "description": "阿拉伯语", "type": [ "string", "null" ] }, "bg": { "description": "保加利亚语", "type": [ "string", "null" ] }, "cn": { "description": "中文（简体）", "type": [ "string", "null" ] }, "cs": { "description": "捷克语", "type": [ "string", "null" ] }, "de": { "description": "德语", "type": [ "string", "null" ] }, "en": { "description": "英语", "type": [ "string", "null" ] }, "es": { "description": "西班牙语（西班牙）", "type": [ "string", "null" ] }, "fr": { "description": "法语", "type": [ "string", "null" ] }, "he": { "description": "希伯来语", "type": [ "string", "null" ] }, "id": { "description": "印度尼西亚语", "type": [ "string", "null" ] }, "it": { "description": "意大利语", "type": [ "string", "null" ] }, "ja": { "description": "日语", "type": [ "string", "null" ] }, "km": { "description": "高棉语", "type": [ "string", "null" ] }, "ko": { "description": "韩语", "type": [ "string", "null" ] }, "lo": { "description": "老挝语", "type": [ "string", "null" ] }, "my": { "description": "缅甸语", "type": [ "string", "null" ] }, "ne": { "description": "尼泊尔语", "type": [ "string", "null" ] }, "ph": { "description": "菲律宾语", "type": [ "string", "null" ] }, "pl": { "description": "波兰语", "type": [ "string", "null" ] }, "pt": { "description": "葡萄牙语", "type": [ "string", "null" ] }, "ro": { "description": "罗马尼亚语", "type": [ "string", "null" ] }, "ru": { "description": "俄语", "type": [ "string", "null" ] }, "th": { "description": "泰语", "type": [ "string", "null" ] }, "tr": { "description": "土耳其语", "type": [ "string", "null" ] }, "tw": { "description": "中文（繁体）", "type": [ "string", "null" ] }, "vi": { "description": "越南语", "type": [ "string", "null" ] } }, "title": "two-letter", "type": [ "object", "null" ] }, "value-cart_is_free": { "default": false, "description": "如果为`true`，则购物车为免费。", "example": false, "type": "boolean" }, "value-external_id": { "description": "属性的唯一值ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "value-is_free": { "default": false, "description": "该商品是否免费。", "example": false, "type": "boolean" }, "value-is_paid_randomized_reward": { "default": false, "description": "该商品是否为随机付费奖励，例如宝箱。", "example": false, "type": "boolean" }, "value-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Strategie", "en": "Strategy" }, "description": "包含本地化值名称的对象。编码按照ISO 3166-1的规定。", "example": { "de": "Strategie", "en": "Strategy" }, "type": "object" }, "value-point-amount": { "description": "奖励积分的数量。", "type": "integer" }, "value-point-name": { "description": "奖励积分名称。", "type": "string" }, "value-point-sku": { "description": "唯一奖励积分ID。", "type": "string" }, "virtual_currency_package_recurrent_schedule": { "description": "限制次数刷新周期。", "properties": { "per_user": { "description": "按指定小时间隔执行购买限制数重置。", "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": "限制次数刷新周期。", "properties": { "per_user": { "description": "按指定小时间隔执行购买限制数重置。", "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": "限制次数刷新周期。", "properties": { "per_user": { "description": "按指定小时间隔执行购买限制数重置。", "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. You can try this call using the following test token:`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.\n\nAlternatively, you can use a [token for opening the payment UI](/zh/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](/zh/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](/zh/api/login/authentication-schemes#getting-user-token).\n\nYou can try this call using the following test token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.\n\nAlternatively, you can use a [token for opening the payment UI](/zh/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/zh/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/zh/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/zh/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](/zh/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. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/zh/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](/zh/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](/zh/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. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/zh/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](/zh/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/zh/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/zh/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/zh/api/catalog/)\n- [API keys](https://developers.xsolla.com/zh/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](/zh/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](/zh/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](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/zh/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/zh/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](/zh/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/zh/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/zh/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](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/zh/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/zh/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/zh/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](/zh/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](/zh/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/zh/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](/zh/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](/zh/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](/zh/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/zh/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](/zh/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](/zh/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](/zh/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](/zh/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](/zh/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking)\n- [short-polling](/zh/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](/zh/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](/zh/api/catalog/section/authentication)\n- [Payment testing](/zh/dev-resources/testing/general-info/#general_overview)\n- [Set up order status tracking](/zh/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking)\n- [Webhooks](/zh/webhooks/overview)\n- [Rate limits](/zh/api/login/rate-limits)\n- [Errors handling](/zh/api/getting-started/#api_errors_handling)\n- [API keys](/zh/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](/zh/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](/zh/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": "检索将商品导入项目的进度信息。此API调用检索通过API或发布商帐户执行的最后一次导入的数据。", "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": "获取商品导入状态", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v1/projects/{project_id}/import/from_external_file": { "post": { "description": "通过指定的URL从JSON文件将商品导入商店。关于从JSON文件导入的更多信息，请参阅[文档](https://developers.xsolla.com/zh/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。如果在导入JSON文件时遇到困难，请将此ID报告给您的客户成功经理或发送电子邮件至csm@xsolla.com。", "example": "af9f3638a16e11ef880da2cd677d2d24", "type": "string" } }, "type": "object" } } }, "description": "该文件已成功导入并正在处理。" }, "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": "通过JSON文件导入商品", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/admin/project/{project_id}/cart/fill": { "put": { "description": "在当前购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。", "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": "在购物车里添加商品", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/admin/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "通过购物车ID在购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。", "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": "按购物车ID在购物车里添加商品", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/merchant/{merchant_id}/projects": { "get": { "description": "获取商户项目列表。\n\n
\n

注意

此API调用不包含project_id路径参数，所以需要使用在公司所有项目中都有效的API密钥来设置授权。

\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": "项目信息已成功接收。" }, "401": { "description": "基本认证未通过或错误。确保您使用了基本认证或正确的凭据。" }, "422": { "description": "无效的`limit`或`offset`查询参数。" } }, "security": [ { "basicMerchantAuth": [] } ], "summary": "获取项目", "tags": [ "common-merchant" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute": { "get": { "description": "从项目中获取用于管理的属性列表。", "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": "获取属性列表（管理）", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建一个属性。", "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": "创建属性", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}": { "delete": { "description": "删除属性。\n
注意

删除属性后，其所有数据及与商品的关联关系将被移除。
", "operationId": "delete-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "已成功删除属性。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除属性", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定的属性。", "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": "获取指定属性", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新属性。", "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": "更新属性", "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": "删除该属性的所有值。\n
注意

删除属性值后，该属性与商品之间的所有关联关系将被移除。如需更改商品的属性值，请使用更新属性值API调用，而不是删除该值再创建新值。
", "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": "已成功删除属性值。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "删除属性的所有值", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建一个属性值。\n\n
注意：

所有项目对属性值的数量都有限制。默认值和最大值为 每个属性20个值。
", "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": "创建属性值", "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": "删除属性值。\n
注意

删除属性值后，该属性与商品之间的所有关联关系将被移除。如需更改商品的属性值，请使用更新属性值API调用，而不是删除该值再创建新值。
", "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": "已成功删除属性值。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "删除属性值", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新属性值。", "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": "属性值已成功更新。" }, "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": "更新属性值", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/grant": { "post": { "description": "授予用户权利。\n\n
注意：

只能授予DRM free平台的游戏代码或游戏。
", "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": "游戏的游戏代码。", "example": "AAAA-BBBB-CCCC-DDDD", "type": [ "string", "null" ] }, "drm": { "description": "包含DRM属性的对象。", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "包含游戏属性的对象。", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "应该授予什么类型的权利。如果该参数设置为`sandbox`，则将在沙盒模式下授予用户权利。如果该参数设置为`default`，则在实时模式下授予用户权利。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_country": { "description": "用户所在国家/地区。", "example": "US", "type": [ "string", "null" ] }, "user_external_id": { "description": "唯一用户标识符。", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "已授予权利。" }, "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`和`project_id`正确无误。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "授予权利（管理员）", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/revoke": { "post": { "description": "撤销用户的权利。\n\n
注意：

只能撤销DRM free平台的游戏密钥或游戏。
", "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": "包含DRM属性的对象。", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "包含游戏属性的对象。", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "应该撤销什么类型的权利。如果该参数设置为`sandbox`，则将在沙盒模式下撤销用户权利。如果该参数设置为`default`，则在实时模式下撤销用户权利。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_external_id": { "description": "唯一用户标识符。", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "成功撤销。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "撤销授权（管理员）", "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": "获取项目中的捆绑包列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取捆绑包列表", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建捆绑包。", "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": "创建捆绑包", "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": "获取组中的捆绑包列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "按指定组的外部ID获取捆绑包列表", "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": "获取组中的捆绑包列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "按指定组ID获取捆绑包列表", "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": "删除捆绑包。", "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": "删除捆绑包", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取项目中的捆绑包以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取捆绑包", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新捆绑包。", "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": "更新捆绑包", "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": "在目录中隐藏捆绑包。", "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": "在目录中隐藏捆绑包", "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": "在目录中显示捆绑包。", "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": "在目录中显示捆绑包", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game": { "get": { "description": "获取项目中的游戏列表以进行管理。\n游戏由用户可以购买的游戏密钥组成。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取游戏列表（管理）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "在项目中创建游戏。", "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": "游戏创建成功。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "创建游戏", "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": "根据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": "游戏已成功删除。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "通过ID删除游戏", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取游戏以进行管理。\n游戏由用户可以购买的游戏密钥组成。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "未找到游戏。" } }, "security": [ { "basicAuth": [] } ], "summary": "通过ID获取游戏（管理）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "通过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": "游戏更新成功。" }, "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": "未找到游戏。" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "通过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": "按游戏密钥ID删除所有密钥。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "按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": "按游戏密钥SKU删除所有密钥。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "删除密钥", "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": "通过游戏密钥ID获取指定数量的密钥。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "通过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": "通过游戏密钥SKU获取指定数量的密钥。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取密钥", "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": "按游戏密钥ID上传密钥。", "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": "包含密钥的文件。", "format": "binary", "type": "string" }, "region_id": { "description": "区域ID。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "通过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": "获取密钥加载会话信息。", "operationId": "admin-get-codes-session", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "会话ID。", "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": "未找到密钥加载会话。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取密钥加载会话信息", "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": "按游戏密钥SKU上传密钥。", "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": "包含密钥的文件。", "format": "binary", "type": "string" }, "region_id": { "description": "区域ID。", "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": "未找到游戏密钥或区域。" } }, "security": [ { "basicAuth": [] } ], "summary": "上传密钥", "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": "根据SKU删除项目中的游戏。", "operationId": "admin-delete-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "游戏已成功删除。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "按SKU删除游戏", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取游戏以进行管理。\n游戏由用户可以购买的游戏密钥组成。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "未找到游戏。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取游戏（管理）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "根据SKU更新项目中的游戏。", "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": "游戏更新成功。" }, "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": "未找到游戏。" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "按SKU更新游戏", "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": "获取商品组列表", "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": "取消商品的预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\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": "要移除的数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "数量限制已成功移除。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "移除商品预订数量限制", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取商品的预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\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": "已成功收到商品预订限制的信息。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取商品预订限制的信息", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "添加商品的预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\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": "要添加的数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "201": { "description": "已成功添加数量限制。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "添加商品预订数量限制", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "设置商品的预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\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": "要设置的数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "已成功设置数量限制。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "设置商品预订数量限制", "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": "取消商品的所有预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all", "operationId": "remove-all-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "已成功移除限制。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "移除所有商品预订数量限制", "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": "启用/禁用商品的预订数量限制。\n\n预订限制API允许限量销售商品。如要配置预订本身，请前往所需商品模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-bundle-list/)\n\n此端点的别名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle", "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": "该限制已被禁用/启用。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "未找到商品。" } }, "security": [ { "basicAuth": [] } ], "summary": "切换商品的预订限制", "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": "获取项目中的虚拟货币列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟货币列表", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建虚拟货币。", "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": "创建虚拟货币", "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": "获取项目中虚拟货币套餐的列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟货币套餐列表（管理）", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建虚拟货币套餐。", "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": "创建虚拟货币套餐", "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": "删除虚拟货币套餐。", "operationId": "admin-delete-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "虚拟货币套餐更新成功。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除虚拟货币套餐", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取项目中的虚拟货币套餐以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟货币套餐", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新虚拟货币套餐。", "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": "虚拟物品已成功更新。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "更新虚拟货币套餐", "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": "删除虚拟货币。", "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": "虚拟货币已成功删除。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除虚拟货币", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取项目中的虚拟货币以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟货币", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新虚拟货币。", "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": "虚拟货币更新成功。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "更新虚拟货币", "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": "获取项目中的虚拟物品列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟物品列表", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建虚拟物品。", "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": "创建虚拟物品", "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": "获取组中的虚拟物品列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "按照指定组的外部ID获取虚拟物品列表", "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": "获取组中的虚拟物品列表以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "按照指定组ID获取虚拟物品列表", "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": "删除虚拟物品。", "operationId": "admin-delete-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "虚拟物品已成功删除。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "删除虚拟物品", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取项目中的虚拟物品以进行管理。\n\n
注意

不要使用此端点来构建商店目录。
", "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": "获取虚拟物品", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新虚拟物品。", "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": "虚拟物品已成功更新。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "更新虚拟物品", "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](/zh/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](/zh/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": "获取区域列表。\n\n可使用区域来管理区域限制。", "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": "获取区域列表", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "创建区域。\n\n可使用区域来管理区域限制。", "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": "创建区域", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region/{region_id}": { "delete": { "description": "删除特定区域。", "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": "删除区域", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取特定区域。\n\n可使用区域来管理区域限制。", "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": "获取区域", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "更新特定区域。\n\n可使用区域来管理区域限制。", "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": "更新区域", "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": "刷新指定用户所有商品的所有购买次数限制，以便他们可以再次购买这些商品。\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "已成功刷新限制。" }, "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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "刷新指定用户的所有购买限制", "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": "减少指定用户在应用的限制范围内可购的剩余商品数量。\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "减少指定用户可购的商品数量", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "获取指定用户在应用的限制范围内可购的剩余商品数量。\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "获取指定用户可购的商品数量", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "增加指定用户在应用的限制范围内可购的剩余商品数量。\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "增加指定用户可购的商品数量", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "在增加或减少次数后设置指定用户在应用的限制范围内可购的商品数量\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "设置指定用户可购的商品数量", "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": "刷新商品的购买限制，以便用户可以再次购买。如果*user*参数为`null`，此调用会为所有用户刷新此限制。\n\n用户限制API允许您限量销售商品。要配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏密钥](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-create-game/)\n* [虚拟物品和货币](https://developers.xsolla.com/zh/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [捆绑包](https://developers.xsolla.com/zh/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": "已成功刷新限制。" }, "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": "未找到商品。" }, "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": "无效的请求。" } }, "security": [ { "basicAuth": [] } ], "summary": "刷新购买限制", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "返回当前用户的购物车。", "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": "获取当前用户的购物车", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "删除所有购物车商品。", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "204": { "description": "购物车已成功清空。" } }, "security": [ { "AuthForCart": [] } ], "summary": "从当前购物车中删除所有购物车商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "在购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。", "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": "在购物车里添加商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "从购物车中删除一个商品。", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "购物车中的商品已成功删除。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "从当前购物车中删除购物车商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "更新现有的购物车商品或在购物车中创建商品。", "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": "购物车已成功更新。" }, "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": "更新当前购物车的商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "按购物车ID返回用户的购物车。", "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": "按购物车ID获取购物车", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "删除所有购物车商品。", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "responses": { "204": { "description": "购物车已成功清空。" } }, "security": [ { "AuthForCart": [] } ], "summary": "按购物车ID删除所有购物车商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "在指定购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品位置将被传入的值替换。", "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": "在指定购物车里添加商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "从购物车中删除一个商品。", "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": "购物车中的商品已成功删除。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "按购物车ID删除购物车商品", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "更新现有的购物车商品或在购物车中创建商品。", "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": "购物车已成功更新。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-non-negative-quantity" } }, "security": [ { "AuthForCart": [] } ], "summary": "按购物车ID更新购物车商品", "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": "获取用户拥有的游戏列表", "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": "游戏密钥。", "example": "AAAA-BBBB-CCCC-DDDD", "type": "string" }, "sandbox": { "default": false, "description": "在沙盒模式下兑换游戏密钥。该选项适用于在公司用户列表中指定的那些用户。", "example": false, "type": "boolean" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "201": { "description": "兑换成功。" }, "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`和`project_id`正确无误。" }, "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": "无效的请求。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "通过客户端兑换游戏密钥", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart": { "post": { "description": "使用免费购物车中的所有商品创建一个订单。创建的订单将具有`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": "使用免费购物车创建订单", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart/{cart_id}": { "post": { "description": "使用指定免费购物车中的所有商品创建一个订单。创建的订单将具有`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": "使用指定免费购物车创建订单", "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": "使用指定免费商品创建订单", "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": "获取可售商品列表", "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": "获取捆绑包列表", "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": "获取指定组的捆绑包列表", "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": "指定的捆绑包已成功接收。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取指定的捆绑包", "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": "获取游戏列表", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "获取可用DRM的列表。", "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": "获取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": "按指定组获取游戏列表", "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": "按指定组获取游戏密钥列表", "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": "商品SKU。", "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": "包含游戏密钥信息的对象。", "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": "商品描述。", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam_key_1", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "如果为`true`，则游戏密钥有供销售的密钥。", "example": false, "type": "boolean" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[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": "游戏密钥发行日期按照ISO 8601规定的格式。", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "com.xsolla.game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "虚拟货币类型。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "已成功收到游戏密钥。" }, "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": "找不到游戏密钥。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "获取用于目录的游戏密钥", "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": "商品SKU。", "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": "包含游戏信息的对象。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "商品描述。", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "图像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "商品名称。", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`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": "DRM名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "唯一DRM ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "steam", "type": "string" }, "has_keys": { "description": "如果为`true`，则游戏密钥有供销售的密钥。", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "商品价格。", "properties": { "amount": { "description": "折扣后的商品价格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "商品价格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品价格货币。每[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": "游戏密钥发行日期按照ISO 8601规定的格式。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。", "example": "game_01", "type": "string" }, "type": { "description": "商品类型：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "虚拟价格。", "items": { "description": "虚拟价格。", "properties": { "amount": { "description": "折扣后的商品虚拟货币价格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "商品价格。", "example": 200, "type": "integer" }, "description": { "description": "虚拟货币说明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "虚拟货币图像。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "商品价格是否为默认。", "example": true, "type": "boolean" }, "name": { "description": "虚拟货币名称。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "虚拟货币物品SKU。", "example": "vc_test", "type": "string" }, "type": { "description": "虚拟货币类型。", "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": "单位类型：`game`。", "example": "game", "type": "string" } }, "type": "object" } } }, "description": "成功收到游戏。" }, "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": "未找到游戏。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "将游戏加入到目录", "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": "按指定组获取可售商品列表", "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": "获取商品组列表", "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": "按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": "按SKU获取可售商品", "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": "获取虚拟货币列表", "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": "获取虚拟货币套餐列表", "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": "按SKU获取虚拟币套餐", "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": "按SKU获取虚拟货币", "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 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", "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": "获取虚拟物品列表", "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
", "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": "获取所有虚拟物品列表", "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": "按指定组获取商品列表", "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": "按SKU获取虚拟物品", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/order/{order_id}": { "get": { "description": "检索指定的订单。", "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": "获取订单", "tags": [ "order" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart": { "post": { "description": "用于客户端到服务器的集成。使用购物车中的所有商品创建订单并为其生成支付令牌。创建的订单得到`new`订单状态。\n\n客户端IP用于确定用户所在的国家/地区，然后用于为订单应用相应的货币和可用的支付方式。\n\n要在新窗口中打开支付UI，请使用以下链接：`https://secure.xsolla.com/paystation4/?token={token} `，其中`{token}`是收到的令牌。\n\n如要进行测试，请使用以下URL：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
注：

由于此方法使用IP来确定用户所在的国家/地区并为订单选择货币，因此必须从客户端而不是从服务器端使用此方法。从服务器端使用此方法可能会导致货币判断错误并影响支付中心中可用的支付方式。
", "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": "使用当前购物车中的所有商品创建订单", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart/{cart_id}": { "post": { "description": "用于客户端到服务器的集成。使用指定购物车中的所有商品创建订单并为其生成支付令牌。创建的订单得到`new`订单状态。\n\n客户端IP用于确定用户所在的国家/地区，然后用于为订单应用相应的货币和可用的支付方式。\n\n要在新窗口中打开支付UI，请使用以下链接：`https://secure.xsolla.com/paystation4/?token={token} `，其中`{token}`是收到的令牌。\n\n如要进行测试，请使用以下URL：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
注：

由于此方法使用IP来确定用户所在的国家/地区并为订单选择货币，因此必须从客户端而不是从服务器端使用此方法。从服务器端使用此方法可能会导致货币判断错误并影响支付中心中可用的支付方式。
", "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": "使用特定购物车中的所有商品创建订单", "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": "使用指定商品创建订单", "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/zh" }, "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": "使用以虚拟货币购买的指定商品创建订单", "tags": [ "virtual-payment" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v3/project/{project_id}/admin/order/search": { "post": { "description": "检索订单列表，按最早到最晚创建日期排列。", "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": "获取指定时间段的订单列表", "tags": [ "order" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/payment/token": { "post": { "description": "为其生成订单和支付令牌。订单根据请求正文中传递的商品生成。\n\n要在新窗口中打开支付UI，请使用以下链接：`https://secure.xsolla.com/paystation4/?token={token}`，其中`{token}`是收到的令牌。\n\n如仅进行测试，请使用此URL：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
注意\n

\nuser.country.value参数用于选择订单的货币。如果用户的国家/地区未知，\n请在X-User-Ip头中提供用户的IP作为替代方案。
必须至少提供两者中的一个此方法才能正常工作。
所选货币用于支付中心中的付款方式。\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": "为购买创建支付令牌", "tags": [ "payment-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } } }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "virtual-items-currency-admin", "x-displayName": "管理" }, { "name": "virtual-items-currency-catalog", "x-displayName": "目录" }, { "name": "virtual-payment", "x-displayName": "虚拟支付" }, { "name": "game-keys-catalog", "x-displayName": "目录" }, { "name": "game-keys-entitlement", "x-displayName": "权利" }, { "name": "game-keys-admin", "x-displayName": "管理" }, { "name": "bundles-admin", "x-displayName": "管理" }, { "name": "bundles-catalog", "x-displayName": "目录" }, { "name": "cart-client-side", "x-displayName": "购物车（客户端侧）" }, { "name": "cart-server-side", "x-displayName": "购物车（服务器侧）" }, { "name": "payment-client-side", "x-displayName": "支付（客户端）" }, { "name": "payment-server-side", "x-displayName": "支付（服务器端）" }, { "name": "order", "x-displayName": "订单" }, { "name": "free-item", "x-displayName": "免费商品" }, { "name": "user-limits-admin", "x-displayName": "管理" }, { "name": "connector-admin", "x-displayName": "管理" }, { "name": "common-pre-orders", "x-displayName": "预订" }, { "name": "common-merchant", "x-displayName": "商户" }, { "description": "本API允许获取任意类型的可售商品或指定商品。", "name": "common-catalog", "x-displayName": "目录" }, { "name": "common-regions", "x-displayName": "通用区域" }, { "name": "attribute-admin", "x-displayName": "管理" }, { "name": "item-groups-admin", "x-displayName": "管理" }, { "name": "item-groups-catalog", "x-displayName": "目录" } ], "x-tagGroups": [ { "name": "虚拟物品和货币", "tags": [ "virtual-items-currency-admin", "virtual-items-currency-catalog", "virtual-payment" ] }, { "name": "游戏密钥", "tags": [ "game-keys-catalog", "game-keys-entitlement", "game-keys-admin" ] }, { "name": "捆绑包", "tags": [ "bundles-admin", "bundles-catalog" ] }, { "name": "购物车和付款", "tags": [ "cart-client-side", "cart-server-side", "payment-client-side", "payment-server-side", "order", "free-item" ] }, { "name": "限制", "tags": [ "user-limits-admin" ] }, { "name": "商品导入", "tags": [ "connector-admin" ] }, { "name": "通用", "tags": [ "common-pre-orders", "common-merchant", "common-catalog", "common-regions" ] }, { "name": "商品属性", "tags": [ "attribute-admin" ] }, { "name": "ITEM GROUPS", "tags": [ "item-groups-admin", "item-groups-catalog" ] } ] }