Xsolla-logo

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

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

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

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

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

Example: 44056
Request Body schema: application/json
Any of:
required
Array of objects
Array
amount
required
number > 0

Сумма.

currency
required
string

Валюта покупки по умолчанию. Трехбуквенный код в соответствии с ISO 4217.

country_iso
string or null

Страна, где доступна эта цена. Двухбуквенный код в соответствии с ISO 3166-1 alpha 2.

is_default
boolean
Default: false
is_enabled
boolean
Default: true
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

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

required
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
required
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
required
Array of objects = 1 characters

Пакет виртуальной валюты должен содержать только 1 позицию виртуальной валюты.

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

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

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-методы и вебхуки.

groups
Array of strings

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

Примечание. Строковое значение относится к группе `external_id`.
image_url
string
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

Ссылка на файл.

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
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

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

401

Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию и проверьте правильность учетных данных.

422

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

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