{
"openapi": "3.0.0",
"info": {
"description": "# 概览\n\nDigital Distribution Hub是一个全新的艾克索拉解决方案，旨在通过推送支付(Push payments)技术和电子商务来联结数字与现金支付。\n\n本参考指南合并介绍了用于以下两个艾克索拉产品的API端点：[游戏内商店](https://developers.xsolla.com\\/zh/doc/in-game-store/)和[支付中心](https://developers.xsolla.com\\/zh/doc/pay-station/)。基础URL有两个：\n\n* `https://store.xsolla.com/api` ，用于**常用**、**目录**、**购物车**和**订单**组。\n* `https://ps.xsolla.com`，用于**通知**组。\n\n**目录**组中的API端点不需要授权。\n\n要使用**购物车**和**订单**组中的操作，需通过[创建用户令牌](https://developers.xsolla.com\\/zh/digital-distribution-hub/common/user-token/create-user-token)来生成一个令牌。\n\n",
"title": "Digital Distribution Hub",
"version": "1.0.0"
},
"servers": [
{
"url": "https://store.xsolla.com/api"
}
],
"tags": [
{
"name": "cart",
"x-displayName": "购物车"
},
{
"name": "game keys",
"x-displayName": "游戏密钥"
},
{
"name": "virtual items & currency",
"x-displayName": "虚拟物品和货币"
},
{
"name": "bundles",
"x-displayName": "捆绑包"
},
{
"name": "user token",
"x-displayName": "用户令牌"
},
{
"name": "notifications",
"x-displayName": "通知"
},
{
"name": "order",
"x-displayName": "订单"
}
],
"paths": {
"/push-payments/cancel": {
"post": {
"description": "在以下情况下发送支付取消通知：\n - 支付未完成\n - 支付已退款",
"operationId": "cancel-notification",
"requestBody": {
"content": {
"application/json": {
"example": {
"payment_id": 784998479
},
"schema": {
"properties": {
"payment_id": {
"type": "integer"
}
},
"required": [
"payment_id"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "确定。"
},
"400": {
"description": "错误的请求。"
},
"403": {
"description": "拒绝访问。"
},
"404": {
"description": "未找到该支付。"
},
"409": {
"description": "支付已被取消。"
},
"422": {
"description": "取消支付时出错。"
},
"500": {
"description": "内部服务器错误。"
}
},
"servers": [
{
"url": "https://ps.xsolla.com"
}
],
"summary": "取消通知",
"tags": [
"notifications"
]
}
},
"/push-payments/pay": {
"post": {
"description": "成功向用户扣款后发送此通知。",
"operationId": "pay-notification",
"requestBody": {
"content": {
"application/json": {
"example": {
"payment": {
"amount": 10,
"currency": "USD",
"geotype_id": 13038,
"ps_transaction_id": "ps_transaction_id"
},
"project_id": 18404,
"purchase": {
"order_id": 1334430
},
"user": {
"id": "s.ivanov"
}
},
"schema": {
"properties": {
"payment": {
"properties": {
"amount": {
"description": "付款金额。",
"type": "number"
},
"currency": {
"description": "订单货币。虚拟货币使用SKU，真实货币使用三个字母的 [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)代码。",
"type": "string"
},
"geotype_id": {
"description": "艾克索拉侧的分发合作伙伴ID。",
"type": "integer"
},
"project_transaction_id": {
"description": "游戏开发者侧的交易ID。",
"type": "string"
},
"ps_transaction_id": {
"description": "分发合作伙伴侧的交易ID。",
"type": "string"
}
},
"required": [
"geotype_id",
"amount"
],
"type": "object"
},
"project_id": {
"description": "项目ID。",
"type": "integer"
},
"purchase": {
"properties": {
"order_id": {
"description": "订单ID。",
"type": "integer"
}
},
"required": [
"order_id"
],
"type": "object"
},
"user": {
"properties": {
"email": {
"description": "用户邮箱地址。",
"type": "string"
},
"id": {
"description": "游戏中的唯一用户标识符。",
"type": "string"
},
"phone": {
"description": "用户手机号码。",
"type": "string"
},
"ps_account_id": {
"description": "分发合作伙伴侧的用户支付帐户ID。",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"project_id",
"payment",
"purchase",
"user"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"payment_id": 784998484
},
"schema": {
"properties": {
"payment_id": {
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "确定。"
},
"400": {
"description": "错误的请求。"
},
"403": {
"description": "拒绝访问。"
},
"404": {
"description": "未找到订单。"
},
"409": {
"description": "订单已经支付。"
},
"422": {
"description": "创建支付时出错。"
},
"500": {
"description": "内部服务器错误。"
}
},
"servers": [
{
"url": "https://ps.xsolla.com"
}
],
"summary": "支付通知",
"tags": [
"notifications"
]
}
},
"/v2/project/{project_id}/cart": {
"get": {
"description": "返回当前用户的购物车。",
"operationId": "get-user-cart",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/currency-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200"
}
}
},
"description": "已成功返回含商品的购物车。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取当前用户的购物车",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/clear": {
"put": {
"description": "删除所有购物车商品。",
"operationId": "cart-clear",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"204": {
"description": "购物车已成功清空。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "从当前购物车中删除所有购物车商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/fill": {
"put": {
"description": "用商品填充购物车。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。",
"operationId": "cart-fill",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/fill-cart-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"warnings": [
{
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found",
"quantity": 1,
"sku": "booster_mega_21"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200_1"
}
}
},
"description": "已成功返回含商品的购物车。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "在购物车里添加商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/item/{item_sku}": {
"delete": {
"description": "从购物车中删除一个商品。",
"operationId": "delete-item",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"responses": {
"204": {
"description": "购物车中的商品已成功删除。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "从当前购物车中删除购物车商品",
"tags": [
"cart"
]
},
"put": {
"description": "更新现有的购物车商品或在购物车中创建商品。",
"operationId": "put-item",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/put-item-by-cart-id-json-model"
},
"responses": {
"204": {
"description": "购物车已成功更新。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_422_1"
}
}
},
"description": "此类商品不能放入购物车。请选择其他类型的商品。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "更新当前购物车的商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/{cart_id}": {
"get": {
"description": "按购物车ID返回用户的购物车。",
"operationId": "get-cart-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
},
{
"$ref": "#/components/parameters/currency-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200"
}
}
},
"description": "已成功返回含商品的购物车。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按购物车ID获取购物车",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/{cart_id}/clear": {
"put": {
"description": "删除所有购物车商品。",
"operationId": "cart-clear-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
}
],
"responses": {
"204": {
"description": "购物车已成功清空。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按购物车ID删除所有购物车商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"description": "用商品填充指定购物车。如果购物车中已有具有相同SKU的商品，则现有商品位置将被传入的值替换。",
"operationId": "cart-fill-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/fill-cart-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"warnings": [
{
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found",
"quantity": 1,
"sku": "booster_mega_21"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200_1"
}
}
},
"description": "已成功返回含商品的购物车。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "在指定购物车里添加商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": {
"delete": {
"description": "从购物车中删除一个商品。",
"operationId": "delete-item-by-cart-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"responses": {
"204": {
"description": "购物车中的商品已成功删除。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按购物车ID删除购物车商品",
"tags": [
"cart"
]
},
"put": {
"description": "更新现有的购物车商品或在购物车中创建商品。",
"operationId": "put-item-by-cart-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/put-item-by-cart-id-json-model"
},
"responses": {
"204": {
"description": "购物车已成功更新。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "未找到该商品。请确保`project_id`和`item_sku`正确无误。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_422"
}
}
},
"description": "商品数量必须是非负整数。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "按购物车ID更新购物车商品",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/distribution_hub/order/{order_id}": {
"get": {
"description": "检索指定的订单。",
"operationId": "get-order",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/order-id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"content": {
"is_free": "false",
"items": [
{
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"quantity": 1,
"sku": "some_sku"
}
],
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
},
"order_id": 1,
"status": "paid"
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200_1"
}
}
},
"description": "成功的订单请求。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_404"
}
}
},
"description": "未找到订单。请确保`project_id`和`order_id`正确无误。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取订单",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/cart": {
"post": {
"description": "使用购物车中的所有商品创建订单。创建的订单将获得`new`订单状态。",
"operationId": "create-order",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "订单已成功创建。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1401,
"errorMessage": "[0401-1401]: Invalid cart",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422"
}
}
},
"description": "购物车无效。请检查购物车是否存在，内容不能为空，并且其中的所有商品均非免费。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "使用当前购物车中的所有商品创建订单",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/cart/{cart_id}": {
"post": {
"description": "使用指定购物车中的所有商品创建订单。创建的订单将获得`new`订单状态。",
"operationId": "create-order-by-cart-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "订单已成功创建。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1401,
"errorMessage": "[0401-1401]: Invalid cart",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422"
}
}
},
"description": "购物车无效。请检查购物车是否存在，内容不能为空，并且其中的所有商品均非免费。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "使用指定购物车中的所有商品创建订单",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/item/{item_sku}": {
"post": {
"description": "使用指定商品创建订单。创建的订单将获得`new`订单状态。",
"operationId": "create-order-with-item",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "订单已成功创建。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1411,
"errorMessage": "[0401-1411]: Invalid item",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422_1"
}
}
},
"description": "商品无效。请检查该商品是否存在、未禁用、未删除且非免费。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "使用指定商品创建订单",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/user/auth": {
"post": {
"description": "验证用户是否存在于游戏中并创建用户令牌。",
"operationId": "create-user-token",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/post-user-token-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
}
},
"schema": {
"$ref": "#/components/schemas/Common_inline_response_200_1"
}
}
},
"description": "成功收到用户令牌。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "创建用户令牌",
"tags": [
"user token"
]
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"description": "获取用于构建目录的捆绑包列表。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。
",
"operationId": "get-bundle-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-get-bundle-list"
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_10"
}
}
},
"description": "捆绑包列表已成功接收。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取捆绑包列表",
"tags": [
"bundles"
]
}
},
"/v2/project/{project_id}/items/bundle/sku/{sku}": {
"get": {
"description": "获取指定的捆绑包。",
"operationId": "get-bundle",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-get-bundle"
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_client_bundle"
}
}
},
"description": "指定的捆绑包已成功接收。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取指定的捆绑包",
"tags": [
"bundles"
]
}
},
"/v2/project/{project_id}/items/game": {
"get": {
"description": "获取用于构建目录的游戏列表。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-games-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200"
}
}
},
"description": "游戏列表已成功接收。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取游戏列表",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/drm": {
"get": {
"description": "获取可用DRM的列表。",
"operationId": "get-drm-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"drm": [
{
"drm_id": 1,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"name": "Steam",
"redeem_instruction_link": "https://support.steampowered.com",
"sku": "steam"
},
{
"drm_id": 2,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Playstation",
"redeem_instruction_link": "https://support.us.playstation.com",
"sku": "playstation"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_4"
}
}
},
"description": "已成功接收DRM列表。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取DRM列表",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/group/{external_id}": {
"get": {
"description": "从指定组中获取游戏列表以构建目录。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应 50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-games-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-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"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200"
}
}
},
"description": "游戏列表已成功接收。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按指定组获取游戏列表",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/key/group/{external_id}": {
"get": {
"description": "从指定组中获取游戏密钥列表以构建目录。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50个商品。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-game-keys-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-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"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": false,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_2",
"type": "game_key",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_3"
}
}
},
"description": "已成功接收游戏列表。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按指定组获取游戏列表",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/key/sku/{item_sku}": {
"get": {
"description": "获取用于目录的游戏。",
"operationId": "get-game-key-by-sku",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_2"
}
}
},
"description": "已成功收到游戏。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404_1"
}
}
},
"description": "找不到游戏。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取用于目录的游戏",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/sku/{item_sku}": {
"get": {
"description": "获取用于目录的游戏。",
"operationId": "get-game-by-sku",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_1"
}
}
},
"description": "成功收到游戏。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404"
}
}
},
"description": "未找到游戏。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取用于目录的游戏",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/groups": {
"get": {
"description": "获取用于构建目录的商品组列表。",
"operationId": "get-item-groups",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"groups": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 0,
"name": "Accessory",
"order": 1
},
{
"children": [],
"description": "Background",
"external_id": "background",
"level": 0,
"name": "Background",
"order": 1
},
{
"children": [],
"description": "Hair",
"external_id": "hair",
"level": 0,
"name": "Hair",
"order": 1
},
{
"children": [],
"description": "Outfit",
"external_id": "outfit",
"level": 0,
"name": "Outfit",
"order": 1
},
{
"children": [],
"description": "Body",
"external_id": "body",
"level": 0,
"name": "Body",
"order": 1
},
{
"children": [],
"description": "Body",
"external_id": "delete_group",
"level": 0,
"name": "Body",
"order": 1
},
{
"children": [
{
"children": [],
"description": "Group description",
"external_id": "test_group_secure",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 1,
"name": "Test group secure",
"order": 5,
"parent_external_id": "very_cool_group"
}
],
"description": "Very cool group",
"external_id": "very_cool_group",
"level": 0,
"name": "Very cool group",
"order": 1
},
{
"children": [
{
"children": [],
"description": "Group description",
"external_id": "test_group_split",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 1,
"name": "Test group secure",
"order": 1,
"parent_external_id": "test_group_secure"
}
],
"description": "Group description",
"external_id": "test_group_secure",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 0,
"name": "Test group secure",
"order": 1
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9"
}
}
},
"description": "已成功接收组列表。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取项目组列表",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"description": "获取用于构建目录的虚拟货币列表。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-virtual-currency",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - short description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_currency",
"virtual_prices": []
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_currency",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_6"
}
}
},
"description": "虚拟货币列表已成功接收。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取虚拟货币列表",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_currency/package": {
"get": {
"description": "获取用于构建目录的虚拟货币套餐列表。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-virtual-currency-package",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [],
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name first package",
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"sku": "vc_package_1",
"type": "bundle",
"virtual_prices": []
},
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "SHOTGUN FOR TRUE RAIDERS",
"quantity": 200,
"sku": "shotgun_raider",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name third package",
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"sku": "vc_package_3",
"type": "bundle",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7"
}
}
},
"description": "已成功收到虚拟货币套餐列表。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取虚拟货币套餐列表",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"description": "获取用于构建目录的虚拟物品列表。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-virtual-items",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": [
{
"consumable": [
{
"usages_count": 1
}
]
},
{
"expiration_period": [
{
"type": "day"
},
{
"value": 1
}
]
}
],
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5"
}
}
},
"description": "已成功收到虚拟物品列表。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "获取虚拟物品列表",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_items/group/{external_id}": {
"get": {
"description": "从指定组获取商品列表以构建目录。\n\n注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
",
"operationId": "get-virtual-items-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-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"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8"
}
}
},
"description": "来自指定组的商品列表已成功接收。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404_2"
}
}
},
"description": "未找到该组。确保`external_id`正确并且该组没有被关闭或删除。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "按指定组获取商品列表",
"tags": [
"virtual items & currency"
]
}
}
},
"components": {
"securitySchemes": {
"AuthForClient": {
"description": "使用[创建用户令牌](https://developers.xsolla.com\\/zh/api/digital-distribution-hub/operation/create-user-token)端点生成令牌。",
"scheme": "bearer",
"type": "http"
},
"basicAuth": {
"description": "Xsolla API使用基本认证。所有发送到API的请求必须包含`Authorization: Basic `头，其中`your_authorization_basic_key`是根据Base64标准加密的`distribution_hub_id:api_key`对。 \n\n请联系您的帐户经理获取`distribution_hub_id`和`api_key`。",
"scheme": "basic",
"type": "http"
}
},
"parameters": {
"project-id-path-param": {
"description": "项目ID。",
"explode": false,
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
},
"style": "simple"
},
"currency-query-param": {
"description": "显示价格的货币（默认为美元）。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母货币代码。",
"explode": true,
"in": "query",
"name": "currency",
"required": false,
"schema": {
"default": "USD",
"type": "string"
},
"style": "form"
},
"locale-query-param": {
"description": "响应语言。符合ISO 639-1标准的两个小写字母的语言代码。",
"explode": true,
"in": "query",
"name": "locale",
"required": false,
"schema": {
"default": "en",
"type": "string"
},
"style": "form"
},
"item-sku-path-param": {
"description": "商品SKU。",
"explode": false,
"in": "path",
"name": "item_sku",
"required": true,
"schema": {
"example": "booster_mega_1",
"type": "string"
},
"style": "simple"
},
"cart-id-path-param": {
"description": "购物车ID。",
"explode": false,
"in": "path",
"name": "cart_id",
"required": true,
"schema": {
"example": "custom_id",
"type": "string"
},
"style": "simple"
},
"order-id-path-param": {
"description": "订单ID。",
"explode": false,
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"example": "656",
"type": "string"
},
"style": "simple"
},
"limit-query-param": {
"description": "页面上元素数量的限制。",
"example": 50,
"explode": true,
"in": "query",
"name": "limit",
"required": false,
"schema": {
"example": 50,
"type": "integer"
},
"style": "form"
},
"offset-query-param": {
"description": "元素编号，从该元素开始生成列表（从0开始数）。",
"example": 0,
"explode": true,
"in": "query",
"name": "offset",
"required": false,
"schema": {
"example": 0,
"type": "integer"
},
"style": "form"
},
"additional-fields-query-param": {
"description": "附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。可用字段`media_list`、`order`、`long_description`。",
"explode": true,
"in": "query",
"name": "additional_fields[]",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"style": "form"
},
"country-query-param": {
"description": "对于该目录要计算区域价格和限制的国家/地区。符合[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)的两个大写字母的国家/地区代码。如果未明确指定国家/地区，则将根据用户的IP地址进行计算。",
"explode": true,
"in": "query",
"name": "country",
"required": false,
"schema": {
"default": "US",
"type": "string"
},
"style": "form"
},
"sku-path-param": {
"description": "捆绑包SKU。",
"explode": false,
"in": "path",
"name": "sku",
"required": true,
"schema": {
"example": "kg_1",
"type": "string"
},
"style": "simple"
},
"external-id-path-param": {
"description": "组外部ID。",
"explode": false,
"in": "path",
"name": "external_id",
"required": true,
"schema": {
"default": "all",
"type": "string"
},
"style": "simple"
}
},
"schemas": {
"Cart_admin-attribute-external_id": {
"description": "唯一属性ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "attribute_1",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-_]+$",
"type": "string"
},
"Cart_value-external_id": {
"description": "属性的唯一值ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "attribute_value",
"maxLength": 255,
"minLength": 1,
"pattern": "^[-_.\\d\\w]+$",
"type": "string"
},
"Cart_clientattributes_inner": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Cart_admin-attribute-external_id"
},
"name": {
"description": "属性名称。",
"example": "Genre",
"type": "string"
},
"values": {
"items": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Cart_value-external_id"
},
"value": {
"description": "属性值。",
"example": "Strategy",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Cart_client-attributes": {
"default": [],
"description": "与商品对应的属性及其值的列表。可用于目录筛选。",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"items": {
"$ref": "#/components/schemas/Cart_clientattributes_inner"
},
"type": "array"
},
"Cart_inline_response_200_groups": {
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Cart_client-attributes"
},
"description": {
"type": "string"
},
"groups": {
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"type": "string"
},
"is_free": {
"type": "boolean"
},
"name": {
"nullable": true,
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_price": {
"description": "购物车价格。",
"example": "{\"amount\":\"6150.0000000000000000\",\"amount_without_discount\":\"6150.0000000000000000\",\"currency\":\"USD\"}",
"nullable": true,
"properties": {
"amount": {
"default": "50.0000000000000000",
"type": "string"
},
"amount_without_discount": {
"default": "100.0000000000000000",
"type": "string"
},
"currency": {
"default": "USD",
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200": {
"properties": {
"cart_id": {
"description": "购物车ID。",
"example": "cart_id",
"type": "string"
},
"is_free": {
"description": "如果为`true`，则购物车为免费。",
"type": "boolean"
},
"items": {
"example": [
{
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Cart_inline_response_200_price"
}
},
"type": "object"
},
"Cart-Payment_settings_currency": {
"description": "首选支付币种。参照[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)标准的三字母货币代码。",
"type": "string"
},
"Cart_inline_response_200_1_warnings": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_1": {
"properties": {
"cart_id": {
"description": "购物车ID。",
"example": "cart_id",
"type": "string"
},
"is_free": {
"description": "如果为`true`，则购物车为免费。",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Cart_inline_response_200_price"
},
"warnings": {
"example": [
{
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_1_warnings"
},
"type": "array"
}
},
"type": "object"
},
"Cart_inline_response_404": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with Project ID = 44056 and SKU = booster_mega_12222 not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Cart_inline_response_422_1": {
"properties": {
"errorCode": {
"example": 1421,
"type": "integer"
},
"errorMessage": {
"example": "This type of item cannot be put to the cart. Select another type of item.",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Cart_inline_response_422": {
"properties": {
"errorCode": {
"example": 1102,
"type": "integer"
},
"errorMessage": {
"example": "Item quantity must be non-negative integer.",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_price_1": {
"description": "商品价格。",
"properties": {
"amount": {
"description": "折扣后的商品价格。",
"example": "30",
"type": "string"
},
"amount_without_discount": {
"description": "商品价格。",
"example": "30",
"type": "string"
},
"currency": {
"description": "默认购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_items": {
"properties": {
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": "false",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_price_1"
},
"quantity": {
"description": "商品数量。",
"example": 1,
"type": "integer"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "some_sku",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_price": {
"description": "订单价格。",
"properties": {
"amount": {
"description": "订单折扣价。",
"example": "30",
"type": "string"
},
"amount_without_discount": {
"description": "订单价格。",
"example": "30",
"type": "string"
},
"currency": {
"description": "默认购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_virtual_price": {
"description": "以虚拟货币表示的订单价格。",
"properties": {
"amount": {
"description": "订单折扣价。",
"example": "100",
"type": "string"
},
"amount_without_discount": {
"description": "订单价格。",
"example": "150",
"type": "string"
},
"currency": {
"description": "订单中使用的虚拟货币SKU。",
"example": "test_vc",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_1_content": {
"description": "订单详细信息。",
"properties": {
"is_free": {
"description": "如果为`true`，则订单是免费的。",
"example": "false",
"type": "string"
},
"items": {
"description": "商品清单。",
"example": [
{
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"quantity": 1,
"sku": "some_sku"
}
],
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_price"
},
"virtual_price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_virtual_price"
}
},
"type": "object"
},
"Order_inline_response_200_1": {
"properties": {
"content": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content"
},
"order_id": {
"description": "订单ID。",
"example": 1,
"type": "integer"
},
"status": {
"description": "订单状态：`new`/`paid`/`done`/`canceled`。",
"example": "paid",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_404": {
"properties": {
"errorCode": {
"example": 9001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-9001]: Order not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_direct_tax": {
"properties": {
"amount": {
"example": 150,
"type": "number"
},
"name": {
"example": "TAX",
"type": "string"
},
"rate": {
"example": 10,
"type": "number"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_indirect_tax": {
"properties": {
"amount": {
"example": 246.75,
"type": "number"
},
"name": {
"example": "VAT",
"type": "string"
},
"rate": {
"example": 20,
"type": "number"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_price": {
"properties": {
"amount": {
"example": 1480.45,
"type": "number"
},
"currency": {
"description": "购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info": {
"description": "账单信息。",
"properties": {
"direct_tax": {
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_direct_tax"
},
"type": "array"
},
"indirect_tax": {
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_indirect_tax"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_price"
}
},
"type": "object"
},
"Order_inline_response_200": {
"properties": {
"billing_info": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info"
},
"order_id": {
"description": "订单ID。",
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_422": {
"properties": {
"errorCode": {
"example": 1401,
"type": "integer"
},
"errorMessage": {
"example": "[0401-1401]: Invalid cart",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_422_1": {
"properties": {
"errorCode": {
"example": 1411,
"type": "integer"
},
"errorMessage": {
"example": "[0401-1411]: Invalid item",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"email-required": {
"properties": {
"country": {
"description": "参照[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)标准的两个大写字母表示的国家/地区代码。",
"example": "US",
"nullable": true,
"type": "string"
},
"email": {
"description": "用户的电子邮件地址，用于接收购买的游戏密钥。",
"example": "public_email@test.com",
"type": "string"
},
"id": {
"description": "游戏中的唯一用户标识符。",
"example": "public_id",
"nullable": true,
"type": "string"
},
"ip": {
"description": "用户的IP地址。",
"example": "127.0.0.1",
"nullable": true,
"type": "string"
},
"name": {
"description": "用户的公共名称。",
"example": "Public name",
"nullable": true,
"type": "string"
},
"phone": {
"description": "用户的手机号码。",
"example": "+66-000-000-00-00",
"nullable": true,
"type": "string"
}
},
"required": [
"email"
]
},
"Common_inline_response_200_1": {
"properties": {
"token": {
"description": "用户令牌。",
"type": "string"
}
},
"type": "object"
},
"Catalog_admin-attribute-external_id": {
"description": "唯一属性ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "attribute_1",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-_]+$",
"type": "string"
},
"Catalog_value-external_id": {
"description": "属性的唯一值ID。 `external_id`只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "attribute_value",
"maxLength": 255,
"minLength": 1,
"pattern": "^[-_.\\d\\w]+$",
"type": "string"
},
"Catalog_clientattributes_inner": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Catalog_admin-attribute-external_id"
},
"name": {
"description": "属性名称。",
"example": "Genre",
"type": "string"
},
"values": {
"items": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Catalog_value-external_id"
},
"value": {
"description": "属性值。",
"example": "Strategy",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_client-attributes-common": {
"default": [],
"description": "与商品对应的属性及其值的列表。可用于目录筛选。",
"items": {
"$ref": "#/components/schemas/Catalog_clientattributes_inner"
},
"type": "array"
},
"Catalog_bundle_type": {
"description": "捆绑包类型。此情况下始终为`standart`。",
"example": "standart",
"type": "string"
},
"Catalog_client_content_inner": {
"description": "套餐中的商品。",
"properties": {
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"description": "商品价格。",
"nullable": true,
"properties": {
"amount": {
"description": "折扣后的商品价格。",
"example": "100.99",
"type": "string"
},
"amount_without_discount": {
"description": "商品价格。",
"example": "100.99",
"type": "string"
},
"currency": {
"description": "默认购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"quantity": {
"description": "套餐中的商品数量。",
"example": 250,
"type": "integer"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_currency",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"description": "虚拟价格。",
"properties": {
"amount": {
"description": "以虚拟货币表示的折扣后商品价格。",
"example": 100,
"type": "integer"
},
"amount_without_discount": {
"description": "商品价格。",
"example": 200,
"type": "integer"
},
"description": {
"description": "虚拟货币说明。",
"example": "Big Rocket - description",
"type": "string"
},
"image_url": {
"description": "虚拟货币图像。",
"example": "http://image.png",
"type": "string"
},
"is_default": {
"description": "价格是否为商品的默认价格。",
"example": true,
"type": "boolean"
},
"name": {
"description": "虚拟货币名称。",
"example": "SHOTGUN FOR TRUE RAIDERS",
"type": "string"
},
"sku": {
"description": "虚拟货币商品SKU。",
"example": "vc_test",
"type": "string"
},
"type": {
"description": "虚拟货币类型。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_client_content": {
"description": "捆绑包套餐内容。",
"example": [
{
"attributes": [],
"description": "Big Rocket - short description.",
"groups": [],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_client_content_inner"
},
"type": "array"
},
"Catalog_client_description": {
"description": "商品描述。",
"example": "Big Rocket - description.",
"nullable": true,
"type": "string"
},
"Catalog_groups_response_inner": {
"properties": {
"external_id": {
"example": "horror",
"type": "string"
},
"name": {
"example": {
"en": "Horror"
},
"type": "object"
}
},
"type": "object"
},
"Catalog_groups_response": {
"default": [],
"description": "商品所属分组。",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"items": {
"$ref": "#/components/schemas/Catalog_groups_response_inner"
},
"type": "array"
},
"Catalog_image_url": {
"description": "图像URL。",
"example": "https://image.example.com",
"nullable": true,
"type": "string"
},
"Catalog_is_free": {
"default": "false",
"description": "始终为`false`。",
"example": "false",
"type": "string"
},
"Catalog_client_name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"Catalog_amount": {
"description": "折扣后的商品价格。",
"example": "100.99",
"pattern": "^\\d*\\.?\\d*$",
"type": "string"
},
"Catalog_amount_without_discount": {
"description": "商品价格。",
"example": "100.99",
"pattern": "^\\d*\\.?\\d*$",
"type": "string"
},
"Catalog_currency": {
"description": "购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
},
"Catalog_price": {
"description": "商品价格。",
"nullable": true,
"properties": {
"amount": {
"$ref": "#/components/schemas/Catalog_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Catalog_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Catalog_currency"
}
},
"required": [
"amount",
"amount_without_discount",
"currency"
],
"type": "object"
},
"Catalog_sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "bundle_1",
"type": "string"
},
"Catalog_total_content_price": {
"description": "捆绑包内容价格总和。",
"nullable": true,
"properties": {
"amount": {
"description": "折扣后的捆绑包内容价格总和。",
"example": "100.99",
"type": "string"
},
"amount_without_discount": {
"description": "捆绑包内容价格总和。",
"example": "100.99",
"type": "string"
},
"currency": {
"$ref": "#/components/schemas/Catalog_currency"
}
},
"type": "object"
},
"Catalog_type": {
"description": "商品类型。",
"example": "bundle",
"type": "string"
},
"Catalog_virtual_prices_inner": {
"description": "虚拟价格。",
"properties": {
"amount": {
"description": "以虚拟货币表示的折扣后商品价格。",
"example": 100,
"type": "integer"
},
"amount_without_discount": {
"description": "以虚拟货币表示的商品价格。",
"example": 200,
"type": "integer"
},
"description": {
"description": "虚拟货币说明。",
"example": "Most popular gold",
"nullable": true,
"type": "string"
},
"image_url": {
"description": "虚拟货币图像。",
"example": "http://image.png",
"nullable": true,
"type": "string"
},
"is_default": {
"description": "价格是否为商品的默认价格。",
"example": true,
"type": "boolean"
},
"name": {
"description": "虚拟货币名称。",
"example": "Gold",
"type": "string"
},
"sku": {
"description": "虚拟货币商品SKU。",
"example": "gold",
"type": "string"
},
"type": {
"description": "虚拟货币类型。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_virtual_prices_inner"
},
"type": "array"
},
"Catalog_client_bundle": {
"description": "指定的捆绑包。",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"bundle_type": {
"$ref": "#/components/schemas/Catalog_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Catalog_client_content"
},
"description": {
"$ref": "#/components/schemas/Catalog_client_description"
},
"groups": {
"$ref": "#/components/schemas/Catalog_groups_response"
},
"image_url": {
"$ref": "#/components/schemas/Catalog_image_url"
},
"is_free": {
"$ref": "#/components/schemas/Catalog_is_free"
},
"name": {
"$ref": "#/components/schemas/Catalog_client_name"
},
"price": {
"$ref": "#/components/schemas/Catalog_price"
},
"sku": {
"$ref": "#/components/schemas/Catalog_sku"
},
"total_content_price": {
"$ref": "#/components/schemas/Catalog_total_content_price"
},
"type": {
"$ref": "#/components/schemas/Catalog_type"
},
"virtual_prices": {
"$ref": "#/components/schemas/Catalog_virtual_prices"
}
},
"type": "object"
},
"Catalog_inline_response_200_10": {
"description": "包含商品的对象。",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Catalog_client_bundle"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_groups": {
"properties": {
"external_id": {
"example": "accessory",
"type": "string"
},
"name": {
"example": "Accessory",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_price": {
"description": "商品价格。",
"properties": {
"amount": {
"description": "折扣后的商品价格。",
"example": "2.9900",
"type": "string"
},
"amount_without_discount": {
"description": "商品价格。",
"example": "2.9900",
"type": "string"
},
"currency": {
"description": "默认购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_virtual_prices": {
"description": "虚拟价格。",
"properties": {
"amount": {
"description": "折扣后的商品虚拟货币价格。",
"example": 100,
"type": "integer"
},
"amount_without_discount": {
"description": "商品价格。",
"example": 200,
"type": "integer"
},
"description": {
"description": "虚拟货币说明。",
"example": "Big Rocket - description",
"type": "string"
},
"image_url": {
"description": "虚拟货币图像。",
"example": "http://image.png",
"type": "string"
},
"is_default": {
"description": "商品价格是否为默认。",
"example": true,
"type": "boolean"
},
"name": {
"description": "虚拟货币名称。",
"example": "SHOTGUN FOR TRUE RAIDERS",
"type": "string"
},
"sku": {
"description": "虚拟货币商品SKU。",
"example": "vc_test",
"type": "string"
},
"type": {
"description": "虚拟货币类型。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_unit_items": {
"properties": {
"drm_name": {
"description": "DRM名称。",
"example": "Steam",
"type": "string"
},
"drm_sku": {
"description": "唯一DRM ID。SKU只可包含小写英文字母、数字字符、句点、破折号和下划线。",
"example": "steam",
"type": "string"
},
"has_keys": {
"description": "如果为`true`，则游戏密钥有供销售的密钥。",
"example": false,
"type": "boolean"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。",
"example": true,
"type": "boolean"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "符合ISO 8601规定格式的游戏发行日期。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "商品类型：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"description": {
"description": "商品描述。",
"example": "Game description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Game name",
"type": "string"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。",
"example": "unit",
"type": "string"
},
"unit_items": {
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_unit_items"
},
"type": "array"
},
"unit_type": {
"description": "单位类型：`game`。",
"example": "game",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200": {
"description": "包含游戏的对象。",
"properties": {
"items": {
"example": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_4_drm": {
"properties": {
"drm_id": {
"description": "DRM ID。",
"example": 1,
"type": "number"
},
"image": {
"description": "图像URL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"link": {
"description": "兑换链接。",
"example": "https://support.us.playstation.com",
"type": "string"
},
"name": {
"description": "DRM名称。",
"example": "Steam",
"type": "string"
},
"redeem_instruction_link": {
"description": "兑换说明链接。",
"example": "https://support.us.playstation.com",
"type": "string"
},
"sku": {
"description": "唯一DRM ID。SKU只可包含小写英文字母、数字字符、句点、破折号和下划线。",
"example": "steam",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_4": {
"description": "包含游戏的对象。",
"properties": {
"drm": {
"example": [
{
"drm_id": 1,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"name": "Steam",
"redeem_instruction_link": "https://support.steampowered.com",
"sku": "steam"
},
{
"drm_id": 2,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Playstation",
"redeem_instruction_link": "https://support.us.playstation.com",
"sku": "playstation"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_4_drm"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_client-attributes": {
"default": [],
"description": "游戏对应的属性及属性值列表。\n\n注意：这部分响应仅在您发送`additional_fields[]=attributes`查询参数时可用。
",
"items": {
"$ref": "#/components/schemas/Catalog_clientattributes_inner"
},
"type": "array"
},
"Catalog_inline_response_200_3_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "商品描述。",
"example": "Game description",
"type": "string"
},
"drm_name": {
"description": "DRM名称。",
"example": "Steam",
"type": "string"
},
"drm_sku": {
"description": "唯一DRM ID。SKU只可包含小写英文字母、数字字符、句点、破折号和下划线。",
"example": "steam",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"has_keys": {
"description": "如果为`true`，则游戏密钥有供销售的密钥。",
"example": false,
"type": "boolean"
},
"image_url": {
"description": "图像URL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。",
"example": true,
"type": "boolean"
},
"name": {
"description": "商品名称。",
"example": "Game name",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "符合ISO 8601规定格式的游戏发行日期。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "商品类型：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_3": {
"description": "包含游戏的对象。",
"properties": {
"items": {
"example": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": false,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_2",
"type": "game_key",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_3_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_2": {
"description": "包含游戏密钥信息的对象。",
"example": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"description": {
"description": "商品描述。",
"example": "Game description",
"type": "string"
},
"drm_name": {
"description": "DRM名称。",
"example": "Steam",
"type": "string"
},
"drm_sku": {
"description": "唯一DRM ID。SKU只可包含小写英文字母、数字字符、句点、破折号和下划线。",
"example": "steam",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"has_keys": {
"description": "如果为`true`，则游戏密钥有供销售的密钥。",
"example": false,
"type": "boolean"
},
"image_url": {
"description": "图像URL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "如果为`true`，则游戏密钥为预订，并且发布日期尚未到来。",
"example": true,
"type": "boolean"
},
"name": {
"description": "商品名称。",
"example": "Game name",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "符合ISO 8601规定格式的游戏发行日期。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "商品类型：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_404_1": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with sku = 'game_key_1' not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_1": {
"description": "包含游戏信息的对象。",
"example": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "商品描述。",
"example": "Game description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Game name",
"type": "string"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。",
"example": "unit",
"type": "string"
},
"unit_items": {
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_unit_items"
},
"type": "array"
},
"unit_type": {
"description": "单位类型：`game`。",
"example": "game",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_404": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with sku = 'game_1' not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_children": {
"properties": {
"children": {
"description": "子组。",
"example": [],
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "组描述。",
"example": "Accessory",
"type": "string"
},
"external_id": {
"description": "外部组ID。",
"example": "accessory",
"type": "string"
},
"image_url": {
"description": "图像URL。",
"type": "string"
},
"level": {
"description": "组嵌套层级。",
"example": 2,
"type": "integer"
},
"name": {
"description": "组名称。",
"example": "Accessory",
"type": "string"
},
"order": {
"description": "定义排列顺序。",
"example": 1,
"type": "integer"
},
"parent_external_id": {
"description": "父外部组ID。",
"example": "background",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_children_1": {
"properties": {
"children": {
"description": "子组。",
"example": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_children"
},
"type": "array"
},
"description": {
"description": "组描述。",
"example": "Background description",
"type": "string"
},
"external_id": {
"description": "外部组ID。",
"example": "background",
"type": "string"
},
"image_url": {
"description": "组图片URL。",
"type": "string"
},
"level": {
"description": "组嵌套层级。",
"example": 1,
"type": "integer"
},
"name": {
"description": "组名称。",
"example": "Background",
"type": "string"
},
"order": {
"description": "定义排列顺序。",
"example": 1,
"type": "integer"
},
"parent_external_id": {
"description": "父外部组ID。",
"example": "hair",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_groups": {
"properties": {
"children": {
"description": "子组。",
"example": [
{
"children": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"description": "Background description",
"external_id": "background",
"level": 1,
"name": "Background",
"order": 1,
"parent_external_id": "hair"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_children_1"
},
"type": "array"
},
"description": {
"description": "组描述。",
"example": "Hair description",
"type": "string"
},
"external_id": {
"description": "外部组ID。",
"example": "hair",
"type": "string"
},
"image_url": {
"description": "图像URL。",
"type": "string"
},
"level": {
"description": "组嵌套层级。",
"example": 0,
"type": "integer"
},
"name": {
"description": "组名称。",
"example": "Hair",
"type": "string"
},
"order": {
"description": "定义排列顺序。",
"example": 1,
"type": "integer"
},
"parent_external_id": {
"description": "父外部组ID。",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_9": {
"properties": {
"groups": {
"example": [
{
"children": [
{
"children": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"description": "Background description",
"external_id": "background",
"level": 1,
"name": "Background",
"order": 1,
"parent_external_id": "hair"
}
],
"description": "Hair description",
"external_id": "hair",
"level": 0,
"name": "Hair",
"order": 1
},
{
"children": [],
"description": "Super description",
"external_id": "group_external_id",
"level": 0,
"name": "Super",
"order": 1
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_groups"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options_consumable": {
"description": "如果为消耗品，则定义消耗品属性；如果为非消耗品，则为`null`。",
"nullable": true,
"properties": {
"usages_count": {
"description": "如果为消耗品，则为总剩余使用次数；如果为非消耗品，则为`null`。",
"example": 1,
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options_expiration_period": {
"description": "如果为到期商品，则定义到期属性；如果为非到期商品，则为`null`。",
"nullable": true,
"properties": {
"type": {
"description": "定义商品到期类型。",
"enum": [
"minute",
"hour",
"day",
"week",
"month",
"year"
],
"example": "day",
"type": "string"
},
"value": {
"description": "定义有效期的值。",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options": {
"description": "定义物品库商品选项。",
"properties": {
"consumable": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable"
},
"expiration_period": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_expiration_period"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_price": {
"description": "商品价格。",
"properties": {
"amount": {
"description": "折扣后的商品价格。",
"example": "100.99",
"type": "string"
},
"amount_without_discount": {
"description": "商品价格。",
"example": "100.99",
"type": "string"
},
"currency": {
"description": "默认购买货币。符合[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)的三字母代码。",
"example": "USD",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_6_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": "false",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_currency",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"example": [
{
"amount": 100,
"amount_without_discount": 100,
"image_url": "http://image.png",
"is_default": true,
"sku": "shotgun_raider"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_6": {
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"description": "Big Rocket - short description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "1"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_currency",
"virtual_prices": []
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_currency",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_6_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_inventory_options_expiration_period": {
"description": "如果为到期商品，则定义到期属性；如果为非到期商品，则为`null`。",
"nullable": true,
"properties": {
"type": {
"description": "定义商品的到期类型。",
"enum": [
"minute",
"hour",
"day",
"week",
"month",
"year"
],
"example": "day",
"type": "string"
},
"value": {
"description": "定义有效期的值。",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_inventory_options": {
"description": "定义物品库商品选项。",
"properties": {
"consumable": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable"
},
"expiration_period": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options_expiration_period"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_content": {
"description": "套餐中的虚拟货币。",
"properties": {
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"quantity": {
"description": "套餐中的虚拟货币数量。",
"example": 250,
"type": "integer"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"bundle_type": {
"description": "捆绑包类型：`standard`/`virtual_currency_package`。",
"example": "virtual_currency_package",
"type": "string"
},
"content": {
"description": "虚拟货币套餐内容。",
"example": [
{
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_content"
},
"type": "array"
},
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": "false",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "bundle",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_7": {
"description": "包含商品的对象。",
"properties": {
"items": {
"example": [
{
"attributes": [],
"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",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name first package",
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"sku": "vc_package_1",
"type": "bundle",
"virtual_prices": []
},
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "SHOTGUN FOR TRUE RAIDERS",
"quantity": 200,
"sku": "shotgun_raider",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name third package",
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"sku": "vc_package_3",
"type": "bundle",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": false,
"type": "boolean"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_good",
"type": "string"
},
"virtual_item_type": {
"description": "虚拟物品的类型。",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
],
"example": "non-consumable",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5": {
"description": "含虚拟物品的对象。",
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_8_virtual_prices": {
"description": "虚拟价格。",
"properties": {
"amount": {
"description": "折扣后的商品虚拟货币价格。",
"example": 100,
"type": "integer"
},
"amount_without_discount": {
"description": "商品价格。",
"example": 200,
"type": "integer"
},
"description": {
"description": "虚拟货币说明。",
"example": "Big Rocket - description",
"type": "string"
},
"image_url": {
"example": "http://image.png",
"type": "string"
},
"is_default": {
"description": "价格是否为商品的默认价格。",
"example": true,
"type": "boolean"
},
"name": {
"description": "虚拟货币名称。",
"example": "SHOTGUN FOR TRUE RAIDERS",
"type": "string"
},
"sku": {
"description": "虚拟货币商品SKU。",
"example": "vc_test",
"type": "string"
},
"type": {
"description": "虚拟货币类型。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_8_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "商品描述。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "商品所属分组。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "图像URL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options"
},
"is_free": {
"description": "如果为`true`，则该商品为免费。",
"example": "false",
"type": "string"
},
"name": {
"description": "商品名称。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "商品类型：`consumable`/`expiration`/`permanent`/`lootboxes`/`physical`。",
"example": "virtual_good",
"type": "string"
},
"virtual_item_type": {
"description": "虚拟物品的类型。",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
],
"example": "non_consumable",
"type": "string"
},
"virtual_prices": {
"description": "虚拟价格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_8": {
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"description": "description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_404_2": {
"properties": {
"errorCode": {
"example": 4403,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4403]: Item group not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
}
},
"requestBodies": {
"fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"example": [
{
"quantity": 123,
"sku": "booster_mega_1"
}
],
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"items": {
"description": "商品列表。",
"items": {
"minItems": 1,
"properties": {
"quantity": {
"default": 123,
"type": "number"
},
"sku": {
"default": "booster_mega_1",
"type": "string"
}
},
"required": [
"quantity",
"sku"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
}
}
},
"put-item-by-cart-id-json-model": {
"content": {
"application/json": {
"schema": {
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"quantity": {
"default": 123,
"description": "商品数量。",
"type": "number"
}
},
"type": "object"
}
}
}
},
"create-order-model": {
"content": {
"application/json": {
"schema": {
"example": {
"geotype": 13038
},
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"geotype": {
"description": "艾克索拉侧的分发合作伙伴ID。",
"type": "number"
},
"quantity": {
"description": "商品数量。",
"example": 1,
"type": "integer"
}
},
"required": [
"geotype",
"currency"
],
"type": "object"
}
}
},
"description": "包含订单创建数据的对象。",
"required": true
},
"post-user-token-json-model": {
"content": {
"application/json": {
"schema": {
"properties": {
"user": {
"$ref": "#/components/schemas/email-required",
"description": "用户详细信息。",
"type": "object"
}
},
"required": [
"user"
],
"type": "object"
}
}
}
}
},
"examples": {
"200-get-bundle-list": {
"value": {
"items": [
{
"attributes": {
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
},
"bundle_type": "standard",
"content": [
{
"attributes": {
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
},
"description": "Big Rocket - short description.",
"groups": [],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_item_type": "non_consumable",
"virtual_prices": []
}
],
"description": "pricePoint_44056_1",
"groups": [],
"is_free": false,
"media_list": [],
"name": "kg_10.00_bundle",
"order": 999,
"price": {
"amount": 9.99,
"amount_without_discount": 9.99,
"currency": "USD"
},
"sku": "kg_1",
"total_content_price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"type": "bundle",
"virtual_prices": []
}
]
}
},
"200-get-bundle": {
"value": {
"attributes": [],
"bundle_type": "standard",
"content": [
{
"attributes": [],
"description": "Big Rocket - short description.",
"groups": [],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": []
}
],
"description": "pricePoint_44056_1.",
"groups": [],
"is_free": false,
"media_list": [],
"name": "kg_10.00_bundle",
"order": 999,
"price": {
"amount": 9.99,
"amount_without_discount": 9.99,
"currency": "USD"
},
"sku": "kg_1",
"total_content_amount": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"type": "bundle",
"virtual_prices": []
}
}
}
},
"x-tagGroups": [
{
"name": "购物车",
"tags": [
"cart"
]
},
{
"name": "目录",
"tags": [
"game keys",
"virtual items & currency",
"bundles"
]
},
{
"name": "通用",
"tags": [
"user token"
]
},
{
"name": "通知",
"tags": [
"notifications"
]
},
{
"name": "订单",
"tags": [
"order"
]
}
]
}