Создание виртуальной валюты

Xsolla Developers

или

Личный кабинет

Создание виртуальной валютыServer-sideAdmin

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

Создает виртуальную валюту.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056

Request Body schema: application/json

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

required

(two-letter (object or null)) or (five-letter (object or null))

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Двухбуквенные строчные языковые коды.

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 Spanish (Spain)
fr	string or null Французский
he	string or null Иврит
id	string or null Индонезийский
it	string or null Итальянский
ja	string or null Японский
km	string or null Кхмерский
ko	string or null Корейский
lo	string or null Лаосский
my	string or null Бирманский
ne	string or null Непальский
ph	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 <= 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-методы и вебхуки.

(two-letter (object or null)) or (five-letter (object or null))

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

One of:

Двухбуквенные строчные языковые коды.

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 Spanish (Spain)
fr	string or null Французский
he	string or null Иврит
id	string or null Индонезийский
it	string or null Итальянский
ja	string or null Японский
km	string or null Кхмерский
ko	string or null Корейский
lo	string or null Лаосский
my	string or null Бирманский
ne	string or null Непальский
ph	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

Default: []

Группы, к которым принадлежит товар.

Array

external_id

string

object

Default: {"en":"Horror"}

Название элемента. Должно содержать пары ключ/значение, где ключ — это языковой стандарт в {2}формате "^[a-z]", значение — строка.

property name*

additional property

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Если true, товар бесплатный.

is_hard

boolean

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... Время обновления ограничений в желаемом часовом поясе (округление до часов).

(two-letter (object or null)) or (five-letter (object or null))

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

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 Spanish (Spain)
fr	string or null Французский
he	string or null Иврит
id	string or null Индонезийский
it	string or null Итальянский
ja	string or null Японский
km	string or null Кхмерский
ko	string or null Корейский
lo	string or null Лаосский
my	string or null Бирманский
ne	string or null Непальский
ph	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 Ссылка на файл.

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. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
country_iso	string or null Страна, где доступна эта цена. Двухбуквенный код в соответствии с ISO 3166-1 alpha 2.
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false Цена включена.
sku	string Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

Responses

201

Виртуальный предмет успешно создан.

422

Неверный запрос.

Request samples

application/json

{"attributes": [{"external_id": "material",
"name": {"en-US": "Material"
},
"values": [{"external_id": "gold",
"value": {"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": ["gold"
],
"is_enabled": true,
"is_free": false,
"limits": {"per_item": 10000,
"per_user": 5
},
"name": {"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [{"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "com.xsolla.coin_1"
}

Response samples

application/json

{"sku": "com.xsolla.item_1"
}