Xsolla-logo
  • 文档
  • 创建帐户

创建虚拟物品

post/v2/project/{project_id}/admin/items/virtual_items

创建虚拟物品。

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

项目编号。您可以在您的发布商帐户项目名称旁边。

Example: 44056
Request Body schema: application/json
Array of objects <= 20 items

属性列表。

注意:为每个商品指定的属性不能超过20个。任何超出限制的尝试都会导致错误。
Array (<= 20 items)
external_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

唯一属性ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

required
Array of objects
注意:为每个属性创建的值不能超过6个。任何超出限制的尝试都会导致错误。
Array
required
object
Default: {"de":"Strategie","en":"Strategy"}

包含本地化值名称的对象。编码按照ISO 3166-1的规定。

property name*
additional property
string
external_id
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

属性的唯一值ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

object
Default: {"de":"Genre","en":"Genre"}

包含本地化属性名称的对象。编码按照ISO 3166-1的规定。

property name*
additional property
string
custom_attributes
object <json> <= 500 characters

包含商品属性和值的JSON对象。属性允许您向商品添加更多信息,例如玩家使用该商品所需的等级。属性可丰富游戏的内部逻辑,并且可以通过专用的GET方法和webhook进行访问。

object

包含本地化商品描述的对象。两个小写字母的语言代码

ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
en
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
groups
Array of strings

商品所属的组。

注:字符串值引用组`external_id`。
image_url
string

图像URL。

object

定义物品库商品选项。

object or null

如果为消耗品,则定义消耗品属性;如果为非消耗品,则为null

usages_count
integer or null

如果为消耗品,则为总剩余使用次数;如果为非消耗品,则为null

object or null

如果为到期商品,则定义到期属性;如果为非到期商品,则为null

type
string

定义商品到期类型。

Enum: "minute" "hour" "day" "week" "month" "year"
value
integer

定义有效期的值。

is_deleted
boolean
is_enabled
boolean
is_free
boolean
Default: false

如果为true,则该商品为免费。

is_show_in_store
boolean
object

商品限制。

per_item
integer or null

全局商品限制。

per_user
integer or null

用于单独用户的商品限制。

object or null

限制次数刷新周期。

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)
One of:

每天类型的用户限制次数刷新。

interval_type
required
string

循环刷新周期。

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

所需时区的限制次数刷新时间(四舍五入到小时)。

object

包含本地化商品长描述的对象。两个小写字母的语言代码

ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
en
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
Array of objects

商品的附加资源,例如屏幕截图、游戏视频等。

Array
type
string

媒体类型:image/video

Enum: "image" "video"
url
string

资源文件。

object

包含本地化商品名称的对象。两个小写字母的语言代码

ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
string or null
en
string or null
es
string or null
fr
string or null
he
string or null
it
string or null
ja
string or null
ko
string or null
pl
string or null
pt
string or null
ro
string or null
ru
string or null
th
string or null
tr
string or null
tw
string or null
vi
string or null
order
integer

定义排列顺序。

Array of objects or null

商品促销时间段。

Array
date_from
string <date-time>

指定商品促销开始的日期。

date_until
string or null <date-time>

指定商品停止促销的日期。可以为null

object
release_date
required
string or null <date-time>
is_enabled
required
boolean
description
string or null
Array of objects
Array
amount
required
number > 0

金额。

currency
required
string

默认购买货币。符合ISO 4217的三字母代码。

country_iso
string

国家/地区格式应遵循ISO 3166-1 alpha-2标准。

is_default
boolean
Default: false
is_enabled
boolean
Default: true
Array of objects
Array
id
integer >= 1
sku
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。

Array of objects
Array
amount
required
integer
is_default
required
boolean
Default: false
is_enabled
required
boolean
Default: false

价格已启用。

sku
string

唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。

Responses
201

虚拟物品已成功创建。

422

无效的请求。

Request samples
application/json
{
  • "attributes": [
    ],
  • "custom_attributes": {
    },
  • "description": {
    },
  • "groups": [
    ],
  • "is_enabled": true,
  • "is_free": false,
  • "is_show_in_store": true,
  • "limits": {
    },
  • "name": {
    },
  • "order": 1,
  • "periods": [
    ],
  • "prices": [
    ],
  • "sku": "sword",
  • "vc_prices": [ ]
}
Response samples
application/json
{
  • "sku": "new-sku"
}