Xsolla-logo

Create virtual currencyServer-sideAdmin

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

Creates a virtual currency.

Request
path Parameters
project_id
required
integer

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Request Body schema: application/json
sku
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

required
object

Object with localizations for item's name. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
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
object

Object with localizations for item's description. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
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
object

Object with localizations for long description of item. Two-letter lowercase language code.

en
string or null
ar
string or null
bg
string or null
cn
string or null
cs
string or null
de
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
image_url
string
Array of objects

Item's additional assets such as screenshots, gameplay video and so on.

Array
type
string

Type of media: image/video.

Enum: "image" "video"
url
string

Resource file.

Array of objects
Default: []

Groups the item belongs to.

Array
external_id
string
object
Default: {"en":"Horror"}

Name of item. Should contain key/value pairs where key is a locale with "^[a-z]{2}" format, value is string.

additionalProperties
string
Array of objects <= 20 items

List of attributes.

Attention. You can't specify more than 20 attributes for the item. Any attempts to exceed the limit result in an error.
Array (<= 20 items)
external_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

Unique attribute ID. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.

required
Array of objects
Attention. You can't create more than 6 values for each attribute. Any attempts to exceed the limit result in an error.
Array
required
object
Default: {"en":"Strategy","de":"Strategie"}

Object with localizations of the value's name. Keys are specified in ISO 3166-1.

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

Unique value ID for an attribute. The external_id may only contain lowercase Latin alphanumeric characters, dashes, and underscores.

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

Object with localizations for attribute's name. Keys are specified in ISO 3166-1.

property name*
additional property
string
Array of objects
Array
amount
required
number > 0

Amount.

currency
required
string

Item price currency. Three-letter code per ISO 4217. Check the documentation for detailed information about currencies supported by Xsolla.

is_default
boolean
Default: false
is_enabled
boolean
Default: true
country_iso
string or null

Country where this price is available. Two-letter code per ISO 3166-1 alpha 2.

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

The price is enabled.

sku
string

Unique item ID. The SKU may only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.

is_enabled
boolean
is_deleted
boolean
is_show_in_store
boolean
is_free
boolean
Default: false

If true, the item is free.

is_hard
boolean
order
integer

Defines arrangement order.

object
release_date
required
string or null <date-time>
is_enabled
required
boolean
description
string or null
Array of objects
Array
id
integer >= 1
object

Item limits.

per_user
integer or null

Item limitation for a separate user.

per_item
integer or null

Global item limitation.

object or null

Limit refresh period.

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

Daily type of user limits refresh.

interval_type
required
string

Recurrent refresh period.

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

Time of limit refresh in the desired time zone (rounding to hours).

Array of objects or null

Item sales period.

Array
date_from
string <date-time>

Date when the specified item will be available for sale.

date_until
string or null <date-time>

Date when the specified item will become unavailable for sale. Can be null.

custom_attributes
object <json> <= 500 characters

A JSON object containing item attributes and values. Attributes allow you to add more info to items like the player's required level to use the item. Attributes enrich your game's internal logic and are accessible through dedicated GET methods and webhooks.

Responses
201

Virtual item was successfully created.

422

Invalid request.

Request samples
application/json
{
  • "sku": "coin",
  • "name": {
    },
  • "is_enabled": true,
  • "is_free": false,
  • "groups": [
    ],
  • "order": 1,
  • "description": {
    },
  • "prices": [
    ],
  • "attributes": [
    ],
  • "limits": {
    },
  • "periods": [
    ],
  • "custom_attributes": {
    }
}
Response samples
application/json
{
  • "sku": "new-sku"
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2024 Xsolla Inc.