Xsolla-logoXsolla Developers
or
To Publisher Account

Update virtual currency packageServer-sideAdmin

put/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}

Updates a virtual currency package.

SecuritybasicAuth
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
item_sku
required
string

Item SKU.

Example: booster_mega_1
query Parameters
promo_code
string [ 1 .. 128 ] characters

Unique case sensitive code. Contains letters and numbers.

Example: promo_code=WINTER2021
Request Body schema: application/json
Any of:
required
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.

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

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

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

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

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

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

required
Array of objects = 1 characters

Virtual currency package should contain only 1 position of virtual currency.

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

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

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

Object with localizations for long description of item. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both variants for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

Any of:

Two-letter lowercase language codes.

en
string or null

English

ar
string or null

Arabic

bg
string or null

Bulgarian

cn
string or null

Chinese (Simplified)

cs
string or null

Czech

de
string or null

German

es
string or null

Spanish (Spain)

fr
string or null

French

he
string or null

Hebrew

it
string or null

Italian

ja
string or null

Japanese

ko
string or null

Korean

pl
string or null

Polish

pt
string or null

Portuguese

ro
string or null

Romanian

ru
string or null

Russian

th
string or null

Thai

tr
string or null

Turkish

tw
string or null

Chinese (Traditional)

vi
string or null

Vietnamese

km
string or null

Khmer

id
string or null

Indonesian

lo
string or null

Lao

my
string or null

Burmese

ph
string or null

Filipino

ne
string or null

Nepali

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.

groups
Array of strings

Groups the item belongs to.

Note. The string value refers to group `external_id`.
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 contain only lowercase and uppercase 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
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 contain only lowercase and uppercase 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.

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
204

Virtual item was successfully updated.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

422

Invalid request.

Request samples
application/json
{
  • "sku": "com.xsolla.novigrad_crown_500",
  • "name": {
    },
  • "is_enabled": true,
  • "is_free": false,
  • "groups": [
    ],
  • "order": 1,
  • "long_description": {
    },
  • "description": {
    },
  • "media_list": [],
  • "attributes": [
    ],
  • "prices": [
    ],
  • "vc_prices": null,
  • "content": [
    ],
  • "limits": {
    },
  • "periods": [
    ],
  • "custom_attributes": {
    }
}
Response samples
application/json
{
  • "statusCode": 401,
  • "errorCode": 1020,
  • "errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
OSZAR »