Create value point

Xsolla Developers

To Publisher Account

Create value pointServer-sideAdmin

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

Creates a value point.

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

Request Body schema: application/json

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

(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

image_url

string

Image URL.

is_enabled

boolean

(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

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.

order

integer

Defines arrangement order.

is_clan

boolean

Whether the value point is used in clan reward chains.

Responses

201

Value point was successfully created.

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.reward_vp_1",
"name": {"en": "Reward VP 1"
},
"is_enabled": true,
"description": {"en": "Value points for reward system."
},
"long_description": {"en": "Value points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [ ],
"order": 1
}

Response samples

application/json

{"sku": "com.xsolla.item_new",
"item_id": 10
}