`是用户令牌。该令牌用于识别用户，并提供对个性化数据的访问权限。\n或者，您也可以使用[用于打开支付UI的令牌](/zh/api/pay-station/token/create-token)。\n\n2. **不带Authorization请求头的简化模式。** 此模式仅适用于未完成身份认证的用户，且仅可用于[游戏Key销售](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)请求中不使用令牌，而必须包含以下请求头：\n - `x-unauthorized-id`，值为请求ID\n - `x-user`，值为使用Base64编码的用户电子邮件地址\n\n## 实用链接\n\n- [按交互模型划分的API调用](https://developers.xsolla.com/zh/api/catalog/)\n- [接口类型](https://developers.xsolla.com/zh/api/catalog/)\n- [错误处理](https://developers.xsolla.com/zh/api/catalog/)\n- [API密钥](https://developers.xsolla.com/zh/api/catalog/)\n\n# 核心实体结构\n\n所有类型的商品（虚拟物品、捆绑包、虚拟货币和密钥）都使用类似的数据结构。了解基本结构有助于简化API使用，并帮助您更轻松地查阅文档。\n\n注：
部分调用可能包含其他字段，但这些字段不会改变基本结构。
\n\n**标识信息**\n\n- `merchant_id` — [发布商帐户](https://publisher.xsolla.com/)中的公司ID\n- `project_id` — 发布商帐户中的项目ID\n- `sku` — 商品SKU，在项目内唯一\n\n**商店显示**\n\n- `name` — 商品名称\n- `description` — 商品描述\n- `image_url` — 图片URL\n- `is_enabled` — 商品可用性\n- `is_show_in_store` — 商品是否显示在商品目录中\n\n有关在商品目录中管理商品可用性的更多信息，请参阅[文档](/zh/items-catalog/catalog-features/items-availability/)。\n\n**组织方式**\n\n- `type` — 商品类型，例如虚拟物品（`virtual_item`）或捆绑包（`bundle`）\n- `groups` — 商品所属的组\n- `order` — 在商品目录中的显示顺序\n\n**Sale conditions**\n\n- `prices` — 以真实货币或虚拟货币表示的价格\n- `limits` — 购买限制\n- `periods` — 可用时间段\n- `regions` — 区域限制\n\n**核心实体结构示例：**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# 基本购买流程\n\n艾克索拉API可用于实现游戏内购商店逻辑，包括获取商品目录、管理购物车、创建订单以及跟踪订单状态。根据集成场景，API调用分为**管理**和**商品目录**子部分，使用不同的[身份认证方案](/zh/api/catalog/section/authentication)。\n\n以下示例展示了从创建商品到完成购买的商店设置和运营基本流程。\n\n## 创建商品和组（管理）\n\n为您的商店创建商品目录，例如虚拟物品、捆绑包或虚拟货币。\n\nAPI调用示例：\n- [创建虚拟物品](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [创建捆绑包](/zh/api/catalog/bundles-admin/admin-create-bundle)\n- [创建虚拟货币](/zh/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## 设置促销、奖励链和限制（管理）\n\n配置用户拉新和赢利工具，例如折扣、赠品、每日奖励或优惠链。\n\nAPI调用示例：\n- [创建买赠促销活动](/zh/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [创建每日奖励](/zh/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [创建唯一商品目录优惠促销活动](/zh/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## 获取商品信息（客户端）\n\n在您的应用程序中配置商品显示。\n\n\n
提示\n 请勿使用管理子部分中的API调用来构建用户商品目录。这些API调用存在
速率限制，并不适用于用户流量。\n
\n\nAPI调用示例：\n- [获取虚拟物品列表](/zh/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [获取商品组列表](/zh/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [获取捆绑包列表](/zh/api/catalog/bundles-catalog/get-bundle-list)\n- [获取可售商品列表](/zh/api/catalog/common-catalog/get-sellable-items)\n\n\n 注：
\n 默认情况下，商品目录API调用会返回请求时商店中当前可用的商品。如需获取尚未可用或已不再可用的商品，请在商品目录请求中包含参数\"show_inactive_time_limited_items\": 1。\n
\n\n## 销售商品\n\n您可以使用以下方法销售商品：\n- 快速购买 — 多次销售同一SKU。\n- 购物车购买 — 用户可在同一订单中向购物车添加商品、移除商品并更新数量。\n\n如果商品使用虚拟货币而非真实货币购买，请使用[创建包含指定商品的订单](/zh/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API调用。由于扣款会在执行API调用时处理，因此无需支付UI。\n\n如需购买免费商品，请使用[使用指定商品创建订单](/zh/api/catalog/free-item/create-free-order-with-item) API调用或[使用免费购物车创建订单](/zh/api/catalog/free-item/create-free-order) API调用。无需支付UI — 订单会立即设置为done状态。\n\n### 快速购买\n\n使用客户端API调用[使用指定商品创建订单](/zh/api/catalog/payment-client-side/create-order-with-item)。该调用会返回用于打开支付UI的令牌。\n\n\n 注：
\n 用户只能在支付UI中查看折扣信息。不支持兑换码。\n
\n\n### 购物车购买\n\n可以在客户端或服务器侧设置购物车并完成购买。\n\n**在客户端设置和购买购物车商品**\n\n您需要自行实现添加和移除商品的逻辑。在调用用于设置购物车的API之前，您无法获知哪些促销活动会应用于本次购买。这意味着您无法提前获知总费用以及添加的赠品的详细信息。\n\n实现以下购物车逻辑：\n1. 玩家在购物车加购后，使用[向购物车添加商品](/zh/api/shop-builder/operation/cart-fill/) API调用。该调用会返回所选商品的当前信息（折扣前后价格、赠品）。\n2. 根据用户操作更新购物车内容：\n - 如需添加商品或更改商品数量，请使用[按购物车ID更新购物车商品](/zh/api/shop-builder/operation/put-item-by-cart-id/) API调用。\n - 如需移除商品，请使用[按购物车ID删除购物车商品](/zh/api/shop-builder/operation/delete-item-by-cart-id/) API调用。\n\n\n 注：
\n 如需获取购物车的当前状态，请使用“获取当前用户的购物车”API调用。\n
\n\n3. 使用[创建包含当前购物车中所有商品的订单](/zh/api/shop-builder/operation/create-order/) API调用。该调用返回订单ID和支付令牌。新创建的订单默认设置为new状态。\n\n**在服务器侧设置和购买购物车商品**\n\n这种设置方式可能需要更长的购物车设置时间，因为每次更改购物车都必须伴随API调用。\n\n实现以下购物车逻辑：\n1. 玩家在购物车加购后，使用[向购物车添加商品](/zh/api/catalog/cart-server-side) API调用。该调用会返回所选商品的当前信息（折扣前后价格、赠品）。\n2. 使用[创建包含当前购物车中所有商品的订单](/zh/api/shop-builder/operation/create-order/) API调用。该调用会返回订单ID和支付令牌。新创建的订单默认设置为new状态。\n\n## 打开支付UI\n\n使用返回的令牌在新窗口中打开支付UI。有关打开支付UI的其他方式，请参阅[文档](/zh/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui)。\n\n| 操作 | 接口 |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| 在生产环境中打开。 | https://secure.xsolla.com/paystation4/?token={token} |\n| 在沙盒模式中打开。 | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
注：\n 请在开发和测试期间使用沙盒模式。测试购买不会对真实帐户扣款。您可以使用
测试银行卡。\n\n 完成第一笔真实支付后，严格的沙盒支付策略将生效。沙盒模式下的支付仅对[发布商帐户 > 公司设置 > 用户](https://publisher.xsolla.com/0/settings/users)中指定的用户可用。\n\n 只有在与艾克索拉签署许可协议后，才能使用真实货币购买虚拟货币和商品。如需签署协议，请在[发布商帐户](https://publisher.xsolla.com/)中前往**协议与税务 > 合同与协议**，填写协议表单并等待确认。协议审核最多可能需要3个工作日。\n
\n 提示
\n 请勿使用管理子部分中的API调用来构建商店商品目录。\n
\n\n
\n\n\n
注：\n
获取虚拟物品列表API调用会返回详细的商品数据，包括价格和属性，并支持分页。请使用该调用在商店前端显示商品目录页面。\n
\n
获取所有虚拟物品列表API调用会返回商品SKU、名称、描述，以及组ID和组名称，且不分页。请将其用于客户端侧搜索或索引。\n
\n\n如需使用虚拟货币的购买，请使用[使用以虚拟货币购买的指定商品创建订单](/zh/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API调用。无需支付UI⸺扣款会在执行API调用时完成。\n\n使用虚拟货币购买流程示例：\n\n"
},
{
"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-and-payment-overview",
"x-displayName": "概述",
"description": "购物车是一种购买机制，可将多个商品合并到同一个订单中。用户可以使用真实货币购买任意类型、任意数量的商品，也可以使用[兑换码](https://developers.xsolla.com/zh/api/liveops/promotions-promo-codes)。\n\n购物车与特定用户绑定，并存储在艾克索拉侧。您可以通过两种方式识别购物车：通过[用户JWT](https://developers.xsolla.com/zh/api/catalog/section/authentication/authentication-using-user's-jwt)自动识别或通过购物车ID (`cart_id`)识别。\n\n可在客户端侧和服务器侧管理购物车。\n\n在服务器侧，您可以向购物车添加商品，例如在恢复用户会话时。客户端侧支持以下操作：\n\n* 获取当前用户的购物车或按ID获取购物车\n* 向购物车添加商品\n* 更新购物车中的商品\n* 从购物车中删除商品\n\n如需购买购物车中的商品，请使用客户端和服务器的订单创建调用。\n\n购物车使用场景：\n\n1. 实现商店UI，供用户选择商品。\n2. 当用户在商店中选择商品后，将商品加入购物车，例如使用[向购物车添加商品](https://developers.xsolla.com/zh/api/catalog/cart-client-side/cart-fill)调用。在items数组中，您需要传递SKU和所需的商品数量。\n3. 实现购物车查看UI。当用户进入购物车时，使用[获取当前用户的购物车](https://developers.xsolla.com/zh/api/catalog/cart-client-side/get-user-cart)调用显示购物车内容。响应会返回商品最终价格信息，包括折扣和已应用的促销活动。\n4. 实现支付UI的打开逻辑，以便用户支付订单。例如，您可以使用[创建包含指定购物车中所有商品的订单](https://developers.xsolla.com/zh/api/catalog/payment-client-side/create-order-by-cart-id)调用。响应会返回用于打开支付UI的令牌。\n5. 配置订单状态跟踪，例如使用[Webhook](https://developers.xsolla.com/zh/webhooks/)，以便及时接收已成功支付商品的数据，并向用户发放商品。\n\n\n
注：
\n
如需实现游戏内和线上商品销售，请参阅集成指南。
\n
\n \n \n | 状态 | \n 描述 | \n 备注 | \n
\n \n \n \n new | \n 订单已创建。系统正在等待付款确认。 | \n 交易状态说明请参阅支付收银台API文档。 | \n
\n \n paid | \n 订单已支付（交易已流转至done状态），可以向用户发放商品。 | \n 在付款确认前，订单会保持new状态。 | \n
\n \n done | \n 商品已发放给用户。 | \n — | \n
\n \n canceled | \n 付款已退款。 | \n 当交易状态变更为refunded时，订单会流转至此状态。 | \n
\n \n expired | \n 对于限购商品、兑换码或促销活动，创建新订单时，任何包含该商品且此前未支付的订单都会流转至expired状态。只有最新订单可以付款。 | \n 如果用户尝试支付已过期的订单，支付UI将显示2002错误，付款将失败。 | \n
\n \n
\n\n\n\n\n
注：
\n
如果用户正在完成付款时订单流转至expired状态，但付款成功，则订单会从expired流转至paid状态。仅当付款后不会超出订单中商品的购买限制时，此规则才适用。
\n
\n
注：\n 有关在商品目录中配置限制的详细信息，请参阅
商品购买限制部分。\n
注：
请勿使用此接口来构建商店商品目录。
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "创建虚拟物品",
"description": "创建虚拟物品。",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n 注：
\n 请求正文schema包含可选参数，适用于设置区域价格、购买限制和时效性可用性等高级场景。如需创建基础商品，请传入sku、name和description参数。如需设置真实货币价格，请传入prices参数；如需设置虚拟货币价格，请传入vc_prices。如需将商品设为免费，请设置is_free: true。
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": {
"get": {
"summary": "按照指定组的外部ID获取虚拟物品列表",
"description": "获取组中的虚拟物品列表以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": {
"get": {
"summary": "按照指定组ID获取虚拟物品列表",
"description": "获取组中的虚拟物品列表以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "获取虚拟物品",
"description": "获取项目中的虚拟物品以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"put": {
"summary": "更新虚拟物品",
"description": "更新虚拟物品。",
"operationId": "admin-update-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n 注：
\n 请求正文schema包含必填参数和可选参数，适用于设置区域价格、购买限制和时效性可用性等高级场景。\n
\n\n
\n\n\n 提示
\n 请传入所有商品参数，包括无需更新的参数。请求中未传入的参数将被移除。\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"204": {
"description": "Virtual item was successfully updated.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "删除虚拟物品",
"description": "删除虚拟物品。",
"operationId": "admin-delete-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtual item was successfully deleted.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency": {
"get": {
"summary": "获取虚拟货币列表",
"description": "获取项目中的虚拟货币列表以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currencies-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "创建虚拟货币",
"operationId": "admin-create-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"description": "创建虚拟货币。",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": {
"get": {
"summary": "获取虚拟货币",
"description": "获取项目中的虚拟货币以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"virtual-items-currency-admin"
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Virtual-Items-Currency_404-item"
}
}
},
"put": {
"summary": "更新虚拟货币",
"description": "更新虚拟货币。",
"operationId": "admin-update-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"204": {
"description": "Virtual currency was successfully updated.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "删除虚拟货币",
"description": "删除虚拟货币。",
"operationId": "admin-delete-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtual currency was successfully deleted.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package": {
"get": {
"summary": "获取虚拟货币套餐列表（管理）",
"description": "获取项目中虚拟货币套餐的列表以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currency-packages-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "创建虚拟货币套餐",
"description": "创建虚拟货币套餐。",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": {
"put": {
"summary": "更新虚拟货币套餐",
"description": "更新虚拟货币套餐。",
"operationId": "admin-update-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"204": {
"description": "Virtual item was successfully updated."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "删除虚拟货币套餐",
"description": "删除虚拟货币套餐。",
"operationId": "admin-delete-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtual currency package was successfully updated."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "获取虚拟货币套餐",
"description": "获取项目中的虚拟货币套餐以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"summary": "获取虚拟物品列表",
"description": "获取用于构建商品目录的虚拟物品列表。\n\n\n 提示
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
另请参阅：用于客户端侧搜索或索引的 获取所有虚拟物品列表API调用。",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
},
{
"$ref": "#/components/parameters/show_inactive_time_limited_items-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "按SKU获取虚拟物品",
"description": "按SKU获取用于构建商品目录的虚拟物品。\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 提示
\n 仅返回商品SKU、名称、组和描述。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
另请参阅：用于分页获取详细商品数据的获取虚拟物品列表API调用。",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-all-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"summary": "获取虚拟货币列表",
"description": "获取用于构建商品目录的虚拟货币列表。\n\n\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
注：商品目录API调用可在未授权情况下使用，但如需获取
个性化商品目录，必须在Authorization请求头中传递用户JWT。
",
"operationId": "get-item-groups",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/with_geo-query-param"
}
],
"tags": [
"item-groups-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups": {
"get": {
"summary": "获取商品组列表",
"description": "获取项目内完整商品组列表，不分页。用于管理目的。\n\n注：请勿使用此接口来构建商店商品目录。请改用
获取商品组列表客户端侧接口。
",
"operationId": "admin-get-item-group-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "创建商品组",
"description": "在项目内创建商品组。\n如需获取用于构建商品目录的商品组，请使用获取商品组列表客户端侧接口。",
"operationId": "admin-create-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_create"
},
"responses": {
"201": {
"$ref": "#/components/responses/ItemGroup_201-admin-create-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups/{external_id}": {
"get": {
"summary": "按外部ID获取商品组",
"description": "按外部ID获取商品组，用于管理目的。\n\n注：请勿使用此接口来构建商店商品目录。请改用
获取商品组列表客户端侧接口。
",
"operationId": "admin-get-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
},
"put": {
"summary": "更新商品组",
"description": "按外部ID更新商品组。",
"operationId": "admin-update-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_update"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-update-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
},
"delete": {
"summary": "删除商品组",
"description": "按外部ID删除商品组。",
"operationId": "admin-delete-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-delete-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-delete"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups": {
"get": {
"summary": "获取按商品类型筛选的商品组列表",
"description": "获取按商品类型筛选后的商品组列表。仅将指定类型的商品计入对应组。此接口类似于[获取商品组列表](/zh/api/catalog/item-groups-admin/admin-get-item-group-list)接口，但在统计商品数量时会额外按商品类型进行筛选。",
"operationId": "admin-get-item-group-list-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": {
"get": {
"summary": "按外部ID获取按商品类型筛选的商品组",
"description": "按外部ID获取商品组。仅将指定类型的商品计入对应组。此接口类似于[按外部ID获取商品组](/zh/api/catalog/item-groups-admin/admin-get-item-group)接口，但在统计商品数量时会额外按商品类型进行筛选。",
"operationId": "admin-get-item-group-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/group/order": {
"put": {
"summary": "重新排列商品组",
"description": "设置项目内商品组的显示顺序。传入包含新排序值的组数组。",
"operationId": "admin-reorder-item-groups",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/{external_id}/order/item": {
"put": {
"summary": "重新排列组内商品（按外部ID）",
"description": "设置由外部ID标识的组内商品显示顺序。传入包含新排序值的商品数组。",
"operationId": "admin-reorder-items-in-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/id/{id}/order/item": {
"put": {
"summary": "重新排列组内商品（按ID）",
"description": "设置由内部数字ID标识的组内商品显示顺序。传入包含新排序值的商品数组。",
"operationId": "admin-reorder-items-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": {
"post": {
"summary": "使用以虚拟货币购买的指定商品创建订单",
"description": "创建使用虚拟货币购买的商品订单。
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-game-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-games-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/sku/{item_sku}": {
"get": {
"summary": "获取游戏（管理）",
"description": "获取游戏以进行管理。\n游戏由可供用户购买的游戏Key组成。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "按SKU更新游戏",
"description": "根据SKU更新项目中的游戏。",
"operationId": "admin-update-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Game was successfully updated."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "按SKU删除游戏",
"description": "根据SKU删除项目中的游戏。",
"operationId": "admin-delete-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Game was successfully deleted."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/id/{item_id}": {
"get": {
"summary": "通过ID获取游戏（管理）",
"description": "获取游戏以进行管理。\n游戏由可供用户购买的游戏Key组成。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "通过ID更新游戏",
"description": "通过ID更新项目中的游戏。",
"operationId": "admin-update-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Game was successfully updated."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "通过ID删除游戏",
"description": "根据ID删除项目中的游戏。",
"operationId": "admin-delete-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Game was successfully deleted."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": {
"post": {
"summary": "上传游戏Key",
"description": "按游戏Key SKU上传游戏Key。",
"operationId": "admin-upload-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "区域ID。"
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
},
"required": true
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": {
"post": {
"summary": "按ID上传游戏Key",
"description": "按游戏Key ID上传游戏Key。",
"operationId": "admin-upload-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "区域ID。"
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": {
"get": {
"summary": "获取游戏Key加载会话信息",
"description": "获取游戏Key加载会话信息。",
"operationId": "admin-get-codes-session",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "session_id",
"in": "path",
"required": true,
"description": "会话ID。",
"schema": {
"type": "string",
"default": "fc7105b6e8ee01339582970b37697242"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Codes loading session not found.\n"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": {
"get": {
"summary": "获取游戏Key",
"description": "按游戏Key SKU获取指定数量的游戏Key。",
"operationId": "admin-get-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": {
"get": {
"summary": "按ID获取游戏Key",
"description": "按游戏Key ID获取指定数量的游戏Key。",
"operationId": "admin-get-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": {
"delete": {
"summary": "删除游戏Key",
"description": "按游戏Key SKU删除所有游戏Key。",
"operationId": "admin-delete-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": {
"delete": {
"summary": "按ID删除游戏Key",
"description": "按游戏Key ID删除所有游戏Key。",
"operationId": "admin-delete-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Game key or region not found.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/entitlement": {
"get": {
"tags": [
"game-keys-entitlement"
],
"operationId": "get-user-games",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/sandbox-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-entitlement-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-user-entitlement-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
},
"summary": "获取用户拥有的游戏列表",
"description": "获取用户拥有的游戏列表。响应将包含指定用户拥有的一组游戏。\n\n\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 提示
\n 仅可为DRM free平台兑换游戏Key。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
注意：
仅可授予DRM free平台的游戏Key或游戏。
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"code": {
"type": [
"string",
"null"
],
"example": "AAAA-BBBB-CCCC-DDDD",
"description": "Game code of the game."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode."
},
"user_country": {
"type": [
"string",
"null"
],
"example": "US",
"description": "User's country."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/entitlement/revoke": {
"post": {
"tags": [
"game-keys-entitlement"
],
"operationId": "revoke-entitlement-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"204": {
"description": "Successful revoke."
},
"403": {
"$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent"
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 5103
},
"errorMessage": {
"type": "string",
"example": "[0401-5103]: Selected drm is not drmfree."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"DRM is not DRM free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
}
}
}
}
}
},
"summary": "撤销权益（管理）",
"description": "撤销用户的权益。\n\n注意：
仅可撤销DRM free平台的游戏Key或游戏。
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/items/bundle": {
"get": {
"summary": "获取捆绑包列表",
"description": "获取项目中的捆绑包列表以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-bundle-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "创建捆绑包",
"description": "创建捆绑包。",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"201": {
"$ref": "#/components/responses/Bundles_201-admin-create-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": {
"get": {
"summary": "按指定组ID获取捆绑包列表",
"description": "Gets the list of bundles within a group for administration.\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-bundle-list-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": {
"get": {
"summary": "按指定组的外部ID获取捆绑包列表",
"description": "Gets the list of bundles within a group for administration.\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-bundle-list-in-group-by-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}": {
"put": {
"summary": "更新捆绑包",
"description": "更新捆绑包。",
"operationId": "admin-update-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-update-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
},
"delete": {
"summary": "删除捆绑包",
"description": "删除捆绑包。",
"operationId": "admin-delete-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-delete-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "获取捆绑包",
"description": "获取项目中的捆绑包以进行管理。\n\n注：
请勿使用此接口来构建商店商品目录。
",
"operationId": "admin-get-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": {
"put": {
"summary": "在商品目录中显示捆绑包",
"description": "在商品目录中显示捆绑包。",
"operationId": "admin-show-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-show-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": {
"put": {
"summary": "在商品目录中隐藏捆绑包",
"description": "在商品目录中隐藏捆绑包。",
"operationId": "admin-hide-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-hide-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"summary": "获取捆绑包列表",
"description": "获取用于构建商品目录的捆绑包列表。\n\n\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
提示由于此方法会根据IP确定用户所在国家/地区，并为订单选择货币，因此请务必仅在客户端侧使用此方法，不要在服务器侧使用。从服务器侧使用此方法可能导致货币判断不准确，并影响
支付收银台中可用的支付方式。
",
"operationId": "create-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/cart": {
"post": {
"summary": "创建包含当前购物车中所有商品的订单",
"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",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}": {
"post": {
"summary": "创建包含指定商品的订单",
"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\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确定用户所在国家/地区，并为订单选择货币，因此请务必仅在客户端侧使用此方法，不要在服务器侧使用。从服务器侧使用此方法可能导致货币判断不准确，并影响
支付收银台中可用的支付方式。
\n\n
\n\n\n 提示
\n 此API调用使用用户JWT进行授权。
\n 请在Authorization请求头中包含令牌，格式为：Bearer <user_JWT>。有关用户JWT的更多信息，请参阅此调用的安全性部分。\n
",
"operationId": "create-order-with-item",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid"
}
}
}
},
"/v2/project/{project_id}/free/cart": {
"post": {
"summary": "创建免费购物车订单",
"description": "创建包含免费购物车中所有商品的订单。创建后的订单状态将为`done`。",
"operationId": "create-free-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/cart/{cart_id}": {
"post": {
"summary": "创建指定免费购物车订单",
"description": "创建包含指定免费购物车中所有商品的订单。创建后的订单状态将为`done`。",
"operationId": "create-free-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/item/{item_sku}": {
"post": {
"summary": "创建包含指定免费商品的订单",
"description": "创建包含指定免费商品的订单。创建后的订单状态将为`done`。
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
提示\n
\n
user.country.value参数用于为订单选择货币。如果无法确定用户所在国家/地区，\n也可以在
X-User-Ip请求头中提供用户IP。
要使此方法正常工作，必须提供这两种信息之一。
所选货币将用于
支付收银台中的支付方式。\n
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token"
},
"responses": {
"201": {
"$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token"
}
}
}
},
"/v2/admin/project/{project_id}/cart/fill": {
"put": {
"summary": "向购物车添加商品",
"description": "向当前购物车添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。",
"operationId": "admin-cart-fill",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/admin/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"summary": "按购物车ID向购物车添加商品",
"description": "按购物车ID向购物车添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。",
"operationId": "admin-fill-cart-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-items-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "刷新指定用户的所有购买限制",
"description": "刷新指定用户在所有商品上的全部购买次数限制，使其能够再次购买这些商品。\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"description": "The limit was successfully refreshed."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"User not found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User"
}
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "刷新购买限制",
"description": "刷新商品的购买限制，以便用户可以再次购买。如果*user*参数为`null`，此调用会为所有用户刷新此限制。\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"description": "The limit was successfully refreshed."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "获取指定用户可购买的商品剩余数量",
"description": "Gets the remaining number of items available to the specified user within the limit applied.\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "增加指定用户可购买的商品剩余数量",
"description": "在已应用的数量限制内，增加指定用户可购买的商品剩余数量。\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "设置指定用户可购的商品数量",
"description": "在已应用的数量限制经过增加或减少后，设置指定用户可购买的商品数量。\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "减少指定用户可购买的商品剩余数量",
"description": "在已应用的数量限制内，减少指定用户可购买的商品剩余数量。\n\n用户限制API允许您限量销售商品。如需配置购买限制，请前往所需商品类型模块的管理部分：\n* [游戏Key](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/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v1/projects/{project_id}/import/from_external_file": {
"post": {
"tags": [
"connector-admin"
],
"operationId": "import-items-from-external-file",
"summary": "通过JSON文件导入商品",
"description": "通过指定的URL从JSON文件将商品导入商店。关于从JSON文件导入的更多信息，请参阅[文档](https://developers.xsolla.com/zh/doc/shop-builder/how-to/json-import/)。",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"responses": {
"201": {
"description": "The file has been successfully imported and is being processed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"import_id": {
"type": "string",
"example": "af9f3638a16e11ef880da2cd677d2d24",
"description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com."
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/connector-422-validation-failed"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/connector-import-items-body"
}
}
},
"/v1/admin/projects/{project_id}/connectors/import_items/import/status": {
"get": {
"tags": [
"connector-admin"
],
"operationId": "get-items-import-status",
"summary": "获取商品导入状态",
"description": "检索将商品导入项目的进度信息。此API调用检索通过API或发布商帐户执行的最后一次导入的数据。",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-items-import-status-model"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
]
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "获取商品预售限制信息",
"description": "获取商品的预售数量限制。\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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}",
"responses": {
"200": {
"description": "Information about the item pre-order limit was successfully received.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "com.xsolla.item_1"
},
"is_pre_order_limit_enabled": {
"type": "boolean",
"example": true
},
"available": {
"type": "integer",
"example": 431
},
"reserved": {
"type": "integer",
"example": 13
},
"sold": {
"type": "integer",
"example": 556
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.item_1",
"is_pre_order_limit_enabled": true,
"available": 431,
"reserved": 13,
"sold": 556
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
}
},
"post": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "添加商品预售数量限制",
"description": "添加商品的预售数量限制。\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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}",
"responses": {
"201": {
"description": "The quantity to limit was successfully added."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to add."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "设置商品预售数量限制",
"description": "设置商品的预售数量限制。\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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}",
"responses": {
"204": {
"description": "The quantity to limit was successfully set."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to set."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "移除商品预售数量限制",
"description": "取消商品的预售数量限制。\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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}",
"responses": {
"204": {
"description": "The quantity to limit was successfully removed."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to remove."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": {
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "toggle-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "切换商品的预售限制状态",
"description": "Enable/disable pre-order limit of the item.\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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",
"responses": {
"204": {
"description": "The limit has been disabled/enabled."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"is_pre_order_limit_enabled": {
"type": "boolean"
}
},
"required": [
"is_pre_order_limit_enabled"
]
},
"example": {
"is_pre_order_limit_enabled": true
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-all-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "移除所有商品预售数量限制",
"description": "取消商品的所有预售数量限制。\n\n预售限制API允许限量销售商品。如需配置预售本身，请前往所需商品模块的管理部分：\n* [游戏Key](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",
"responses": {
"204": {
"description": "The limit was successfully removed."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item not found."
}
}
}
},
"/v2/merchant/{merchant_id}/projects": {
"get": {
"tags": [
"common-merchant"
],
"operationId": "get-projects",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"security": [
{
"basicMerchantAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/merchant_id-path-param"
}
],
"summary": "获取项目",
"description": "获取商户项目列表。\n\n\n
提示
此API调用不包含project_id路径参数，因此您需要使用在公司所有项目中均有效的API密钥来设置授权。
\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
\n 注意
\n 所有项目对响应中可获取的商品数量均有限制。默认值和最大值均为每个响应50个商品。如需按页获取更多数据，请使用limit和offset字段。\n
\n\n
\n\n\n
注：\n 未经授权使用此API调用时，会返回通用商品目录数据。如需获取\n
个性化\n 用户数据，例如与商品相关的数量限制和促销活动，请使用授权。为此，请在
Authorization请求头中传递用户JWT。\n 有关用户JWT的更多信息，请参阅此调用的
Security部分。\n
提示
如果删除商品属性，其所有数据及其与商品的关联都将丢失。
",
"operationId": "delete-attribute",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Attribute was successfully deleted."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value": {
"post": {
"summary": "创建属性值",
"description": "创建一个属性值。\n\n注意：
所有项目对属性值数量均有限制。默认值和最大值均为每个属性20个值。
",
"operationId": "admin-create-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-attribute-value"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "删除属性的所有值",
"description": "删除该属性的所有值。\n\n提示删除属性值后，该属性与商品之间的所有关联关系将被移除。如需更改商品的属性值，请使用
更新属性值API调用，而不是删除该值再创建新值。
",
"operationId": "admin-delete-all-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attribute values was successfully deleted."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": {
"put": {
"summary": "更新属性值",
"description": "更新属性值。",
"operationId": "admin-update-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attribute value was successfully updated."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-value-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "删除属性值",
"description": "删除属性值。\n\n提示删除属性值后，该属性与商品之间的所有关联关系将被移除。如需更改商品的属性值，请使用
更新属性值API调用，而不是删除该值再创建新值。
",
"operationId": "admin-delete-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "管理",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attribute value was successfully deleted."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"description": "服务器侧调用使用`basicAuth`身份认证方案。向API发送的所有请求都必须包含`Authorization: Basic `请求头，其中`your_authorization_basic_key`是根据Base64标准编码的`project_id:api_key`对。\n\n如有需要，您可以使用`merchant_id`代替`project_id`。这不会影响功能。\n\n前往[发布商帐户](https://publisher.xsolla.com/)查找参数值：\n\n* `merchant_id`显示在：\n * **公司设置 > 公司**部分\n * 任意发布商帐户页面的浏览器地址栏URL中。URL格式为：`https://publisher.xsolla.com/`。\n* `api_key`仅会在创建时于发布商帐户中显示一次，必须由您在己侧保存。您可以在以下部分创建新密钥：\n * [公司设置 > API密钥](https://publisher.xsolla.com/0/settings/api_key)\n * [项目设置 > API密钥](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**提示**\n\n如果所需的API调用不包含`project_id`路径参数，请使用对公司所有项目均有效的API密钥进行授权。\n{% /html %}\n\n* `project_id`显示在：\n * 发布商帐户中项目名称旁边。\n * 发布商帐户中项目页浏览器地址栏中的URL中。URL格式为：`https://publisher.xsolla.com//projects/`。\n\n有关使用API密钥的更多信息，请参阅[API参考](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview)。",
"scheme": "basic"
},
"XsollaLoginUserJWT": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "客户端侧调用使用`XsollaLoginUserJWT`身份认证方案。请求须在`Authorization`请求头中包含用户JWT，格式为：Bearer ``。令牌用于识别用户并提供个性化数据访问权限。有关令牌创建方法，请参阅[艾克索拉登录管理器API文档](/zh/api/login/authentication-schemes#getting-user-token)。\n\n或者，您也可以使用[用于打开支付UI的令牌](/zh/api/pay-station/token/create-token)。"
},
"AuthForCart": {
"type": "http",
"scheme": "bearer",
"description": "`AuthForCart`身份认证方案用于购物车购买，支持两种模式：\n\n1. 使用用户JWT进行身份认证。 令牌通过Authorization请求头按以下格式传递：`Authorization: Bearer `，其中``是用户令牌。该令牌用于识别用户，并提供对个性化数据的访问权限。\n\n或者，您也可以使用[用于打开支付UI的令牌](/zh/api/pay-station/token/create-token)。\n\n2. 不带`Authorization`请求头的简化模式。此模式仅适用于未完成身份认证的用户，且仅可用于[游戏Key销售](/zh/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)请求中不使用令牌，而必须包含以下请求头：\n* `x-unauthorized-id`，值为请求ID\n* `x-user`，值为使用Base64编码的用户电子邮件地址。"
},
"basicMerchantAuth": {
"type": "http",
"description": "服务器侧调用使用`basicMerchantAuth`身份认证方案。向API发送的所有请求都必须包含`Authorization: Basic `请求头，其中`your_authorization_basic_key`是根据Base64标准编码的`merchant_id:api_key`对。\n\n前往[发布商帐户](https://publisher.xsolla.com/)查找参数值：\n\n* `merchant_id`显示在：\n * **公司设置 > 公司**部分\n * 任意发布商帐户页面的浏览器地址栏URL中。URL格式为：`https://publisher.xsolla.com/`。\n* `api_key`仅会在创建时于发布商帐户中显示一次，必须由您在己侧保存。您可以在[公司设置 > API密钥](https://publisher.xsolla.com/0/settings/api_key)部分创建新密钥。\n\n有关使用API密钥的更多信息，请参阅[API参考](https://developers.xsolla.com/zh/api/getting-started/#api_keys_overview)。",
"scheme": "basic"
}
},
"parameters": {
"project_id-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "项目ID。您可以在[发布商帐户](https://publisher.xsolla.com/0/projects/0/)的项目名称旁找到此参数；使用项目时，也可以在浏览器地址栏中找到此参数。URL格式如下：`https://publisher.xsolla.com//projects/`。",
"schema": {
"type": "integer",
"example": 44056
}
},
"limit-query-param": {
"name": "limit",
"in": "query",
"example": 50,
"required": false,
"description": "页面上元素数量的限制。",
"schema": {
"type": "integer",
"example": 50,
"minimum": 1
}
},
"offset-query-param": {
"name": "offset",
"in": "query",
"required": false,
"example": 0,
"description": "生成列表时作为起始位置的元素编号（从0开始计数）。",
"schema": {
"type": "integer",
"example": 0,
"minimum": 0
}
},
"external_id-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "创建时指定的外部商品组ID。",
"schema": {
"type": "string",
"example": "weapons"
}
},
"group_id-path-param": {
"name": "group_id",
"in": "path",
"required": true,
"description": "组ID。",
"schema": {
"type": "integer",
"example": 10
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "商品SKU。",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"virtual_currency_sku-path-param": {
"name": "virtual_currency_sku",
"in": "path",
"required": true,
"description": "虚拟货币SKU。",
"schema": {
"type": "string",
"example": "crystal"
}
},
"locale-query-param": {
"name": "locale",
"in": "query",
"required": false,
"description": "响应语言。符合ISO 639-1标准的两位小写语言代码（例如`en`）。`name`和`description`等本地化字段支持五字符区域代码（例如`en-US`），但在响应中会标准化为两位代码。支持的语言完整列表请参阅[文档](https://developers.xsolla.com/zh/doc/shop-builder/references/supported-languages/)。",
"schema": {
"type": "string",
"default": "en"
}
},
"additional_fields-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"media_list",
"order",
"long_description",
"custom_attributes",
"item_order_in_group"
]
}
}
},
"country-query-param": {
"name": "country",
"in": "query",
"required": false,
"description": "符合[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)的详细信息，请参阅文档。",
"schema": {
"type": "string",
"example": "US"
}
},
"promo_code-query-param": {
"name": "promo_code",
"in": "query",
"required": false,
"description": "区分大小写的唯一兑换码。包含字母和数字。",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"show_inactive_time_limited_items-query-param": {
"name": "show_inactive_time_limited_items",
"in": "query",
"required": false,
"description": "显示对用户不可用的时效性商品。这类商品的有效期尚未开始或已经结束。",
"schema": {
"type": "integer",
"example": 1,
"default": 0
}
},
"virtual_currency_package_sku-path-param": {
"name": "virtual_currency_package_sku",
"in": "path",
"required": true,
"description": "虚拟货币套餐SKU。",
"schema": {
"type": "string",
"example": "crystal-pack"
}
},
"with_geo-query-param": {
"name": "with_geo",
"in": "query",
"required": false,
"description": "是否在响应头中返回用户的区域设置和国家/地区信息。如果设置为`true`，响应将包含`X-User-Locale-Code`和`X-User-Country-Code`响应头。\n",
"schema": {
"type": "boolean",
"default": false
}
},
"item_type-group-path-param": {
"name": "item_type",
"in": "path",
"required": true,
"description": "用于筛选组的商品类型。决定哪些商品会计入`items_count`。包含`/`的值（例如`virtual_currency/package`或`game/key`）必须进行URL编码（例如`virtual_currency%2Fpackage`）。\n",
"schema": {
"type": "string",
"enum": [
"virtual_items",
"virtual_currency",
"virtual_currency/package",
"game/key",
"bundle",
"game",
"value_points",
"subscription_plans"
],
"example": "virtual_items"
}
},
"id-group-path-param": {
"name": "id",
"in": "path",
"required": true,
"description": "由艾克索拉分配的商品组ID。",
"schema": {
"type": "integer",
"example": 1
}
},
"platform-query-param": {
"name": "platform",
"in": "query",
"required": false,
"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`。",
"schema": {
"type": "string",
"enum": [
"playstation_network",
"xbox_live",
"xsolla",
"pc_standalone",
"nintendo_shop",
"google_play",
"app_store_ios",
"android_standalone",
"ios_standalone",
"android_other",
"ios_other",
"pc_other"
],
"default": "xsolla"
}
},
"item_id-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "商品ID。",
"schema": {
"type": "string",
"example": "656"
}
},
"user_email-query-param": {
"name": "user_email",
"in": "query",
"required": true,
"description": "用户电子邮件。",
"schema": {
"type": "string",
"example": "email@email.com"
}
},
"quantity-query-param": {
"name": "quantity",
"in": "query",
"required": true,
"description": "游戏Key数量。",
"schema": {
"type": "integer",
"example": 100
}
},
"reason-query-param": {
"name": "reason",
"in": "query",
"required": true,
"description": "收到游戏Key的原因。",
"schema": {
"type": "string",
"example": "Very important"
}
},
"region_id-query-param": {
"name": "region_id",
"in": "query",
"required": false,
"description": "区域ID。",
"schema": {
"type": "integer",
"default": 1
}
},
"sandbox-query-param": {
"name": "sandbox",
"in": "query",
"required": false,
"description": "要返回的权益类型。如果该参数设置为1，则仅返回用户在沙盒模式下收到的权益。如果未传递该参数或设置为0，则仅返回用户在实时模式下收到的权益。要返回的权益类型。如果该参数设置为1，则仅返回用户在沙盒模式下收到的权益。如果未传递该参数或设置为0，则仅返回用户在实时模式下收到的权益。",
"schema": {
"type": "integer",
"default": 0
}
},
"additional_fields-entitlement-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。可用字段`attributes`。",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"sku-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "捆绑包SKU。",
"schema": {
"type": "string",
"example": "kg_1"
}
},
"cart_id-path-param": {
"name": "cart_id",
"in": "path",
"required": true,
"description": "购物车ID。",
"schema": {
"type": "string",
"example": "custom_id"
}
},
"currency-query-param": {
"name": "currency",
"in": "query",
"required": false,
"description": "购物车中显示的商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三位币种代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。",
"schema": {
"type": "string",
"default": "USD"
}
},
"order_id-path-param": {
"name": "order_id",
"in": "path",
"required": true,
"description": "订单ID。",
"schema": {
"type": "string",
"example": "656"
}
},
"x-user-for-header": {
"in": "header",
"name": "x-user-for",
"example": "ACCESS_TOKEN/LOGIN_JWT",
"schema": {
"type": "string"
},
"required": false,
"description": "可使用艾克索拉登录管理器用户JWT或[支付收银台访问令牌](https://developers.xsolla.com/zh/pay-station-api/current/token/create-token)传递用户标识符。"
},
"x-user-id-header": {
"in": "header",
"name": "x-user-id",
"example": "UNIQUE_ID",
"schema": {
"maxLength": 32,
"type": "string"
},
"required": false,
"description": "使用购物车销售游戏时可以使用您自己的用户ID。"
},
"user_external_id-query-param": {
"name": "user_external_id",
"in": "query",
"required": true,
"description": "用户外部ID",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"merchant_id-path-param": {
"name": "merchant_id",
"in": "path",
"required": true,
"description": "商户ID。",
"schema": {
"type": "integer",
"example": 121212
}
},
"project_id_59080-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "项目ID。您可以在[发布商帐户](https://publisher.xsolla.com/)的项目名称旁边找到。",
"schema": {
"type": "integer",
"example": 59080
}
},
"item_id_59080-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "商品ID。",
"schema": {
"type": "string",
"example": "259774"
}
},
"item_sku_59080-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "商品SKU。",
"schema": {
"type": "string",
"example": "electric_shield"
}
},
"external_id_59080-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "组外部ID。",
"schema": {
"type": "string",
"default": "armour"
}
},
"region_id-path-param": {
"name": "region_id",
"in": "path",
"required": true,
"description": "区域ID。项目内的唯一区域标识符。",
"schema": {
"type": "integer",
"example": 42
}
},
"external_id-attr-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "属性外部ID。",
"schema": {
"type": "string",
"example": "attribute_id"
}
},
"value_external_id-path-param": {
"name": "value_external_id",
"in": "path",
"required": true,
"description": "属性值外部ID。",
"schema": {
"type": "string",
"pattern": "^[-_\\.\\d\\w]+$",
"example": "value_id"
}
}
},
"schemas": {
"Virtual-Items-Currency_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "唯一属性ID。 `external_id`只能包含大小写英文字母、数字、短横线和下划线。"
},
"admin-attribute-name": {
"type": "object",
"description": "包含属性本地化名称的对象。编码按照ISO 3166-1的规定。",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Genre",
"de": "Genre"
},
"default": {
"en": "Genre",
"de": "Genre"
}
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "属性的唯一值ID。 `external_id`只能包含小写英文字母、数字、短横线和下划线。"
},
"value-name": {
"type": "object",
"description": "包含值本地化名称的对象。编码按照ISO 3166-1的规定。",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Strategy",
"de": "Strategie"
},
"default": {
"en": "Strategy",
"de": "Strategie"
}
},
"attribute-value": {
"type": "object",
"required": [
"value",
"external_id"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_external_id",
"name": {
"en": "Value 1",
"de": "Wert 1"
}
}
},
"attribute": {
"type": "object",
"required": [
"external_id",
"values"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
},
"example": {
"external_id": "attribute_external_id",
"name": {
"en": "Attribute name",
"de": "Attributname"
},
"values": [
{
"external_id": "value_1",
"name": {
"en": "value 1",
"de": "wert 1"
}
},
{
"external_id": "value_2",
"name": {
"en": "value 2",
"de": "wert 2"
}
}
]
}
},
"Virtual-Items-Currency_schemas-admin-attributes": {
"type": "array",
"description": "属性列表。",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Virtual-Items-Currency_admin-attributes": {
"allOf": [
{
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes"
},
{
"description": "属性列表。"
}
]
},
"two-letter-locale": {
"type": [
"object",
"null"
],
"description": "两个小写字母的语言代码。",
"title": "two-letter",
"properties": {
"en": {
"type": [
"string",
"null"
],
"description": "英语"
},
"ar": {
"type": [
"string",
"null"
],
"description": "阿拉伯语"
},
"bg": {
"type": [
"string",
"null"
],
"description": "保加利亚语"
},
"cn": {
"type": [
"string",
"null"
],
"description": "中文（简体）"
},
"cs": {
"type": [
"string",
"null"
],
"description": "捷克语"
},
"de": {
"type": [
"string",
"null"
],
"description": "德语"
},
"es": {
"type": [
"string",
"null"
],
"description": "西班牙语（西班牙）"
},
"fr": {
"type": [
"string",
"null"
],
"description": "法语"
},
"he": {
"type": [
"string",
"null"
],
"description": "希伯来语"
},
"it": {
"type": [
"string",
"null"
],
"description": "意大利语"
},
"ja": {
"type": [
"string",
"null"
],
"description": "日语"
},
"ko": {
"type": [
"string",
"null"
],
"description": "韩语"
},
"pl": {
"type": [
"string",
"null"
],
"description": "波兰语"
},
"pt": {
"type": [
"string",
"null"
],
"description": "葡萄牙语"
},
"ro": {
"type": [
"string",
"null"
],
"description": "罗马尼亚语"
},
"ru": {
"type": [
"string",
"null"
],
"description": "俄语"
},
"th": {
"type": [
"string",
"null"
],
"description": "泰语"
},
"tr": {
"type": [
"string",
"null"
],
"description": "土耳其语"
},
"tw": {
"type": [
"string",
"null"
],
"description": "中文（繁体）"
},
"vi": {
"type": [
"string",
"null"
],
"description": "越南语"
},
"km": {
"type": [
"string",
"null"
],
"description": "高棉语"
},
"id": {
"type": [
"string",
"null"
],
"description": "印度尼西亚语"
},
"lo": {
"type": [
"string",
"null"
],
"description": "老挝语"
},
"my": {
"type": [
"string",
"null"
],
"description": "缅甸语"
},
"ph": {
"type": [
"string",
"null"
],
"description": "菲律宾语"
},
"ne": {
"type": [
"string",
"null"
],
"description": "尼泊尔语"
}
}
},
"five-letter-locale": {
"type": [
"object",
"null"
],
"description": "五个字符的区域设置代码。",
"title": "five-letter",
"properties": {
"en-US": {
"type": [
"string",
"null"
],
"description": "英语"
},
"ar-AE": {
"type": [
"string",
"null"
],
"description": "阿拉伯语"
},
"bg-BG": {
"type": [
"string",
"null"
],
"description": "保加利亚语"
},
"zh-CN": {
"type": [
"string",
"null"
],
"description": "中文（简体）"
},
"cs-CZ": {
"type": [
"string",
"null"
],
"description": "捷克语"
},
"de-DE": {
"type": [
"string",
"null"
],
"description": "德语"
},
"es-ES": {
"type": [
"string",
"null"
],
"description": "西班牙语（西班牙）"
},
"fr-FR": {
"type": [
"string",
"null"
],
"description": "法语"
},
"he-IL": {
"type": [
"string",
"null"
],
"description": "希伯来语"
},
"it-IT": {
"type": [
"string",
"null"
],
"description": "意大利语"
},
"ja-JP": {
"type": [
"string",
"null"
],
"description": "日语"
},
"ko-KR": {
"type": [
"string",
"null"
],
"description": "韩语"
},
"pl-PL": {
"type": [
"string",
"null"
],
"description": "波兰语"
},
"pt-BR": {
"type": [
"string",
"null"
],
"description": "葡萄牙语（巴西）"
},
"ro-RO": {
"type": [
"string",
"null"
],
"description": "罗马尼亚语"
},
"ru-RU": {
"type": [
"string",
"null"
],
"description": "俄语"
},
"th-TH": {
"type": [
"string",
"null"
],
"description": "泰语"
},
"tr-TR": {
"type": [
"string",
"null"
],
"description": "土耳其语"
},
"zh-TW": {
"type": [
"string",
"null"
],
"description": "中文（繁体）"
},
"vi-VN": {
"type": [
"string",
"null"
],
"description": "越南语"
},
"km-KH": {
"type": [
"string",
"null"
],
"description": "高棉语"
},
"id-ID": {
"type": [
"string",
"null"
],
"description": "印度尼西亚语"
},
"lo-LA": {
"type": [
"string",
"null"
],
"description": "老挝语"
},
"my-MM": {
"type": [
"string",
"null"
],
"description": "缅甸语"
},
"ph-PH": {
"type": [
"string",
"null"
],
"description": "菲律宾语"
},
"ne-NP": {
"type": [
"string",
"null"
],
"description": "尼泊尔语"
}
}
},
"name-localization-object": {
"type": [
"object",
"null"
],
"description": "包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的语言代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"description-localization-object": {
"type": [
"object",
"null"
],
"description": "包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"long-description-localization-object": {
"type": [
"object",
"null"
],
"description": "包含商品详细本地化描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"Virtual-Items-Currency_admin-groups-response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}\"格式的区域设置，值是字符串。",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Virtual-Items-Currency_admin-media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "商品的附加资源，例如屏幕截图、游戏视频等。",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "媒体类型：`image`/`video`。"
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "资源文件。"
}
}
}
},
"Virtual-Items-Currency_type": {
"type": "string",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。"
},
"Virtual-Items_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "金额。",
"type": "number",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"country_iso": {
"type": "string",
"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"
},
"is_default": {
"type": "boolean",
"default": false
},
"is_enabled": {
"type": "boolean",
"default": true
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true
}
}
},
"Virtual-Items-Currency_schemas-sku": {
"type": "string",
"example": "bundle_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"Virtual-Items-Currency_admin-get-vc_prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"amount"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"description": "金额。",
"type": "number",
"exclusiveMinimum": 0
},
"is_default": {
"type": "boolean",
"default": false
}
},
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true
}
}
},
"Virtual-Items-Currency_admin-image_url": {
"type": "string",
"description": "图片URL。为确保图片能在支付UI中正确显示并快速加载，请查看我们的图片和URL指南：- 支持的格式：WebP（推荐）、PNG、JPG。
- 文件大小：≤50 KB（WebP）或≤150 KB（PNG和JPG）。
- 图片尺寸：280 x 280 px。
- 色彩空间：sRGB。
- 协议：HTTPS，并对版本化URL使用长期缓存。
"
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "该商品是否免费。"
},
"value-is_paid_randomized_reward": {
"type": "boolean",
"example": false,
"default": false,
"description": "该商品是否为随机付费奖励，例如宝箱。"
},
"Virtual-Items-Currency_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "商品在商品目录中的显示顺序。值越大，商品在列表中的位置越靠下。\n如果值相同，则按创建日期排序，较新的商品显示位置更靠上。"
},
"Virtual-Items-Currency_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "商品是否可购。如果为`false`，则无法在商店中购买该商品，也无法通过捆绑包或营销活动获得该商品。关于商品可购性的详细信息，请参阅我们的[文档](https://developers.xsolla.com/zh/items-catalog/catalog-features/items-availability/)。"
},
"Virtual-Items-Currency_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "商品是否显示在商品目录中。如果为`false`且`is_enabled: true`，则该商品在商品目录中不可见，但可通过捆绑包或营销活动获得。关于商品可购性的详细信息，请参阅我们的[文档](https://developers.xsolla.com/zh/items-catalog/catalog-features/items-availability/)。"
},
"Virtual-Items-Currency_admin-regions": {
"description": "商品可购区域的数组。如果数组为空或未传递，则该商品在所有区域均可购。",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1,
"description": "项目内的区域ID。\n\n详细信息请参阅[区域销售限制文档](https://developers.xsolla.com/zh/items-catalog/catalog-features/regional-restrictions/)和[区域管理API调用](https://developers.xsolla.com/zh/api/catalog/common-regions)。"
}
}
}
},
"limit_exceeded_visibility": {
"type": "string",
"example": "show",
"enum": [
"show",
"hide"
],
"description": "设定商品在达到购买限制后、下次限制重置前在商品目录中的可见性。\n\n适用于在recurrent_schedule数组中配置了周期性重置数量限制的商品。\n\n如果未配置重置限制，则达到购买限制后，无论`limit_exceeded_visibility`的值如何，该商品都不会显示在商品目录中。\n\n可能值：\n- `show` — 达到购买限制后，商品目录检索API调用仍会返回该商品。在客户端侧\n商品目录检索API调用中，达到限制后返回的商品会带有`can_be_bought: false` 标志。下一次重置日期\n将在`reset_next_date`中返回。\n- `hide` — 达到购买限制后，在限制\n重置之前，商品目录检索API调用不会返回该商品。",
"default": "show"
},
"admin_recurrent_schedule_response": {
"type": [
"object",
"null"
],
"description": "限制数刷新周期。",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "用户的限制数刷新周期。",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "用户限制数按每日刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits refresh (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date and time of the first limit refresh (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date and time when limits should reset (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "用户限制数按每周刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": [
"integer",
"null"
],
"description": "Day of the week when the limits refresh. Where 1 is Monday and 7 is Sunday. Not `null` only for `weekly` limit refresh period type.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits refresh (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date and time of the first limit refresh (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date and time when limits should reset (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "用户限制数按每月刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": [
"integer",
"null"
],
"description": "Day of the month when limits refresh. If there's no selected day of the month as it's shorter, then the refresh will occur on the last day of the month. Not `null` only for `monthly` limit refresh period type.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits refresh (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date and time of the first limit refresh (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date and time when limits should reset (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Reset of the user limits performed at the specified time interval in hours.",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"description": "Interval in hours, after which the limit is updated.
The countdown starts from the moment the item is first displayed in the store, as specified in the date_from parameter.
For example, if `date_from = \"2025-11-15T18:15:00+05:00\"` and `hours_interval = 2`, the purchase limit for this item will refresh every 2 hours starting from `\"2025-11-15T20:15:00+05:00\"`.\n",
"minimum": 1,
"maximum": 10000
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits refresh (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Date and time of the first limit refresh (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Date and time when limits should reset (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
}
]
}
}
},
"admin-item-limit-response": {
"type": [
"object",
"null"
],
"description": "商品限制数。",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "单个用户的商品限制数。",
"properties": {
"total": {
"type": "integer",
"description": "单个用户可购买的最大商品数量。"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "全局商品限制数。",
"properties": {
"total": {
"type": "integer",
"description": "所有用户可购买的最大商品数量。"
},
"available": {
"type": "integer",
"description": "所有用户还可购买的剩余商品数量。"
},
"reserved": {
"type": "integer"
},
"sold": {
"type": "integer"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule_response"
}
}
},
"item-periods-response": {
"type": "array",
"description": "商品销售期。",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "指定商品开始可购的日期。"
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "指定商品停止可购的日期。可为`null`。"
}
}
}
},
"item-custom-attributes-response": {
"type": "object",
"description": "包含商品属性和值的JSON对象。",
"format": "json"
},
"Virtual-Items-Currency_admin-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"Virtual-Items-Currency_schemas-admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。为确保图片能在支付UI中正确显示并快速加载，请查看我们的图片和URL指南：- 支持的格式：WebP（推荐）、PNG、JPG。
- 文件大小：≤50 KB（WebP）或≤150 KB（PNG和JPG）。
- 图片尺寸：280 x 280 px。
- 色彩空间：sRGB。
- 协议：HTTPS，并对版本化URL使用长期缓存。
"
},
"Virtual-Items-Currency_admin-groups-create": {
"type": "array",
"description": "商品所属的[组外部ID](/zh/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response)列表。\n\n示例：[\"horror\", \"action\"]",
"items": {
"type": "string",
"properties": {
"external_id": {
"type": "string",
"example": "accessory"
},
"name": {
"type": "string",
"example": "Accessory"
}
}
}
},
"admin-post-put-attribute-item": {
"type": "object",
"required": [
"external_id",
"values"
],
"maxItems": 6,
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"description": "注意：每个属性最多可创建6个值。任何超出限制的尝试都会导致错误。
",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
}
},
"Virtual-Items-Currency_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "属性列表。\n\n注意：每个商品最多可指定20个属性。任何超出限制的尝试都会导致错误。
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Virtual-Items-Currency_admin-create-vc_prices": {
"description": "虚拟货币价格数组。",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"type": "integer",
"description": "以虚拟货币表示的商品价格。"
},
"is_default": {
"type": "boolean",
"default": false,
"description": "是否为默认虚拟货币价格。"
},
"is_enabled": {
"type": "boolean",
"default": true,
"description": "是否将此价格用于在商品目录中显示以及购买商品。如果为`false`，则不使用此价格。"
}
},
"required": [
"amount",
"sku",
"is_default",
"is_enabled"
],
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true,
"is_enabled": true
}
}
},
"limit_per_user": {
"description": "单个用户的商品限制数。",
"anyOf": [
{
"type": "null",
"description": "No per-user item purchase limit."
},
{
"type": "integer",
"description": "单个用户可购买的最大商品数量。",
"example": 5
},
{
"type": "object",
"description": "Detailed purchase limit configuration.",
"properties": {
"total": {
"type": "integer",
"description": "单个用户可购买的最大商品数量。",
"example": 5
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
}
]
},
"limit_per_item": {
"type": [
"integer",
"null"
],
"description": "全局商品限制数。",
"example": 10
},
"per_user_daily": {
"type": "object",
"title": "interval_type = daily",
"description": "用户限制数按每日刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "循环刷新周期。",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "02:00:00+03:00"
}
},
"required": [
"interval_type",
"time"
]
},
"per_user_weekly": {
"type": "object",
"title": "interval_type = weekly",
"description": "用户限制数按每周刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "循环刷新周期。",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": "integer",
"description": "在一周中的哪一天刷新限制数。其中1是星期一，7是星期日。",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "11:00:00+03:00"
}
}
},
"per_user_monthly": {
"type": "object",
"title": "interval_type = monthly",
"description": "用户限制数按每月刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "循环刷新周期。",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": "integer",
"description": "在一个月中的哪一天刷新限制数。如果由于较短的月没有选择具体哪一天，刷新将在该月的最后一天发生。",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "所需时区中的限制数刷新时间（四舍五入到小时）。",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "23:00:00+03:00"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
"interval_type_hourly": {
"type": "string",
"description": "循环刷新周期。",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_user_hourly_vi": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Interval in hours, after which the limit is reset.
The countdown starts from the date_from parameter.
For example, if `date_start = \"2025-11-15T18:15:00+05:00\"` and `hours_interval = 2`, the purchase limit for this item will reset every 2 hours starting from `\"2025-11-15T20:15:00+05:00\"`.\n"
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_item_recurrent_schedule": {
"type": [
"object",
"null"
],
"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"
}
]
}
}
},
"Virtual-Item-item-limit": {
"type": "object",
"description": "商品限制数。",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_item_recurrent_schedule"
}
}
},
"item-periods": {
"type": [
"array",
"null"
],
"description": "商品销售期。",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "指定商品开始可购的日期。"
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "指定商品停止可购的日期。可为`null`。"
}
}
}
},
"item-custom-attributes": {
"type": "object",
"description": "包含商品属性和值的JSON对象。属性可用于为商品添加更多信息，例如玩家使用该商品所需的等级。属性可丰富游戏的内部逻辑，并可通过专用GET方法和Webhook访问。",
"format": "json",
"maxLength": 500
},
"Virtual-Items-Currency_admin-create-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Item-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Virtual-Items-Currency_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"example": 10.5,
"description": "以真实货币表示的商品价格。"
},
"is_default": {
"type": "boolean",
"default": false,
"description": "是否为默认真实货币价格。价格设置的详细信息请参阅我们的[文档](https://developers.xsolla.com/zh/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)。"
},
"is_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "是否将此价格用于在商品目录中显示以及购买商品。如果为`false`，则不使用此价格，并会应用其他价格。价格设置的详细信息请参阅我们的[文档](https://developers.xsolla.com/zh/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)。"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。"
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"per_user_hourly_vc": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Interval in hours, after which the limit is reset.
The countdown starts from the date_from parameter.
For example, if `date_start = \"2025-11-15T18:15:00+05:00\"` and `hours_interval = 2`, the purchase limit for this item will reset every 2 hours starting from `\"2025-11-15T20:15:00+05:00\"`.\n"
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_recurrent_schedule": {
"type": [
"object",
"null"
],
"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"
}
]
}
}
},
"Virtual-Currency-item-limit": {
"type": "object",
"description": "商品限制数。",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"type": "object",
"required": [
"sku",
"name"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency-package": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"bundle_type": {
"type": "string",
"default": "virtual_currency_package",
"example": "virtual_currency_package"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"quantity": {
"type": "integer"
}
}
}
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"per_user_hourly_vcp": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Interval in hours, after which the limit is reset.
The countdown starts from the date_from parameter.
For example, if `date_start = \"2025-11-15T18:15:00+05:00\"` and `hours_interval = 2`, the purchase limit for this item will reset every 2 hours starting from `\"2025-11-15T20:15:00+05:00\"`.\n"
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_package_recurrent_schedule": {
"type": [
"object",
"null"
],
"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"
}
]
}
}
},
"Virtual-Currency-Package-item-limit": {
"type": "object",
"description": "商品限制数。",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"type": "object",
"required": [
"sku",
"name",
"description",
"content"
],
"anyOf": [
{
"required": [
"prices"
]
},
{
"required": [
"vc_prices"
]
}
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"content": {
"type": "array",
"minLength": 1,
"maxLength": 1,
"description": "虚拟货币套餐应仅包含1个对象，即虚拟货币。",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"quantity": {
"type": "integer"
}
}
}
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-Package-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "用作指示还有更多页面。"
},
"items_client_groups_response": {
"type": "array",
"example": [
{
"external_id": "exclusive",
"name": "Exclusive"
}
],
"default": [],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "组的唯一标识符，通常用于在API请求或外部系统中引用该组。",
"example": "exclusive"
},
"name": {
"type": "string",
"description": "组名称。",
"example": "Exclusive"
},
"item_order_in_group": {
"type": "integer",
"description": "商品在组中的位置，用于确定其显示顺序。\n仅当通过additional_fields[]查询参数方式请求时，响应中才包含此字段。",
"example": 1
}
}
}
},
"Virtual-Items-Currency_client-attributes": {
"type": "array",
"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"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "object",
"description": "属性名称。",
"example": "Genre",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "属性值。",
"example": "Strategy"
}
}
}
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "如为`true`，则用户可以购买商品。"
},
"Catalog_item_promotions": {
"type": "array",
"description": "应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：\n\n* 为某商品配置了折扣促销活动。\n\n* 应用了具有**对所选商品提供折扣**设置的兑换码。\n\n如果未应用任何商品级促销活动，则返回空数组。",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "赠品类型。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "赠品名称。不适用于`physical_good`赠品类型。"
},
"image_url": {
"type": "string",
"description": "赠品图片URL。不适用于`physical_good`赠品类型。"
},
"bundle_type": {
"type": "string",
"description": "赠品捆绑包商品类型。仅适用于`bundle`赠品类型。",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"catalog_recurrent_schedule_client_response": {
"type": [
"object",
"null"
],
"description": "用户的商品限制循环刷新周期。",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "用户限制数按每日刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"daily"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits reset (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "用户限制数按每周刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"weekly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits reset (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "用户限制数按每月刷新。",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"monthly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits reset (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Reset of the user limits performed at the specified time interval in hours.",
"properties": {
"interval_type": {
"type": "string",
"description": "Recurrent refresh period type.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Date and time when limits reset (Unix Timestamp).",
"example": 1677553200
}
}
}
]
},
"client-item-limit-response": {
"type": [
"object",
"null"
],
"description": "商品限制数。",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "单个用户的商品限制数。",
"properties": {
"total": {
"type": "integer",
"description": "单个用户可购买的最大商品数量。"
},
"available": {
"type": "integer",
"description": "当前用户可购买的剩余商品数量。"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "全局商品限制数。",
"properties": {
"total": {
"type": "integer",
"description": "所有用户可购买的最大商品数量。"
},
"available": {
"type": "integer",
"description": "所有用户还可购买的剩余商品数量。"
}
}
}
}
},
"item_id": {
"type": "integer",
"example": 1,
"description": "内部唯一商品ID。"
},
"value-point-sku": {
"type": "string",
"description": "唯一累充积分ID。"
},
"value-point-amount": {
"type": "integer",
"description": "累充积分数量。"
},
"value-point-name": {
"type": "string",
"description": "累充积分名称。"
},
"Common_admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"is_clan": {
"type": "boolean",
"description": "累充积分是否用于公会累充奖励链。",
"example": true
},
"client-item-value-point-reward": {
"type": "array",
"description": "累充积分商品奖励。",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"Virtual-Items-Currency_item": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "商品ID。"
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "object",
"example": "Big Rocket",
"description": "商品名称。",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。"
},
"description": {
"type": "object",
"example": "Big Rocket - description",
"description": "商品描述。",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "vc_test",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/client-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Catalog_item_limits": {
"description": "商品限制数。",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "单个用户的商品购买数量限制。",
"properties": {
"total": {
"type": "integer",
"description": "单个用户可购买的最大商品数量。",
"example": 5
},
"available": {
"type": "integer",
"description": "当前用户可购买的剩余商品数量。",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "单个商品的购买数量限制。",
"properties": {
"total": {
"type": "integer",
"description": "所有用户可购买的最大商品数量。",
"example": 5
},
"available": {
"type": "integer",
"description": "所有用户还可购买的剩余商品数量。",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Virtual-Items-Currency_virtual-currency": {
"type": "object",
"properties": {
"item_id": {
"type": "integer"
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。"
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
}
}
},
"virtual_prices": {
"type": "array",
"example": [
{
"amount": 100,
"sku": "com.xsolla.crystals_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png"
}
],
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "com.xsolla.vc_1",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "Crystals",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"type": "array"
}
}
},
"Virtual-Items-Currency_virtual-currency-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_virtual-currency-package": {
"type": "object",
"properties": {
"item_id": {
"type": "integer"
},
"sku": {
"type": "string",
"example": "crystal-pack",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Crystal Pack",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "bundle",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。"
},
"bundle_type": {
"type": "string",
"example": "virtual_currency_package",
"description": "捆绑包类型：`standard`/`virtual_currency_package`。"
},
"description": {
"type": "string",
"example": "Crystal Pack Description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "vc_test",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"type": "array",
"example": [
{
"description": "Crystal Pack - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.crystal_pack_1",
"name": "Crystal Pack",
"type": "virtual_currency",
"quantity": 100
}
],
"description": "虚拟货币套餐内容。",
"items": {
"type": "object",
"description": "套餐中的虚拟货币。",
"properties": {
"item_id": {
"type": "integer"
},
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"quantity": {
"type": "integer",
"example": 250,
"description": "套餐中的虚拟货币数量。"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"type": "array"
}
}
},
"Virtual-Items-Currency_virtual-currency-packages": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"group-name-localization-object": {
"type": [
"object",
"null"
],
"description": "包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-description-localization-object": {
"type": [
"object",
"null"
],
"description": "包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，`en`）或五个字符的区域设置代码（例如，`en-US`）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：`en`和`en-US`），将存储最后提供的值。您可以在[文档](/zh/doc/shop-builder/references/supported-languages/)中找到支持语言的完整列表。",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-image-url": {
"type": [
"string",
"null"
],
"description": "商品组图片的URL。",
"example": "https://example.com/weapons.png"
},
"group-display-order": {
"type": "integer",
"description": "商品组在商品目录中的显示顺序。值越大，商品组在列表中的位置越靠下。如果值相同，则按创建日期排序，较新的商品组显示位置更靠上。",
"default": 1,
"example": 1
},
"group-is-enabled": {
"type": "boolean",
"description": "商品组是否在商品目录中启用。",
"example": true,
"default": true
},
"admin-group-response-base": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "由艾克索拉分配的商品组ID。",
"example": 1
},
"external_id": {
"type": "string",
"description": "创建时指定的外部商品组ID。",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/group-image-url"
},
"order": {
"$ref": "#/components/schemas/group-display-order"
},
"is_enabled": {
"$ref": "#/components/schemas/group-is-enabled"
},
"items_count": {
"type": "integer",
"description": "组内商品总数。",
"example": 5
}
},
"required": [
"id",
"external_id",
"name",
"is_enabled"
]
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP响应状态。"
},
"errorCode": {
"type": "integer",
"description": "错误代码。"
},
"errorMessage": {
"type": "string",
"description": "错误简要说明。"
},
"transactionId": {
"type": "string",
"description": "请求ID。用于跟踪与此特定请求或操作相关的日志条目，并将其关联起来的ID。此ID可用于故障排查、调试和审计。"
}
}
},
"admin-group-create-request": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "商品组的外部ID。只能包含字母、数字、连字符和下划线。",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
],
"default": true
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "商品组数据。",
"required": [
"external_id",
"name"
]
},
"error-message-extended-validation": {
"type": "array",
"description": "验证错误详情。包含属性级错误数组，用于说明哪些字段未通过验证及原因。\n",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "未通过验证的字段名称。",
"example": "external_id"
},
"message": {
"type": "string",
"description": "字段的验证错误消息。",
"example": "The property external_id is required"
}
}
}
},
"422-invalid-request": {
"type": "object",
"required": [
"statusCode",
"errorCode",
"errorMessage",
"transactionId"
],
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP响应状态。",
"example": 422
},
"errorCode": {
"type": "integer",
"description": "错误代码。",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "错误简要说明。",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"description": "请求ID。用于跟踪与此特定请求或操作相关的日志条目，并将其关联起来的ID。此ID可用于故障排查、调试和审计。",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
}
}
},
"admin-group-update-request": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"external_id": {
"type": "string",
"description": "唯一组外部ID。只能包含字母、数字、连字符和下划线。可用于重命名组的外部ID。",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
]
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "要更新的商品组数据。每个请求中都必须包含`external_id`和`name`字段。其他字段为可选字段⸺未传递的字段将保留当前值。\n",
"required": [
"external_id",
"name"
]
},
"group-is-contains-any-items": {
"type": "boolean",
"description": "该组是否包含任何商品，与指定的`item_type`无关。对于指定类型，某个组的items_count可以为0；但如果该组包含其他类型的商品，则`is_contains_any_items`为`true`。",
"example": true
},
"admin-group-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"admin-group-detail-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"item-in-group-order-request-item": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "由艾克索拉分配的内部商品ID。请使用[商品目录API调用](/zh/api/catalog/common-catalog)响应中返回的商品ID。",
"minimum": 0,
"example": 101
},
"order": {
"type": "integer",
"description": "新的显示顺序值。",
"minimum": 0,
"example": 1
}
},
"required": [
"item_id",
"order"
],
"additionalProperties": false
},
"Cart-Payment_custom_parameters": {
"description": "以有效JSON键值对集合表示的自定义参数。
\n您可以通过此字段传递其他参数，以配置反欺诈过滤器。具体请[参阅支付收银台文档](https://developers.xsolla.com/zh/doc/pay-station/features/antifraud/)。",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"null_param": null
}
}
},
"Game-Keys_schemas-client-attributes": {
"type": "array",
"description": "与商品对应的属性及其值的列表。可用于商品目录筛选。",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "属性名称。",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "属性值。",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_admin-attributes": {
"type": "array",
"description": "属性列表。",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Game-Keys_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
}
}
}
},
"Game-Keys_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "属性列表。\n\n注意：每个商品最多可指定20个属性。任何超出限制的尝试都会导致错误。
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"game_key_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "限制数刷新周期。",
"properties": {
"per_user": {
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
}
]
}
}
},
"Game-key-item-limit": {
"type": "object",
"description": "商品限制数。",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/game_key_recurrent_schedule"
}
}
},
"Game-Keys_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Pagination_total-items-count": {
"type": "integer",
"example": 10,
"description": "系统中的商品总数。"
},
"Game-Keys_client_name": {
"type": "string",
"example": "The Greatest Game in the World",
"description": "游戏套餐名称。"
},
"Game-Keys_description": {
"type": "string",
"example": "Description of the greatest game in the world.",
"description": "游戏套餐描述。"
},
"Game-Keys_project_id": {
"type": "integer",
"example": 44056,
"description": "项目ID。您可以在[发布商帐户](https://publisher.xsolla.com/)的项目名称旁边找到。"
},
"Game-Keys_game_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "theGreatestGameSku",
"description": "唯一游戏Key套餐ID。"
},
"Game-Keys_drm_sku": {
"type": "string",
"example": "steam",
"description": "唯一DRM ID。",
"enum": [
"steam",
"playstation",
"xbox",
"uplay",
"origin",
"drmfree",
"gog",
"epicgames",
"nintendo_eshop",
"discord_game_store",
"oculus",
"rockstar",
"viveport",
"stadia"
]
},
"Game-Keys_image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。为确保图片能在支付UI中正确显示并快速加载，请查看我们的图片和URL指南：- 支持的格式：WebP（推荐）、PNG、JPG。
- 文件大小：≤50 KB（WebP）或≤150 KB（PNG和JPG）。
- 图片尺寸：280 x 280 px。
- 色彩空间：sRGB。
- 协议：HTTPS，并对版本化URL使用长期缓存。
"
},
"Game-Keys_admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "唯一属性ID。 `external_id`只能包含大小写英文字母、数字、短横线和下划线。"
},
"Game-Keys_value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "属性的唯一值ID。 `external_id`只能包含小写英文字母、数字、短横线和下划线。"
},
"Game-Keys_client-attributes": {
"type": "array",
"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"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "属性名称。",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_value-external_id"
},
"value": {
"type": "string",
"description": "属性值。",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_entitlement_item": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Game-Keys_client_name"
},
"description": {
"$ref": "#/components/schemas/Game-Keys_description"
},
"project_id": {
"$ref": "#/components/schemas/Game-Keys_project_id"
},
"game_sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
},
"drm": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
},
"image_url": {
"$ref": "#/components/schemas/Game-Keys_image_url"
},
"is_pre_order": {
"type": "boolean",
"example": false,
"description": "游戏是否处于预售状态。"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_client-attributes"
}
}
},
"Bundles_item_id": {
"type": "integer",
"example": 1,
"minLength": 1,
"maxLength": 255,
"description": "内部唯一商品ID。"
},
"Bundles_sku": {
"type": "string",
"example": "bundle_1",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"Bundles_admin-attributes": {
"type": "array",
"description": "属性列表。",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Bundles_type": {
"type": "string",
"example": "bundle",
"description": "商品类型。"
},
"bundle_type": {
"type": "string",
"description": "捆绑包类型。当商品类型为捆绑包时返回。",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"Bundles_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "图片URL。为确保图片能在支付UI中正确显示并快速加载，请查看我们的图片和URL指南：- 支持的格式：WebP（推荐）、PNG、JPG。
- 文件大小：≤50 KB（WebP）或≤150 KB（PNG和JPG）。
- 图片尺寸：280 x 280 px。
- 色彩空间：sRGB。
- 协议：HTTPS，并对版本化URL使用长期缓存。
"
},
"Bundles_groups_response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "商品名称。应包含键/值对，\n其中键是\"^[a-z]{2}\"格式的区域设置，值是字符串。",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Bundles_amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
},
"Bundles_prices": {
"type": "array",
"description": "以真实货币表示的价格。",
"items": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
},
"is_default": {
"type": "boolean",
"description": "如果未指定用户币种的价格，则使用默认价格生成商品目录。"
},
"is_enabled": {
"type": "boolean",
"description": "价格已启用。"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_vc-type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"Bundles_amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency-is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品的默认价格。"
},
"Bundles_admin-response-virtual_price": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_vc-type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"is_default": {
"$ref": "#/components/schemas/Bundles_currency-is_default"
}
}
},
"Bundles_media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "捆绑包的附加资源。",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "媒体类型：`image`/`video`。"
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "资源文件。"
}
}
}
},
"Bundles_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "捆绑包在列表中的排序优先级。"
},
"Bundles_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "如果禁用，则无法找到和购买该商品。"
},
"Bundles_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "商品可供购买。"
},
"Bundles_admin-regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1
}
}
}
},
"Bundles_admin_content_response": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"quantity": {
"type": "integer",
"description": "捆绑包中该商品类型的数量。",
"default": 1,
"minimum": 1
}
}
},
"Bundles_total_content_price": {
"type": [
"object",
"null"
],
"description": "捆绑包内容价格总和。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "捆绑包内容折后价格总和。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "捆绑包内容价格总和。"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_admin_bundle_response": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"virtual_prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin-response-virtual_price"
}
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_content_response"
}
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
}
},
"description": "指定的捆绑包。"
},
"Bundles_groups_request": {
"type": "array",
"example": [
"honor"
],
"default": [],
"description": "商品所属分组。\n\n注：字符串值表示组`external_id`。
",
"items": {
"type": "string"
}
},
"Bundles_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "属性列表。\n\n注意：每个商品最多可指定20个属性。任何超出限制的尝试都会导致错误。
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Bundles_vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"amount": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_bundle_type": {
"type": "string",
"example": "standard",
"enum": [
"standard",
"partner_side_content"
],
"description": "捆绑包类型。使用`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)。",
"default": "standard"
},
"Bundles_admin_content_request": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"quantity": {
"type": "integer",
"description": "捆绑包中所选商品的数量。",
"default": 1,
"minimum": 1
}
},
"required": [
"sku"
],
"example": {
"sku": "com.xsolla.kg_1",
"quantity": 1
}
}
},
"per_user_hourly_bundle": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Interval in hours, after which the limit is reset.
The countdown starts from the date_from parameter.
For example, if `date_start = \"2025-11-15T18:15:00+05:00\"` and `hours_interval = 2`, the purchase limit for this item will reset every 2 hours starting from `\"2025-11-15T20:15:00+05:00\"`.\n"
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"bundle_recurrent_schedule": {
"type": [
"object",
"null"
],
"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"
}
]
}
}
},
"bundle-item-limit": {
"type": "object",
"description": "商品限制数。",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/bundle_recurrent_schedule"
}
}
},
"Bundles_admin_bundle_request": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_request"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-post-put-attributes"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"vc_prices": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_vc_prices"
},
{
"type": "null"
}
]
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Bundles_admin_content_request"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/bundle-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
},
"description": "指定的捆绑包。",
"required": [
"sku",
"name",
"description"
]
},
"Bundles_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Bundles_client_name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"Bundles_client_description": {
"type": [
"string",
"null"
],
"example": "Big Rocket - description.",
"description": "商品描述。"
},
"Bundles_client-attributes": {
"type": "array",
"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"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "属性名称。",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "属性值。",
"example": "Strategy"
}
}
}
}
}
}
},
"Bundles_price": {
"type": [
"object",
"null"
],
"description": "商品价格。",
"required": [
"amount",
"amount_without_discount",
"currency"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "以虚拟货币表示的商品价格。"
},
"sku": {
"type": "string",
"example": "gold",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品的默认价格。"
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "Gold",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": [
"string",
"null"
],
"example": "Most popular gold",
"description": "Virtual currency description."
}
}
}
},
"Catalog_item_limits_with_hourly": {
"description": "商品限制数。",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "单个用户的商品购买数量限制。",
"properties": {
"total": {
"type": "integer",
"description": "单个用户可购买的最大商品数量。",
"example": 5
},
"available": {
"type": "integer",
"description": "当前用户可购买的剩余商品数量。",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "单个商品的购买数量限制。",
"properties": {
"total": {
"type": "integer",
"description": "所有用户可购买的最大商品数量。",
"example": 5
},
"available": {
"type": "integer",
"description": "所有用户还可购买的剩余商品数量。",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Bundles_client_content": {
"type": "array",
"example": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
}
}
],
"description": "捆绑包套餐内容。",
"items": {
"type": "object",
"description": "套餐中的商品。",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"quantity": {
"type": "integer",
"example": 250,
"description": "套餐中的商品数量。"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"price": {
"type": [
"object",
"null"
],
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "vc_test",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品的默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
}
}
}
},
"Bundles_client_bundle": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/Bundles_client_name"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"description": {
"$ref": "#/components/schemas/Bundles_client_description"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"$ref": "#/components/schemas/Bundles_price"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"virtual_prices": {
"$ref": "#/components/schemas/Bundles_virtual_prices"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"$ref": "#/components/schemas/Bundles_client_content"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"media_list": {
"$ref": "#/components/schemas/Bundles_media_list"
}
},
"description": "指定的捆绑包。"
},
"value-cart_is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "如果为`true`，则购物车为免费。"
},
"Cart-Payment_client-attributes": {
"type": "array",
"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"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "属性名称。",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "属性值。",
"example": "Strategy"
}
}
}
}
}
}
},
"Catalog_cart_promotions": {
"type": "array",
"description": "应用于整个购物车的促销活动。仅在以下情况下返回该数组：\n\n* 促销活动影响购物车总金额，例如使用了具有**对购买项提供折扣设置**的兑换码。\n\n* 促销活动向购物车添加了赠品。\n\n如果未应用任何订单级促销，则返回空数组。",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "赠品类型。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "赠品名称。不适用于`physical_good`赠品类型。"
},
"image_url": {
"type": "string",
"description": "赠品图片URL。不适用于`physical_good`赠品类型。"
},
"bundle_type": {
"type": "string",
"description": "赠品捆绑包商品类型。仅适用于`bundle`赠品类型。",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"Cart-Payment_settings_ui": {
"description": "界面设置。",
"type": "object",
"additionalProperties": false,
"properties": {
"theme": {
"description": "支付UI主题。可以是`63295a9a2e47fab76f7708e1`（浅色主题（默认）），或`63295aab2e47fab76f7708e3`（深色主题）。您也可以[创建自定义主题](https://developers.xsolla.com/zh/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)，然后在此参数中传入其ID。",
"type": "string",
"default": "63295a9a2e47fab76f7708e1",
"enum": [
"63295a9a2e47fab76f7708e1",
"63295aab2e47fab76f7708e3"
]
},
"desktop": {
"type": "object",
"additionalProperties": false,
"description": "桌面版的界面设置。",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"description": "页眉设置。",
"properties": {
"is_visible": {
"type": "boolean",
"description": "是否在支付UI中显示页眉。"
},
"visible_logo": {
"type": "boolean",
"description": "如果为`true`，则在页眉中显示Logo。如需上传图片，请在[发布商帐户](https://publisher.xsolla.com/)中打开项目，并前往支付收银台>设置部分。"
},
"visible_name": {
"type": "boolean",
"description": "是否在页眉中显示项目名称。"
},
"visible_purchase": {
"type": "boolean",
"description": "是否在页眉中显示购买描述（`purchase.description.value`）。默认为`true`。",
"default": true
},
"type": {
"type": "string",
"description": "页眉的显示方式。可为`compact`（隐藏项目名称和用户ID）或`normal`（默认）。",
"default": "normal",
"enum": [
"compact",
"normal"
]
},
"close_button": {
"type": "boolean",
"description": "是否在桌面端支付UI中显示**关闭**按钮。该按钮将关闭支付UI并将用户重定向到`settings.return_url`参数中指定的URL。默认为`false`。",
"default": false
}
}
}
}
},
"mode": {
"type": "string",
"enum": [
"user_account"
],
"description": "支付UI的界面模式。只能是`user_account`。请注意，页眉仅包含用户帐户的导航菜单，而没有用于选择产品或进行付款的任何选项。此模式仅适用于桌面端。"
},
"user_account": {
"type": "object",
"additionalProperties": false,
"description": "用户帐户详细信息。",
"properties": {
"payment_accounts": {
"type": "object",
"additionalProperties": false,
"description": "**我的支付帐户**子菜单。",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "是否显示子菜单。默认为`false`。"
}
},
"required": [
"enable"
]
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "**我的帐户**页面。",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "是否显示子菜单。默认为`false`。"
},
"order": {
"type": "integer",
"minimum": 1,
"description": "子菜单在菜单中的位置。"
}
},
"required": [
"enable",
"order"
]
},
"subscriptions": {
"type": "object",
"additionalProperties": false,
"description": "**管理订阅**子菜单。",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "是否显示子菜单。默认为`false`。"
},
"order": {
"type": "integer",
"minimum": 1,
"description": "子菜单在菜单中的位置。"
}
},
"required": [
"enable",
"order"
]
}
}
},
"header": {
"type": "object",
"properties": {
"visible_virtual_currency_balance": {
"type": "boolean",
"additionalProperties": false,
"description": "此元素是否可在支付UI中隐藏。",
"default": true
}
}
},
"mobile": {
"type": "object",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"close_button": {
"type": "boolean",
"description": "是否在移动端支付UI中显示**关闭**按钮。该按钮将关闭支付UI并将用户重定向到`settings.return_url`参数中指定的URL。",
"default": false
}
}
}
}
},
"is_prevent_external_link_open": {
"type": "boolean",
"description": "是否禁用指向外部资源的重定向链接。点击外部链接时，会通过`postMessage`机制发送`external-link-open`事件。重定向链接地址通过`url`参数传递。",
"default": false
},
"is_payment_methods_list_mode": {
"type": "boolean",
"description": "打开支付UI时，是否显示用户所在国家/地区可用的支付方式列表。如果为`false`（默认），则显示`settings.payment_method`参数中传入的支付方式，或由[PayRank算法](https://developers.xsolla.com/zh/solutions/payments/payment-ui-management/top-payment-methods-management/)选择的支付方式。",
"default": false
},
"is_independent_windows": {
"type": "boolean",
"description": "是否将用户从嵌入式启动器浏览器(WebView)跳转到其默认浏览器进行购买。",
"default": false
},
"currency_format": {
"type": "string",
"description": "设置为`code`时，将在支付UI中显示三字母[ISO 4217](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)币种代码。默认显示币种符号，而不是三字母币种代码。"
},
"is_show_close_widget_warning": {
"type": "boolean",
"description": "关闭支付页面前，将鼠标悬停在**×**图标上时，是否显示关于交易处理中的警告。如果传入`false`或未传入该参数，则不显示警告。",
"default": true
},
"layout": {
"type": "string",
"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"
]
},
"is_three_ds_independent_windows": {
"type": "boolean",
"description": "是否在新浏览器窗口中打开3-D Secure检查。如果您的配置强制执行内容安全政策(CSP)，请设置为`true`。",
"default": false
},
"is_cart_open_by_default": {
"type": "boolean",
"description": "打开移动版支付UI时购物车中商品列表的显示方式。如果为`true`，列表将以展开视图显示。如果为`false`（默认）或未传入该参数，列表将以折叠视图显示。",
"default": false
}
}
},
"Cart-Payment_settings_payment_method": {
"type": "integer",
"description": "支付方式ID。它决定收银台页面中的币种显示方式，因为某些支付方式可能仅支持特定币种。",
"minimum": 1
},
"Cart-Payment_settings_return_url": {
"type": "string",
"format": "uri",
"description": "付款后将用户重定向到的页面。系统会自动将`user_id`、`foreigninvoice`、`invoice_id`和`status`参数添加到链接中。",
"maxLength": 1000
},
"Cart-Payment_redirect_policy": {
"type": "object",
"properties": {
"redirect_conditions": {
"description": "触发用户跳转到返回URL的支付状态。",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"delay": {
"description": "用户自动跳转到返回URL前的延迟时间。",
"type": "integer",
"example": 0
},
"status_for_manual_redirection": {
"description": "触发显示跳转按钮的支付状态，点击该按钮会将用户重定向到返回URL。",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"redirect_button_caption": {
"description": "本地化的重定向按钮文字。",
"type": "string",
"example": "Text button"
}
}
},
"Cart-Payment_settings_sandbox": {
"type": "boolean",
"description": "设置为`true`以测试付款流程。在这种情况下，请使用https://sandbox-secure.xsolla.com访问测试支付UI。",
"default": false
},
"Cart-Payment_admin-user-request-body": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "object",
"properties": {
"value": {
"description": "用户ID。测试时可传入任意值。如需接受真实付款，您需要使用自己系统中的用户ID值。此ID会在[用户验证](https://developers.xsolla.com/zh/webhooks/operation/user-validation/)Webhook中传递。",
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"name": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "用户显示名称。"
}
}
},
"email": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"format": "email",
"description": "用户邮箱。必须符合RFC 822协议。"
}
}
},
"country": {
"type": "object",
"properties": {
"value": {
"type": "string",
"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"
},
"allow_modify": {
"type": "boolean",
"description": "用户是否可以在支付UI中更改国家/地区。",
"default": false,
"example": false
}
}
},
"age": {
"type": "integer",
"description": "用户年龄。"
},
"phone": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "用户手机号码。"
},
"allow_modify": {
"type": "boolean",
"description": "用户是否可以在支付UI中更改手机号。如果令牌中传入了`phone.value`值，则值默认为`false`。",
"default": false,
"example": false
},
"hidden": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"tracking_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9]{32}$",
"description": "唯一跟踪ID（用于营销活动）。"
}
}
},
"steam_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 17,
"maxLength": 17,
"pattern": "^\\d{17}$",
"description": "Steam ID。"
}
}
},
"is_legal": {
"type": "boolean",
"description": "用户是否为法人实体。"
},
"legal": {
"type": "object",
"description": "包含法人实体详情的对象。如果`user.is_legal`为`true`，则此对象及其所有参数均为必填。",
"properties": {
"name": {
"type": "string",
"description": "完整法定名称。"
},
"address": {
"type": "string",
"description": "完整法定地址。"
},
"vat_id": {
"type": "string",
"description": "个人纳税人识别号。"
},
"country": {
"type": "string",
"description": "注册成立国家/地区。使用符合[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准的两字母大写国家/地区代码。"
}
}
}
}
},
"Cart_admin_payment": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。\n\n注意
如需多次销售同一SKU，请在purchase.items[].quantity参数中指定所需数量。数组中不支持重复SKU⸺创建令牌时仅使用第一次出现的SKU。在这种情况下不会返回错误。
",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "商品的数量。"
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "区分大小写的唯一兑换码。包含字母和数字。",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Cart-Payment_settings_currency": {
"type": "string",
"description": "首选支付币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母币种代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"Cart-Payment_settings_locale": {
"type": "string",
"description": "界面语言。两字母小写[语言代码](https://developers.xsolla.com/zh/doc/pay-station/features/localization/)。"
},
"Cart-Payment_settings_external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "交易外部ID。"
},
"Cart-Payment_custom_parameters_token": {
"description": "以有效JSON键值对集合表示的自定义参数。
\n您可以通过此字段传递其他参数，以配置反欺诈过滤器。具体请[参阅支付收银台文档](https://developers.xsolla.com/zh/doc/pay-station/features/antifraud/)。",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"number_param": 12.5,
"null_param": null
}
}
},
"422-invalid-request-2": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "响应状态码。",
"example": 422
},
"errorCode": {
"type": "number",
"description": "错误代码。",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "可读的错误消息。",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
},
"transactionId": {
"type": "string",
"description": "请求的唯一ID。",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"Cart": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"example": "US",
"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`"
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "USD",
"description": "购物车中显示的商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "商品的数量。"
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"User-limit_user-external-id": {
"description": "用户外部ID。",
"type": "string",
"minLength": 1,
"pattern": "^\\S+$"
},
"User-limit_user": {
"type": "object",
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
},
"required": [
"user_external_id"
]
},
"User-limit_user_flexible": {
"type": [
"object",
"null"
],
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
}
},
"User-limit-item": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "用户可以购买的最大商品数量。"
},
"available": {
"type": "integer",
"example": 9,
"description": "用户可以购买的剩余商品数量。"
}
}
}
}
},
"User-limit_available_flexible": {
"type": "integer",
"minimum": 0,
"description": "在已应用的限制内，用户还可购买的商品数量或还可使用促销活动的次数。"
},
"User-limit_available": {
"type": "integer",
"minimum": 1,
"description": "在已应用的限制内，用户还可购买的商品数量或还可使用促销活动的次数。"
},
"Regions_region_id": {
"type": "integer",
"description": "区域ID。项目内的唯一区域标识符。",
"example": 42
},
"Regions_name": {
"type": "object",
"description": "区域名称。应该包含键/值对，其中键是\"^[a-z]{2}-[A-Z]{2}$\"格式的区域位置，值是字符串。",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Asia",
"de-DE": "Asien"
},
"default": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
"Regions_200-region-short-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
}
},
"Regions_countries": {
"type": "array",
"description": "要添加到区域中的国家/地区列表。\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\"]`\n",
"items": {
"type": "string"
}
},
"Regions_200-region-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
},
"countries": {
"$ref": "#/components/schemas/Regions_countries"
}
},
"example": {
"value": {
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
},
"admin_attribute_response": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
},
"example": {
"value": [
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
},
"schemas-422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"request-attribute-value": {
"type": "object",
"required": [
"external_id",
"value"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_id",
"value": {
"en": "Value",
"de": "Wert"
}
}
},
"404-not-found": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0000-0000]: Entity not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"responses": {
"Virtual-Items-Currency_200-admin-get-virtual-items": {
"description": "已成功收到虚拟物品列表。",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_1",
"name": {
"en": "Maximum Armor Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Suit up with flair showcasing your allegiance to Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"long_description": {
"en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "featured",
"name": {
"en": "featured"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "Premium",
"name": {
"en": "Premium"
}
},
{
"external_id": "NonConsumableGroupCode",
"name": {
"en": "Non-consumable"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_large_3",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Virtual-Items-Currency_201-created": {
"description": "已成功创建虚拟物品。",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_1"
}
}
},
"schema": {
"type": "object",
"example": {
"sku": "com.xsolla.item_1"
},
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
}
}
}
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-items-by-group": {
"description": "已成功收到虚拟物品列表。",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_lrg_2",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-item": {
"description": "已成功收到指定的虚拟物品。",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.swords_1",
"name": {
"en": "Sword Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"long_description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
},
{
"external_id": "weapon",
"name": {
"en": "weapon"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currencies": {
"description": "已成功收到虚拟货币列表。",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency": {
"description": "已成功接收指定的虚拟货币。",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
},
"Virtual-Items-Currency_404-item": {
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-packages": {
"description": "已成功收到虚拟货币套餐列表。",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.crystal_pack_2",
"name": {
"en": "Medium crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_2",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.crystal_pack_3",
"name": {
"en": "Massive crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_3",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_1",
"name": {
"en": "Small gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_2",
"name": {
"en": "Medium gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_2",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_3",
"name": {
"en": "Large gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_3",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-package": {
"description": "已成功接收指定的虚拟货币套餐。",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-list": {
"description": "已成功收到虚拟物品列表。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": {
"en": "Big Rocket"
},
"groups": [
{
"external_id": "accessory",
"name": "accessory",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "Big Rocket - description"
},
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": null,
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{
"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{
"quantity": 1,
"name": "Super Lootbox with items",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-item-by-sku": {
"description": "已成功接收虚拟物品。",
"content": {
"application/json": {
"example": {
"item_id": 488833,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"name": {
"en": "Sword Xsolla Skin"
},
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 3,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1761840000
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": "VALUE"
},
{
"external_id": "val2",
"value": "VALUE2"
}
]
}
],
"is_free": false,
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Virtual-Items-Currency_200-get-all-items-list": {
"description": "已成功接收所有虚拟物品列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "含虚拟物品的对象。",
"properties": {
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"groups": {
"type": "array",
"properties": {
"external_id": {
"type": "string",
"example": "weapons"
},
"name": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
}
}
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "商品描述。"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"description": "Big Rocket - description"
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"description": "description"
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"description": "description"
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-list": {
"description": "已成功接收虚拟货币列表。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_currency",
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.shotgun_raider_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_3",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"attributes": [],
"type": "virtual_currency",
"description": "description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency": {
"description": "已成功收到虚拟货币。",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 451414,
"sku": "com.xsolla.crystal_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"is_free": false,
"groups": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-list": {
"description": "已成功收到虚拟货币套餐列表。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"quantity": 200
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-package": {
"description": "已成功接收虚拟货币套餐。",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 488832,
"sku": "com.xsolla.crystal_pack_1",
"type": "bundle",
"name": "Crystal Pack",
"bundle_type": "virtual_currency_package",
"description": "Crystal Pack Short Description",
"image_url": "http://vc_package_image.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 1,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1690732800
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 488831,
"sku": "com.xsolla.crystals_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystal - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"quantity": 10,
"limits": null
}
],
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-by-group-id": {
"description": "已成功接收指定组中的商品列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型：`consumable`/`expiration`/`permanent`/`lootboxes`/`physical`。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "com.xsolla.vc_1",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_404-item-group": {
"description": "未找到组。请确保`external_id`正确，且该组未关闭或删除。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4403
},
"errorMessage": {
"type": "string",
"example": "[0401-4403]: Item group not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found"
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-items-groups": {
"description": "已成功接收组列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"example": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": null,
"order": 1
},
{
"external_id": "group_external_id",
"name": "Super",
"description": "Super description",
"image_url": null,
"order": 1
}
],
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "weapons",
"description": "外部组ID。"
},
"name": {
"type": "string",
"example": "Weapons",
"description": "组名称。"
},
"description": {
"type": "string",
"example": "All weapons available in the game",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "图片URL。"
},
"order": {
"type": "integer",
"example": 1,
"description": "定义排列顺序。"
},
"level": {
"type": "integer",
"example": 0,
"description": "组嵌套层级。"
},
"children": {
"type": "array",
"example": [
{
"external_id": "background",
"name": "Background",
"description": "Background description",
"image_url": null,
"order": 1,
"level": 1,
"children": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"parent_external_id": "weapons"
}
],
"description": "子组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "background",
"description": "外部组ID。"
},
"name": {
"type": "string",
"example": "Background",
"description": "组名称。"
},
"description": {
"type": "string",
"example": "Background description",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "组图片URL。"
},
"order": {
"type": "integer",
"example": 1,
"description": "定义排列顺序。"
},
"level": {
"type": "integer",
"example": 1,
"description": "组嵌套层级。"
},
"children": {
"type": "array",
"example": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"description": "子组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "accessory",
"description": "外部组ID。"
},
"name": {
"type": "string",
"example": "Accessory",
"description": "组名称。"
},
"description": {
"type": "string",
"example": "Accessory",
"description": "Group description."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "图片URL。"
},
"order": {
"type": "integer",
"example": 1,
"description": "定义排列顺序。"
},
"level": {
"type": "integer",
"example": 2,
"description": "组嵌套层级。"
},
"children": {
"type": "array",
"example": [],
"description": "子组。",
"items": {
"type": "string"
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "background",
"description": "父级外部组ID。"
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "weapons",
"description": "父级外部组ID。"
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": null,
"description": "父级外部组ID。"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": "https://example.com/groups/weapons.png",
"order": 1
},
{
"external_id": "armor",
"name": "Armor",
"description": "Protective equipment",
"image_url": "https://example.com/groups/armor.png",
"order": 2
},
{
"external_id": "consumables",
"name": "Consumables",
"description": "Potions, food, and other single-use items",
"image_url": null,
"order": 3
}
]
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list": {
"description": "已成功获取商品组列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-base"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list"
}
}
}
}
},
"ItemGroup_401-invalid-basic-auth": {
"description": "基本身份认证失败或提供的凭据无效。请确保您使用基本身份认证和正确的凭据。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error-response-base"
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_201-admin-create-group": {
"description": "已成功创建商品组。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "创建时指定的外部商品组ID。",
"example": "weapons"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/201-admin-create-group"
}
}
}
}
},
"ItemGroup_422-create-update": {
"description": "无法处理请求。出现验证错误或数据违反系统规则时返回。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"The property `external_id` is required": {
"$ref": "#/components/examples/422-property-external-id-required"
},
"Group already exists": {
"value": {
"statusCode": 422,
"errorCode": 4401,
"errorMessage": "[0401-4401]: Item group already exists",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Group cannot be its own parent": {
"value": {
"statusCode": 422,
"errorCode": 4404,
"errorMessage": "[0401-4404]: Group can't be self parent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Reserved external_id value": {
"value": {
"statusCode": 422,
"errorCode": 4516,
"errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group": {
"description": "已成功获取商品组。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-response-base"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group"
}
}
}
}
},
"ItemGroup_404-group-not-found": {
"description": "未找到商品组。如果具有指定`external_id`的组不存在或属于其他项目，则返回此错误。",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs used in the failed lookup.",
"properties": {
"project_id": {
"type": "integer",
"description": "Project ID used in the lookup request."
},
"external_id_list": {
"type": "array",
"description": "List of group `external_id` used in the lookup request.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "List of group `id` used in the lookup request.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
},
"Items or group not found (reorder endpoints)": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_204-admin-update-group": {
"description": "已成功更新商品组。"
},
"ItemGroup_204-admin-delete-group": {
"description": "已成功删除商品组。"
},
"ItemGroup_422-delete": {
"description": "无法处理请求。无法删除包含商品的组。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Cannot delete group with items": {
"value": {
"statusCode": 422,
"errorCode": 4402,
"errorMessage": "[0401-4402]: Item group with items cannot be deleted.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list-by-item-type": {
"description": "已成功获取商品组列表。`items_count`字段仅包含指定类型的商品。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-by-item-type"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list-by-item-type"
}
}
}
}
},
"ItemGroup_200-admin-get-group-by-item-type": {
"description": "已成功获取商品组，且`items_count`已按指定商品类型筛选。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-detail-response-by-item-type"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-by-item-type"
}
}
}
}
},
"ItemGroup_204-admin-reorder-groups": {
"description": "已成功重新排序商品组。"
},
"ItemGroup_404-reorder-groups-not-found": {
"description": "未找到商品组。如果具有指定`id`或`external_id`的组不存在或属于其他项目，则返回此错误。",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs used in the failed lookup.",
"properties": {
"project_id": {
"type": "integer",
"description": "Project ID used in the lookup request."
},
"external_id_list": {
"type": "array",
"description": "List of group `external_id` used in the lookup request.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "List of group `id` used in the lookup request.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
}
}
}
}
},
"ItemGroup_422-ordering": {
"description": "无法处理请求。请求正文未通过验证。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "",
"message": "Object value found, but an array is required"
}
]
}
}
}
}
}
},
"ItemGroup_204-admin-reorder-items": {
"description": "已成功重新排序组内商品。"
},
"ItemGroup_404-reorder-items-by-external-id-not-found": {
"description": "未找到商品组或商品。如果具有指定`external_id`的组不存在或属于其他项目，或在组内未找到一个或多个`item_id`，则返回此错误。",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs used in the failed lookup.",
"properties": {
"project_id": {
"type": "integer",
"description": "Project ID used in the lookup request."
},
"external_id_list": {
"type": "array",
"description": "List of group `external_id` used in the lookup request.",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_404-reorder-items-by-id-not-found": {
"description": "未找到商品组或商品。如果具有指定`id`的组不存在或属于其他项目，或在组内未找到一个或多个`item_id`，则返回此错误。",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs used in the failed lookup.",
"properties": {
"project_id": {
"type": "integer",
"description": "Project ID used in the lookup request."
},
"group_id_list": {
"type": "array",
"description": "List of group `id` used in the lookup request.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"Virtual-Items-Currency_200-quick-purchase": {
"description": "用虚拟货币快速购买成功。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "订单ID。"
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Virtual-Items-Currency_422-not-enough-virtual-currency": {
"description": "虚拟货币不足。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 5006
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-5006]: Not enough virtual currency"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 5006,
"statusCode": 422,
"errorMessage": "[0401-5006]: Not enough virtual currency"
}
}
}
}
}
},
"Game-Keys_200-get-games-catalog": {
"description": "已成功接收游戏列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏的对象。",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [],
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Game name",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "unit",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。"
},
"unit_type": {
"type": "string",
"example": "game",
"description": "单元类型：`game`。"
},
"description": {
"type": "string",
"example": "Game description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "图片URL。"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"unit_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "game_key",
"description": "商品类型：`game_key`。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "vc_test",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM名称。"
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "唯一DRM ID。 SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "如果为`true`，则该游戏Key有供销售的Key。"
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "如果为`true`，则该游戏Key为预售，且尚未到发布日期。"
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "游戏Key发布日期，采用ISO 8601格式。"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [],
"vp_rewards": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": []
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-get-game-keys-by-group-catalog": {
"description": "已成功接收游戏Key列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏的对象。",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Game name",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "game_key",
"description": "商品类型：`game_key`。"
},
"description": {
"type": "string",
"example": "Game description",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "商品价格。"
},
"sku": {
"type": "string",
"example": "vc_test",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "http://image.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "SHOTGUN FOR TRUE RAIDERS",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Virtual currency description."
}
}
}
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM名称。"
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "唯一DRM ID。 SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "如果为`true`，则该游戏Key有供销售的Key。"
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "如果为`true`，则该游戏Key为预售，且尚未到发布日期。"
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "游戏Key发布日期，采用ISO 8601格式。"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
]
}
}
}
}
}
},
"Game-Keys_200-get-drm-list": {
"description": "已成功接收DRM列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏的对象。",
"properties": {
"drm": {
"type": "array",
"example": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "steam",
"description": "唯一DRM ID。 SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Steam",
"description": "DRM名称。"
},
"image": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "图片URL。"
},
"link": {
"type": [
"string",
"null"
],
"example": "https://support.us.playstation.com",
"description": "兑换链接。"
},
"redeem_instruction_link": {
"type": "string",
"example": "https://support.us.playstation.com",
"description": "兑换说明链接。"
},
"drm_id": {
"type": "number",
"example": 1,
"description": "DRM ID。"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"drm": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
]
}
}
}
}
}
},
"Game-Keys_200-admin-get-games-list": {
"description": "已成功接收游戏列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏的对象。",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "game_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "unit",
"description": "商品类型。此情况下始终为`unit`。"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "游戏的附加资源，例如屏幕截图、游戏视频等。",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "媒体类型：`image`/`video`。"
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "资源文件。"
}
}
}
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则无法购买该商品，也无法通过物品库访问该商品。"
},
"is_show_in_store": {
"type": "boolean",
"description": "商品可供购买。"
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"unit_items": {
"type": "array",
"description": "用于不同DRM的游戏Key。",
"items": {
"type": "object",
"description": "游戏Key商品。它表示某个平台（steam、gog 等）上的游戏。",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "game_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "game_key",
"description": "商品类型。此情况下始终为`game_key`。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "以真实货币表示的价格。",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
},
"is_default": {
"type": "boolean",
"description": "如果未指定用户币种的价格，则使用默认价格生成商品目录。"
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。"
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "包含虚拟货币本地化名称的对象。编码按照ISO 3166-1的规定。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "商品类型。此情况下始终为`virtual_currency`。"
},
"description": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Object with localizations for game description. Keys are specified in ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则无法购买该商品，也无法通过物品库访问该商品。"
},
"is_show_in_store": {
"type": "boolean",
"description": "商品可供购买。"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "游戏Key DRM名称。"
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "DRM唯一ID。"
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "游戏Key DRM图标。"
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "DRM内部唯一ID。"
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "可供购买的游戏Key数量。"
},
"total": {
"type": "integer",
"description": "上传的游戏Key总数。"
},
"used": {
"type": "integer",
"description": "已售的游戏Key数量。"
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "如果为`true`，则该游戏Key已被用户购买。"
},
"pre_order": {
"type": "object",
"description": "预售设置。",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "游戏Key发布日期，采用ISO 8601格式。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则该商品不是预售商品。"
},
"description": {
"type": [
"string",
"null"
],
"description": "Additional information for the pre-order which will be emailed."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"name": {
"en": "Game 1 Key 2"
},
"groups": [],
"attributes": [],
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
{
"item_id": 2,
"sku": "com.xsolla.game_2",
"type": "unit",
"name": {
"en": "Game 2"
},
"description": {
"en": "Example game 2"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"item_id": 5,
"sku": "com.xsolla.game_2_key_2",
"type": "game_key",
"is_free": false,
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"order": 1,
"is_enabled": false,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
]
}
}
}
}
}
},
"Game-Keys_401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Game-Keys_422-invalid-request": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Game-Keys_422-invalid-request"
},
"examples": {
"The property `drm_sku` is required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required"
}
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"Game-Keys_200-admin-get-game-by-sku": {
"description": "已成功获取游戏。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏信息的对象。",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "game_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "unit",
"description": "商品类型。此情况下始终为`unit`。"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "游戏的附加资源，例如屏幕截图、游戏视频等。",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "媒体类型：`image`/`video`。"
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "资源文件。"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_enabled": {
"type": "boolean"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_show_in_store": {
"type": "boolean"
},
"unit_items": {
"type": "array",
"description": "用于不同DRM的游戏Key。",
"items": {
"type": "object",
"description": "游戏Key商品。它表示某个平台（steam、gog 等）上的游戏。",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "game_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "game_key",
"description": "商品类型。此情况下始终为`game_key`。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "以真实货币表示的价格。",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_is": "RU"
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
},
"is_default": {
"type": "boolean",
"description": "如果未指定用户币种的价格，则使用默认价格生成商品目录。"
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "适用此价格的国家/地区。符合[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两字母代码。"
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "包含虚拟货币本地化名称的对象。编码按照ISO 3166-1的规定。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "商品类型。此情况下始终为`virtual_currency`。"
},
"description": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Object with localizations for game description. Keys are specified in ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则无法购买该商品，也无法通过物品库访问该商品。"
},
"is_show_in_store": {
"type": "boolean",
"description": "商品可供购买。"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "游戏Key DRM名称。"
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "DRM唯一ID。"
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "游戏Key DRM图标。"
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "DRM内部唯一ID。"
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "可供购买的游戏Key数量。"
},
"total": {
"type": "integer",
"description": "上传的游戏Key总数。"
},
"used": {
"type": "integer",
"description": "已售的游戏Key数量。"
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "如果为`true`，则该游戏Key已被用户购买。"
},
"pre_order": {
"type": "object",
"description": "预售设置。",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "游戏Key发布日期，采用ISO 8601格式。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则该商品不是预售商品。"
},
"description": {
"type": [
"string",
"null"
],
"description": "Additional information for the pre-order which will be emailed."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": false,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": null
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-session-information": {
"description": "已成功接收游戏Key加载会话信息。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "fc7105b6e8ee01339582970b37697242"
},
"count_uploaded": {
"type": "integer",
"example": 0
},
"count_total": {
"type": "integer",
"example": 100
},
"count_skipped": {
"type": "integer",
"example": 10
},
"status": {
"type": "string",
"example": "processing"
}
}
},
"examples": {
"response": {
"value": {
"session_id": "fc7105b6e8ee01339582970b37697242",
"count_uploaded": 0,
"count_total": 100,
"count_skipped": 10,
"status": "processing"
}
}
}
}
}
},
"Game-Keys_200-get-codes": {
"description": "已成功接收游戏Key。",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "PIN-CODE-ALL PIN-CODE-ALL-3"
},
"examples": {
"response": {
"value": "PIN-CODE-ALL PIN-CODE-ALL-3"
}
}
}
}
},
"Game-Keys_200-user-entitlement-list": {
"description": "已成功接收用户拥有的游戏Key的列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含游戏信息的对象。",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"$ref": "#/components/schemas/Pagination_total-items-count"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game-Keys_entitlement_item"
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}
}
}
}
}
},
"Game-Keys_403-auth-header-not-sent": {
"description": "未发送Authorization请求头。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "未发送Authorization请求头。"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Bundles_200-admin-get-bundle-list": {
"description": "已成功接收捆绑包列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含商品的对象。",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677639600,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-01T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Bundles_201-admin-create-bundle": {
"description": "已成功创建捆绑包。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
}
}
},
"examples": {
"response": {
"value": {
"sku": "com.xsolla.kg_1"
}
}
}
}
}
},
"Bundles_422-invalid-request": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Bundles_200-admin-get-bundle-list-in-group": {
"description": "已成功接收捆绑包列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含商品的对象。",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "weekly",
"day_of_week": 2,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_200-admin-get-bundle": {
"description": "已成功获取指定捆绑包。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
},
"example": {
"item_id": 610316,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
}
},
"Bundles_204-admin-update-bundle": {
"description": "已成功更新捆绑包。",
"content": {}
},
"Bundles_204-admin-delete-bundle": {
"description": "已成功删除捆绑包。",
"content": {}
},
"Bundles_204-admin-show-bundle": {
"description": "已成功显示捆绑包。",
"content": {}
},
"Bundles_204-admin-hide-bundle": {
"description": "已成功隐藏捆绑包。",
"content": {}
},
"Bundles_200-get-bundle-list": {
"description": "已成功接收捆绑包列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含商品的对象。",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_client_bundle"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Bundles_200-get-bundle-list"
}
}
}
}
},
"Cart-Payment_200-get-cart-json-model": {
"description": "已成功返回含商品的购物车。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "购物车ID。"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "购物车价格。"
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "商品价格。"
},
"virtual_item_type": {
"type": "string",
"description": "商品类型。"
},
"virtual_prices": {
"$ref": "#/components/schemas/Bundles_virtual_prices"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_200-fill-cart-json-model": {
"description": "已成功返回含商品的购物车。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "购物车ID。"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "购物车价格。"
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "商品价格。"
},
"virtual_item_type": {
"type": "string",
"description": "商品类型。"
},
"virtual_prices": {
"$ref": "#/components/schemas/Bundles_virtual_prices"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.booster_mega_21",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found"
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-item": {
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Cart-Payment_422-non-negative-quantity": {
"description": "商品数量必须是非负整数。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "商品数量必须是非负整数。"
},
"errorCode": {
"type": "integer",
"example": 1102
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
}
}
}
},
"Cart-Payment_422-can-put-only-virtual-good-to-cart": {
"description": "此类商品不能放入购物车。请选择其他类型的商品。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1421
},
"errorMessage": {
"type": "string",
"example": "此类商品不能放入购物车。请选择其他类型的商品。"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported"
}
}
}
}
}
},
"Cart-Payment_200-order-created": {
"description": "已成功创建订单。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "订单ID。"
},
"token": {
"type": "string",
"description": "支付令牌。"
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
}
}
}
}
},
"Cart-Payment_422-invalid-cart": {
"description": "购物车无效。请检查购物车是否存在，内容不能为空，并且其中的所有商品均非免费。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1401
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1401]: Invalid cart"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart"
}
}
}
}
}
},
"Cart-Payment_404-create-order-with-item-not-found-errors": {
"description": "未找到商品或优惠券。请确保使用的数据正确无误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"Cart-Payment_422-create-order-with-item-invalid": {
"description": "错误无效。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"invalid item": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
},
"code expired": {
"value": {
"errorCode": 9810,
"statusCode": 422,
"errorMessage": "[0401-9810]: Sorry, this code is expired."
}
},
"code redemption limit": {
"value": {
"errorCode": 9804,
"statusCode": 422,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"regionally restricted": {
"value": {
"errorCode": 9808,
"statusCode": 422,
"errorMessage": "[0401-9808]: Coupon is not available in your region."
}
}
}
}
}
},
"Cart-Free_200-order-created": {
"description": "已成功创建免费订单。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "订单ID。"
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Cart-Payment_422-invalid-item": {
"description": "商品无效。请检查该商品是否存在、未禁用、未删除且非免费。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
}
}
}
}
},
"Cart-Payment_200-get-order": {
"description": "订单请求成功。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"default": "订单ID。",
"description": "订单ID。"
},
"status": {
"type": "string",
"example": "paid",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"description": "订单状态。详细状态说明请参阅[订单生命周期](https://developers.xsolla.com/zh/api/catalog/order-life-cycle)部分。"
},
"content": {
"type": "object",
"description": "订单详细信息。",
"properties": {
"price": {
"type": "object",
"description": "订单价格。",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "订单折扣价格。"
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "订单价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "订单价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_price": {
"type": "object",
"description": "以虚拟货币表示的订单价格。",
"properties": {
"amount": {
"type": "string",
"example": "100",
"description": "订单折扣价格。"
},
"amount_without_discount": {
"type": "string",
"example": "150",
"description": "订单价格。"
},
"currency": {
"type": "string",
"example": "test_vc",
"description": "订单中使用的虚拟货币SKU。"
}
}
},
"is_free": {
"type": "boolean",
"example": false,
"description": "如果为`true`，则该订单免费。"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
],
"description": "商品列表。",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "some_sku",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"quantity": {
"type": "integer",
"example": 1,
"description": "商品数量。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"order_id": 1,
"status": "paid",
"content": {
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"is_free": false,
"items": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
]
}
}
}
}
}
}
},
"Cart-Payment_404-get-order": {
"description": "未找到订单。请确保`project_id`和`order_id`正确无误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9001
},
"errorMessage": {
"type": "string",
"example": "[0401-9001]: Order not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found"
}
}
}
}
}
},
"200-admin-order-search": {
"description": "已成功获取订单列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"description": "订单列表。",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"description": "订单ID。"
},
"project_id": {
"type": "integer",
"example": 44056,
"description": "项目ID。您可以在[发布商帐户](https://publisher.xsolla.com/)的项目名称旁边找到。"
},
"status": {
"type": "string",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"example": "paid",
"description": "订单状态。详细状态说明请参阅[订单生命周期](https://developers.xsolla.com/zh/api/catalog/order-life-cycle)部分。"
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "订单创建日期或符合[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)标准的日期时间代码。"
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "订单创建模式。"
},
"is_free": {
"type": "boolean",
"example": false,
"description": "该订单是否免费。"
},
"invoice_id": {
"type": "string",
"description": "发票ID。"
},
"price": {
"type": [
"object",
"null"
],
"description": "订单价格。",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "最终订单价格。"
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "不含折扣的订单价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "虚拟货币SKU或符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的真实货币三位代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "该货币是否是虚拟货币。"
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "07e653a2b15011e6818f005056a54369",
"description": "创建订单时传入的用户ID。"
},
"country": {
"type": "string",
"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"
},
"email": {
"type": "string",
"format": "email",
"example": "user@xsolla.com",
"description": "用户电子邮箱，使用符合[RFC 822](https://www.w3.org/Protocols/rfc822/#z8)协议的格式。"
},
"region_id": {
"type": [
"integer",
"null"
],
"example": 12,
"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/)。"
}
}
},
"items": {
"type": "array",
"description": "商品列表。",
"items": {
"type": "object",
"properties": {
"order_item_id": {
"type": "integer",
"description": "订单中的商品ID。由艾克索拉在订单创建期间生成。"
},
"item_id": {
"type": "integer",
"example": 1,
"description": "商品ID。由艾克索拉在创建商品时生成。"
},
"sku": {
"type": "string",
"example": "elven_shield",
"description": "创建商品时指定的商品ID。 SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good",
"value_point"
]
},
"quantity": {
"type": "integer",
"example": 1,
"description": "商品数量。"
},
"is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "该商品是否免费。"
},
"is_bonus": {
"type": "boolean",
"example": false,
"description": "商品是否为赠品。"
},
"region_id": {
"type": [
"integer",
"null"
],
"description": "商品可购区域的ID。关于区域销售限制的更多信息，请参阅[文档](https://developers.xsolla.com/zh/doc/shop-builder/features/regional-restrictions/)。"
},
"tax_category": {
"type": "string",
"example": "DG00002",
"description": "征税类别。"
},
"price": {
"type": [
"object",
"null"
],
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "不含折扣的商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "虚拟货币SKU或符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三位代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "该货币是否是虚拟货币。"
}
}
},
"description": {
"type": [
"object",
"null"
],
"description": "Object with information about the item.",
"properties": {
"name": {
"type": "string",
"description": "商品名称。"
},
"image_url": {
"type": "string",
"format": "uri",
"description": "Item image URL."
},
"description": {
"type": "string",
"description": "商品描述。"
}
}
}
}
}
},
"promotions": {
"type": [
"array",
"null"
],
"description": "应用于订单的促销活动列表。",
"items": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"example": 111425,
"description": "项目内的促销活动ID。"
}
}
}
},
"coupons": {
"type": [
"array",
"null"
],
"description": "应用于订单的优惠券列表。",
"items": {
"type": "object",
"properties": {
"coupon_id": {
"type": "integer",
"description": "优惠券ID，由艾克索拉在创建优惠券促销活动时生成。"
},
"sku": {
"type": "string",
"description": "优惠券SKU，由艾克索拉在创建优惠券促销活动时生成。"
},
"code": {
"type": "string",
"description": "使用的优惠券代码。唯一且区分大小写的代码。包含字母和数字。"
},
"type": {
"type": "string",
"enum": [
"unique_catalog_offer",
"coupon",
"promocode"
],
"description": "优惠券类型。"
}
}
}
}
}
}
},
"total_items_count": {
"type": "integer",
"example": 1,
"description": "指定时间段内的订单总数。"
},
"has_more": {
"type": "boolean",
"example": true,
"description": "是否还有任何附加页面。"
}
}
},
"examples": {
"response": {
"value": {
"orders": [
{
"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [
{
"order_item_id": 29,
"item_id": 1005111,
"sku": "com.xsolla.1005111",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {
"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{
"order_item_id": 30,
"item_id": 1005112,
"sku": "com.xsolla.1005112",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{
"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 27,
"item_id": 1005101,
"sku": "com.xsolla.1005101",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {
"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{
"order_item_id": 28,
"item_id": 1005102,
"sku": "com.xsolla.1005102",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [
{
"promotion_id": 1005101
}
],
"coupons": [
{
"coupon_id": 100510,
"sku": "com.xsolla.100510",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{
"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 17,
"item_id": 1005051,
"sku": "com.xsolla.1005051",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{
"order_item_id": 18,
"item_id": 1005052,
"sku": "com.xsolla.1005052",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}
}
}
}
}
},
"401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_201-admin-create-payment-token": {
"description": "已成功创建支付令牌和订单。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "支付令牌。"
},
"order_id": {
"type": "integer",
"example": 1,
"description": "订单ID。"
}
}
},
"examples": {
"response": {
"value": {
"token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb",
"order_id": 12345
}
}
}
}
}
},
"Cart-Payment_401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_422-admin-create-payment-token": {
"description": "请求正文和创建购物车验证错误。\n- 由传入商品创建的购物车无效。请检查购物车是否为空，并且所有商品非免费商品。\n- 请求正文无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request-2"
},
"examples": {
"Invalid request body": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Item is free": {
"value": {
"errorCode": 1421,
"statusCode": 422,
"errorMessage": "[0401-1421]: Item is free",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Invalid cart": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Empty cart": {
"value": {
"errorCode": 1417,
"statusCode": 422,
"errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"User country not provided": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"Cart-Payment_200-admin-fill-cart-json-model": {
"description": "已成功返回含商品的购物车。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "购物车ID。调用购买页面或支付API接口时，请传入该ID。"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "购物车价格。"
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "商品价格。"
},
"virtual_prices": {
"$ref": "#/components/schemas/Bundles_virtual_prices"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "The cup of tea",
"groups": [
{
"external_id": "cups",
"name": "Cups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Cup",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"quantity": 2,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "White T-shirt",
"price": {
"amount": "3.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.t-shirt01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [
{
"external_id": "clothes",
"name": "Clothes"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"is_bonus": false,
"name": "Cat's cup",
"price": null,
"quantity": 1,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.hat01",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found"
}
],
"price": {
"amount": "15.97",
"amount_without_discount": "22.96",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-user": {
"description": "未找到用户。请确保`x-user-for`或`x-user-id`正确无误。",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 5008
},
"errorMessage": {
"type": "string",
"example": "[0401-5008]: Could not find User"
}
},
"type": "object"
}
}
}
},
"Common_401-invalid-basic-auth": {
"description": "基本身份认证未通过或不正确。请确保您使用了基本身份认证或正确的凭据。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"200-admin-get-user-item-limits": {
"description": "已成功接收用户的购买数量限制。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-item"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"connector-422-validation-failed": {
"description": "由于请求正文、文件属性或文件内容的参数不正确而导致的验证错误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1803
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1803,
"errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"200-items-import-status-model": {
"description": "已成功获取导入状态。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "error",
"description": "导入状态。\n\n可能值：\n- `initialized` — 导入已启动。\n- `process` — 导入正在进行中。\n- `done` — 导入成功。\n- `error` — 由于错误，导入未完成或仅部分完成。",
"enum": [
"initialized",
"process",
"done",
"error"
]
},
"date_created": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "创建导入操作的时间戳（采用GMT+3 时区）。"
},
"date_updated": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "由于错误而导致导入中断的时间戳（采用GMT+3 时区）。"
},
"date_completed": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "导入操作完成的时间戳（采用GMT+3 时区）。如果导入因错误而中断且未导入任何商品，则返回空字符串。"
},
"progress": {
"type": "integer",
"example": 100,
"description": "导入执行的进度（以百分比表示）。"
},
"error": {
"type": "string",
"description": "一般导入错误的描述。"
},
"error_code": {
"type": "string",
"description": "一般导入错误的错误代码。"
},
"result": {
"type": "object",
"description": "包含特定商品SKU的导入结果和导入错误数据的对象。",
"properties": {
"errors_count": {
"type": "integer",
"example": 3,
"description": "导入过程中出现错误的商品数。"
},
"total_entities_count": {
"type": "integer",
"example": 11,
"description": "导入的商品总数。"
},
"errors_by_sku": {
"type": "array",
"description": "包含特定商品SKU的导入错误数据的对象数组。",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "sku_1",
"description": "导入商品的SKU。"
},
"type": {
"type": "string",
"example": "vi",
"description": "商品类型。",
"enum": [
"virtual_good",
"virtual_currency",
"virtual_currency_packages",
"bundle"
]
},
"error_code": {
"type": "integer",
"example": 1001,
"description": "特定商品SKU的导入错误代码。"
},
"error_message": {
"type": "string",
"example": "Something went wrong",
"description": "特定商品SKU的导入错误描述。"
}
}
}
}
}
}
},
"example": {
"status": "error",
"date_created": "2024-11-19T14:27:31+03:00",
"date_updated": "2024-11-19T15:27:31+03:00",
"date_completed": "2024-11-19T15:27:31+03:00",
"progress": 100,
"error": null,
"error_code": null,
"result": {
"errors_count": 2,
"total_entities_count": 10,
"errors_by_sku": [
{
"sku": "com.xsolla.sword_1",
"type": "virtual_items",
"error_code": 4055,
"error_message": "[0401-4055]: Item default price not set"
},
{
"sku": "",
"type": null,
"error_code": 1817,
"error_message": "[0410-1817]: SKU can't be empty"
}
]
}
}
}
}
}
},
"sellable_items_200-get-items-list": {
"description": "已成功接收可售商品列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含可售商品的对象。",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_2",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_14",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"bundle_type": {
"type": "string",
"description": "捆绑包类型。当商品类型为捆绑包时返回。",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 10,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 10,
"description": "商品价格。"
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "com.xsolla.gold_1",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"description": "虚拟货币图片。"
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"name": {
"type": "string",
"example": "Gold",
"description": "虚拟货币名称。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": [
"string",
"null"
],
"example": null,
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "如为`true`，则用户可以购买商品。"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"content": {
"type": "array",
"items": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Bundles_client_content"
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_2",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"sellable_items_200-get-item-by-id": {
"description": "已成功接收可售商品。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含可售商品的对象。",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "electric_shield",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 10,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 10,
"description": "商品价格。"
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "gold",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"description": "虚拟货币图片。"
},
"name": {
"type": "string",
"example": "Gold",
"description": "虚拟货币名称。"
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": [
"string",
"null"
],
"example": null,
"description": "Virtual currency description."
}
}
}
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "如为`true`，则用户可以购买商品。"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"examples": {
"response": {
"value": {
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 10
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"sellable-item-by-id_404": {
"description": "未找到商品。请确保`project_id`和`item_id`正确无误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 259774 not found"
}
}
}
}
}
},
"sellable-item-by-sku_404": {
"description": "未找到商品。请确保`project_id`和`sku`正确无误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'electric_shiel' not found"
}
}
}
}
}
},
"sellable_items_200-get-items-by-group-id": {
"description": "已成功接收指定组的可售商品列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "商品名称。"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Electric shield",
"description": "商品描述。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "图片URL。"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "商品价格。",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "商品折后价格。"
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "商品价格。"
},
"currency": {
"type": "string",
"example": "USD",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。"
}
}
},
"virtual_prices": {
"type": "array",
"description": "虚拟价格。",
"items": {
"type": "object",
"description": "虚拟价格。",
"properties": {
"amount": {
"type": "integer",
"example": 10,
"description": "以虚拟货币表示的商品折后价格。"
},
"amount_without_discount": {
"type": "integer",
"example": 10,
"description": "商品价格。"
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "com.xsolla.gold_1",
"description": "虚拟货币商品SKU。"
},
"is_default": {
"type": "boolean",
"example": true,
"description": "价格是否为商品默认价格。"
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png"
},
"name": {
"type": "string",
"example": "Gold",
"description": "虚拟货币名称。"
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "创建商品时提供的内部唯一商品ID。"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "虚拟货币类型。"
},
"description": {
"type": [
"string",
"null"
],
"example": null,
"description": "Virtual currency description."
}
}
}
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "虚拟物品的类型。\n\n可能值：\n- `consumable` — 使用后会从物品库中消失的商品（例如弹药）。\n- `non_consumable` — 可无限期保留在物品库中的商品。\n- `non_renewing_subscription` — 时效性商品，可表示在限定时间内对服务或内容的访问权限。\"",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "如为`true`，则用户可以购买商品。"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shields_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_2",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
]
}
}
}
}
}
},
"200-admin-get-regions-list": {
"description": "已成功接收区域列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含商品的对象。",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regions_200-region-short-model"
}
}
}
},
"examples": {
"response": {
"value": {
"regions": [
{
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
{
"id": 45,
"name": {
"en-US": "CIS",
"de-DE": "GUS"
}
}
]
}
}
}
}
}
},
"201-admin-create-region": {
"description": "已成功创建区域。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region_id": {
"$ref": "#/components/schemas/Regions_region_id"
}
}
},
"example": {
"region_id": 42
}
}
}
},
"200-admin-get-region": {
"description": "已成功接收指定区域。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Regions_200-region-model"
}
}
}
},
"404-region-not-found": {
"description": "未找到区域。请确保`id`正确无误。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9701
},
"errorMessage": {
"type": "string",
"example": "[0401-9701]: Region not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-region": {
"description": "已成功更新区域。",
"content": {}
},
"204-admin-delete-region": {
"description": "已成功删除区域。",
"content": {}
},
"200-admin-get-attribute-list-response": {
"description": "已成功接收属性列表。",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "包含商品的对象。",
"properties": {
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin_attribute_response"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"response": {
"value": {
"total_count": 2,
"attributes": [
{
"external_id": "size",
"name": {
"en": "Size",
"de": "Größe"
}
},
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
}
}
}
}
},
"201-admin-create-attribute": {
"description": "已成功创建属性。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
}
}
},
"example": {
"external_id": "genre"
}
}
}
},
"422-validation-failed": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"200-admin-get-attribute": {
"description": "已成功接收指定的属性。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_attribute_response"
}
}
}
},
"404-attribute-not-found": {
"description": "未找到属性。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9901
},
"errorMessage": {
"type": "string",
"example": "[0401-9901]: Attribute not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-attribute": {
"description": "已成功更新属性。",
"content": {}
},
"201-admin-create-attribute-value": {
"description": "已成功创建属性值。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
}
}
},
"example": {
"external_id": "rpg"
}
}
}
},
"403-auth-header-not-sent": {
"description": "未发送Authorization请求头。",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "未发送Authorization请求头。"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"422-create-update-attribute-value": {
"description": "请求无效。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"external_id is required": {
"$ref": "#/components/examples/422-external-id-required"
},
"external_id is invalid": {
"$ref": "#/components/examples/422-external-id-invalid"
},
"external_id is duplicate": {
"$ref": "#/components/examples/422-external-id-duplicate"
},
"value is required": {
"$ref": "#/components/examples/422-value-invalid"
},
"value properties minimum length": {
"$ref": "#/components/examples/422-value-properties-required"
},
"value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"404-attribute-value-not-found": {
"description": "未找到属性值。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404-not-found"
},
"examples": {
"Attribute not found": {
"$ref": "#/components/examples/404-attribute-not-found"
},
"Attribue value not found": {
"$ref": "#/components/examples/404-attribute-value-not-found"
}
}
}
}
}
},
"requestBodies": {
"Virtual-Items-Currency_admin-create-virtual-item": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item"
},
"examples": {
"default": {
"summary": "Minimal setup example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle."
}
}
},
"quickstart": {
"summary": "Quickstart example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster",
"de": "Mega-Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle.",
"de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte."
},
"is_enabled": true,
"is_show_in_store": true,
"is_free": false,
"groups": [
"boosters"
],
"order": 1,
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
]
}
},
"full-payload": {
"summary": "Full payload example",
"value": {
"sku": "com.xsolla.sword_1",
"name": {
"en": "Sword",
"de": "Schwert"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"weapons"
],
"order": 1,
"description": {
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
"de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist."
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
},
{
"amount": 200,
"currency": "CZK",
"country_iso": "CZ",
"is_enabled": false,
"is_default": true
}
],
"vc_prices": [],
"is_show_in_store": true,
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 100
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency"
},
"example": {
"sku": "com.xsolla.coin_1",
"name": {
"en-US": "Gold coin",
"de-DE": "Goldmünze"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"groups": [
"gold"
],
"order": 1,
"description": {
"en-US": "The main currency of your kingdom",
"de-DE": "Die Hauptwährung deines Königreichs"
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 10000
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.novigrad_crown_500",
"name": {
"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"witcher"
],
"order": 1,
"long_description": {
"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {
"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"attributes": [
{
"external_id": "event",
"name": {
"en-US": "Event"
},
"values": [
{
"external_id": "10-anniversary",
"value": {
"en-US": "10th anniversary"
}
},
{
"external_id": "christmas",
"value": {
"en-US": "Christmas"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": 99.99,
"is_default": true
},
{
"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [
{
"sku": "com.xsolla.novigrad_crown",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package"
}
}
}
},
"ItemGroup_create": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-create-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons",
"de": "Waffen"
},
"description": {
"en": "Player weapons",
"de": "Spielerwaffen"
},
"iconUrl": "https://example.com/weapons.png",
"isEnabled": true,
"order": 1
}
}
},
"description": "包含商品组数据的对象。",
"required": true
},
"ItemGroup_update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-update-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons Updated",
"de": "Waffen Aktualisiert"
},
"description": {
"en": "Updated player weapons",
"de": "Aktualisierte Spielerwaffen"
},
"iconUrl": "https://example.com/weapons-new.png",
"isEnabled": true,
"order": 2
}
}
},
"description": "包含待更新商品组数据的对象。",
"required": true
},
"ItemGroup_order": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Identify by ID",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "由艾克索拉分配的商品组ID。",
"minimum": 0,
"example": 1
},
"order": {
"type": "integer",
"description": "新的显示顺序值。",
"minimum": 0,
"example": 1
}
},
"required": [
"id",
"order"
],
"additionalProperties": false
}
},
{
"title": "Identify by external_id",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "创建时指定的外部商品组ID。",
"minLength": 1,
"example": "weapons"
},
"order": {
"type": "integer",
"description": "新的显示顺序值。",
"minimum": 0,
"example": 1
}
},
"required": [
"external_id",
"order"
],
"additionalProperties": false
}
}
]
},
"examples": {
"by_id": {
"summary": "Identify groups by ID",
"value": [
{
"id": 1,
"order": 1
},
{
"id": 2,
"order": 2
},
{
"id": 3,
"order": 3
}
]
},
"by_external_id": {
"summary": "Identify groups by external_id",
"value": [
{
"external_id": "weapons",
"order": 1
},
{
"external_id": "armor",
"order": 2
},
{
"external_id": "consumables",
"order": 3
}
]
}
}
}
},
"description": "包含新顺序值的组数组。所有项必须使用相同的标识方法（全部按`id`或全部按`external_id`）。",
"required": true
},
"ItemGroup_item_order": {
"content": {
"application/json": {
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/item-in-group-order-request-item"
}
},
"example": [
{
"item_id": 101,
"order": 1
},
{
"item_id": 102,
"order": 2
},
{
"item_id": 103,
"order": 3
}
]
}
},
"description": "包含组内新顺序值的商品数组。",
"required": true
},
"Game-Keys_create-update-game-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "图片URL。"
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "游戏附加资源，例如屏幕截图、游戏视频等。",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "媒体类型：`image`/`video`。"
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "资源文件。"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"groups": {
"type": "array",
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则无法购买该商品，也无法通过物品库访问该商品。"
},
"is_show_in_store": {
"type": "boolean",
"description": "商品可供购买。"
},
"unit_items": {
"type": "array",
"description": "用于不同DRM的游戏Key。",
"items": {
"type": "object",
"description": "游戏Key商品。它表示某个平台（steam、gog 等）上的游戏。",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"type": "array",
"description": "商品所属分组。",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "以真实货币表示的价格。",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "商品价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"is_default": {
"type": "boolean",
"description": "如果未指定用户币种的价格，则使用默认价格生成商品目录。"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "唯一商品ID。SKU只能包含大小写英文字母、数字、句点、短横线和下划线。"
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"order": {
"type": "integer",
"example": 1,
"description": "游戏在列表中的排序优先级。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则无法购买该商品，也无法通过物品库访问该商品。"
},
"is_show_in_store": {
"type": "boolean",
"description": "商品可供购买。"
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "DRM唯一ID。"
},
"pre_order": {
"type": "object",
"description": "预售设置。",
"properties": {
"release_date": {
"type": "string",
"description": "游戏Key发布日期，采用ISO 8601格式。"
},
"is_enabled": {
"type": "boolean",
"description": "如果禁用，则该商品不是预售商品。"
},
"description": {
"type": "string",
"description": "Additional information for the pre-order, which will be emailed."
}
},
"required": [
"release_date",
"is_enabled"
]
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/Game-key-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
},
"required": [
"sku",
"drm_sku",
"prices"
]
}
}
},
"required": [
"sku",
"name",
"unit_items"
],
"example": {
"sku": "com.xsolla.game_1",
"name": {
"en-US": "Game name",
"ru-RU": "Название игры"
},
"description": {
"en-US": "Game description",
"ru-RU": "Краткое описание игры"
},
"long_description": {
"en-US": "Game long description",
"ru-RU": "Полное описание игры"
},
"image_url": "http://image.png",
"media_list": [
{
"type": "image",
"url": "http://image.png"
},
{
"type": "video",
"url": "http://video.png"
}
],
"groups": [
"new_games"
],
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"sku": "com.xsolla.game_key_1",
"name": {
"en-US": "Game key name",
"ru-RU": "Название игрового ключа"
},
"drm_sku": "steam_key_1",
"prices": [
{
"amount": 35.5,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"vc_prices": [
{
"amount": 35.5,
"sku": "com.xsolla.gold_1",
"is_enabled": true,
"is_default": true
}
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
},
"description": "包含游戏数据的对象。",
"required": true
},
"Bundles_bundle": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_request"
},
"example": {
"sku": "com.xsolla.armour_chest_1",
"name": {
"en": "Chest of armour",
"de": "Brustpanzer"
},
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"order": 1,
"long_description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"image_url": "https://picture.bundle-with-many-stuff.png",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"groups": [
"chests"
],
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": "9.99",
"is_default": true,
"is_enabled": true
},
{
"currency": "EUR",
"amount": "9.99",
"is_default": false,
"is_enabled": true
}
],
"vc_prices": [],
"content": [
{
"sku": "com.xsolla.iron_gloves_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_boots_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_shield_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_armour_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_helmet_1",
"quantity": 1
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
},
"description": "包含捆绑包数据的对象。",
"required": true
},
"Cart-Payment_fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"sku": "com.xsolla.booster_mega_1",
"quantity": 123
}
]
},
"properties": {
"items": {
"type": "array",
"description": "商品列表。",
"items": {
"type": "object",
"minItems": 1,
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"default": "booster_mega_1"
},
"quantity": {
"type": "number",
"default": 123
}
}
}
}
}
}
}
}
},
"Cart-Payment_put-item-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "商品数量。",
"default": 123
}
}
}
}
}
},
"Cart-Payment_create-order-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "订单价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三位币种代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"locale": {
"type": "string",
"description": "响应语言。"
},
"sandbox": {
"type": "boolean",
"description": "在沙盒模式下创建订单。此选项仅适用于公司用户列表中指定的用户。",
"default": false
},
"settings": {
"type": "object",
"description": "用于为用户配置支付流程和支付UI的设置。",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "项目特定参数。",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"Cart-Payment_create-order-with-specified-item-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "订单价格币种。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三位币种代码。关于[艾克索拉支持的币种](https://developers.xsolla.com/zh/doc/pay-station/references/supported-currencies/)的详细信息，请参阅文档。"
},
"locale": {
"type": "string",
"description": "响应语言。"
},
"sandbox": {
"type": "boolean",
"description": "在沙盒模式下创建订单。此选项仅适用于公司用户列表中指定的用户。",
"default": false
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "商品数量。",
"default": 1
},
"promo_code": {
"type": "string",
"description": "随支付核销兑换码促销活动的兑换码。"
},
"settings": {
"type": "object",
"description": "用于为用户配置支付流程和支付UI的设置。",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "项目特定参数。",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"admin-order-search": {
"description": "订单搜索参数",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "响应中包含的订单数量上限。",
"minimum": 1,
"maximum": 10,
"default": 10,
"nullable": false
},
"offset": {
"type": "integer",
"description": "生成列表的起始订单编号（从0开始计数）。",
"default": 0,
"minimum": 0,
"nullable": false
},
"created_date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-15T18:16:00+05:00",
"description": "订单创建时间段的开始日期或日期加时间（[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 格式）。"
},
"created_date_until": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-16T18:16:00+05:00",
"description": "订单创建时间段的结束日期或日期加时间（[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)格式）。"
}
}
},
"example": {
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}
}
}
},
"Cart-Payment_admin-create-payment-token": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"purchase"
],
"properties": {
"sandbox": {
"$ref": "#/components/schemas/Cart-Payment_settings_sandbox"
},
"user": {
"$ref": "#/components/schemas/Cart-Payment_admin-user-request-body"
},
"purchase": {
"$ref": "#/components/schemas/Cart_admin_payment"
},
"promo_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"settings": {
"type": "object",
"description": "用于为用户配置支付流程和支付UI的设置。",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"language": {
"$ref": "#/components/schemas/Cart-Payment_settings_locale"
},
"external_id": {
"$ref": "#/components/schemas/Cart-Payment_settings_external_id"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"$ref": "#/components/schemas/Cart-Payment_custom_parameters_token"
}
},
"additionalProperties": false
},
"examples": {
"common": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/zh/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
}
}
},
"in-sandbox": {
"value": {
"sandbox": true,
"user": {
"id": {
"value": "user-id"
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"currency": "USD"
}
}
},
"with-custom-parameters": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/zh/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"custom_parameters": {
"user_public_id": "player1",
"user_os": "windows10"
}
}
}
}
}
}
},
"Cart-Payment_admin-fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart"
},
"examples": {
"basic": {
"value": {
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}
}
}
}
}
},
"reset-user-limits": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"reset-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"update-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 0
}
}
}
},
"update-user-limits-strict": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 1
}
}
}
},
"connector-import-items-body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connector_external_id",
"file_url"
],
"properties": {
"connector_external_id": {
"type": "string",
"description": "指定商品导入操作类型的固定值。",
"enum": [
"import_items"
]
},
"file_url": {
"type": "string",
"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"
},
"mode": {
"type": "string",
"description": "导入操作：\n\n可能值：\n- `create` — 添加新商品。\n- `create_and_update` — 添加新商品并更新现有商品。\n- `sync` — 添加新商品、更新现有商品并禁用缺失商品。",
"enum": [
"create",
"create_and_update",
"sync"
],
"default": "create_and_update"
}
}
}
}
}
},
"create-update-region": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"countries",
"name"
],
"properties": {
"countries": {
"$ref": "#/components/schemas/Regions_countries"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
},
"example": {
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
}
}
},
"create-update-attribute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
}
},
"example": {
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
}
}
},
"create-update-attribute-value": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/request-attribute-value"
},
"example": {
"external_id": "weapon_class_sword_value",
"value": {
"en": "Sword",
"de": "Schwert"
}
}
}
}
}
},
"examples": {
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attribute-values-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9909,
"errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attributes-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-value-limit-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-custom-attributes-size-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "da145238620011eb8e24fe6913ff226a",
"errorMessageExtended": [
{
"property": "custom_attributes",
"message": "JSON can’t exceed 500 characters."
}
]
}
},
"200-admin-get-group-list": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 3
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 4
}
]
}
},
"201-admin-create-group": {
"value": {
"external_id": "weapons"
}
},
"422-property-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "external_id",
"message": "The property external_id is required"
}
]
}
},
"200-admin-get-group": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
}
},
"200-admin-get-group-list-by-item-type": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 2,
"is_contains_any_items": true
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 0,
"is_contains_any_items": false
}
]
}
},
"200-admin-get-group-by-item-type": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
}
},
"404-game-code-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4603,
"errorMessage": "[0401-4603]: Game code not found.",
"transactionId": "transaction id"
}
},
"422-drm-is-not-drm-free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
},
"422-user-already-has-entitlement": {
"value": {
"statusCode": 422,
"errorCode": 5101,
"errorMessage": "[0401-5101]: User already has entitlement.",
"transactionId": "transaction id"
}
},
"Bundles_200-get-bundle-list": {
"value": {
"has_more": true,
"items": [
{
"item_id": 61031,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1",
"image_url": null,
"long_description": null,
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
],
"is_free": false,
"order": 999,
"groups": [
{
"external_id": "exclusive",
"name": "Exclusive",
"item_order_in_group": 1
}
],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"can_be_bought": true,
"bundle_type": "standard",
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "virtual_currency",
"quantity": 100,
"virtual_item_type": "non_consumable",
"attributes": [
{
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
}
],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
]
}
},
"Bundles_200-get-bundle": {
"value": {
"item_id": 610316,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1.",
"image_url": null,
"long_description": null,
"attributes": [],
"is_free": false,
"order": 999,
"groups": [],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"bundle_type": "standard",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
},
"404-item-by-sku-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found",
"transactionId": "transaction id"
}
},
"404-coupon-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9802,
"errorMessage": "[0401-9802]: Coupon not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-user-not-found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User",
"transactionId": "transaction id"
}
},
"422-user_external_id_invalid": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "transaction id",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
},
"422-item-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4508,
"errorMessage": "[0401-4508]: Item does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-item-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4510,
"errorMessage": "[0401-4510]: Available item limit is out of range.",
"transactionId": "transaction id"
}
},
"422-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-duplicate": {
"value": {
"statusCode": 422,
"errorCode": 9907,
"errorMessage": "[0401-9907]: The attribute value already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-properties-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-value-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9906,
"errorMessage": "[0401-9906]: Attribute value not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"x-tagGroups": [
{
"name": "虚拟物品和货币",
"tags": [
"virtual-items-currency-overview",
"virtual-items-currency-admin",
"virtual-items-currency-catalog",
"virtual-payment"
]
},
{
"name": "游戏Key",
"tags": [
"game-keys-catalog",
"game-keys-entitlement",
"game-keys-admin"
]
},
{
"name": "捆绑包",
"tags": [
"bundles-admin",
"bundles-catalog"
]
},
{
"name": "购物车和支付",
"tags": [
"cart-and-payment-overview",
"order-life-cycle",
"cart-client-side",
"cart-server-side",
"payment-client-side",
"payment-server-side",
"order",
"free-item"
]
},
{
"name": "限制",
"tags": [
"limits-overview",
"user-limits-admin"
]
},
{
"name": "商品导入",
"tags": [
"connector-admin"
]
},
{
"name": "通用",
"tags": [
"common-pre-orders",
"common-merchant",
"common-catalog",
"common-regions"
]
},
{
"name": "商品属性",
"tags": [
"attribute-admin"
]
},
{
"name": "商品组",
"tags": [
"item-groups-admin",
"item-groups-catalog"
]
}
]
}