Create virtual currency package

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

Creates 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

Request Body schema: application/json

Any of:

required

Array of objects

Array

amount required	number > 0 Amount.
currency required	string Default purchase currency. Three-letter code per ISO 4217.
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 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

required

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

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 only contain lowercase Latin alphanumeric characters, periods, dashes, and underscores.
quantity	integer

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

Array

required

integer

external_id

required

string

object

property name*

additional property

string or null

object

property name*

additional property

string or null

image_url

string or null

level

integer

order

integer

parent_group_id

integer or null

children

Array of objects

Default: []

parent_external_id

string or null

is_enabled

boolean

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

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.

401

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

422

Invalid request.

Request samples

application/json

{"sku": "novigrad_crown_500",
"name": {"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"order": 1,
"long_description": {"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [{"type": "image",
"url": "https://test.com/image0"
},
{"type": "image",
"url": "https://test.com/image1"
}
],
"groups": ["witcher"
],
"attributes": [{"external_id": "event",
"name": {"en-US": "Event"
},
"values": [{"external_id": "10-anniversary",
"value": {"en-US": "10th anniversary"
}
},
{"external_id": "christmas",
"value": {"en-US": "Christmas"
}
}
]
}
],
"prices": [{"currency": "USD",
"amount": 99.99,
"is_default": true
},
{"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [{"sku": "novigrad_crown",
"quantity": 500
}
],
"limits": {"per_user": null,
"per_item": null
},
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {"purchased": 0,
"attr": "value"
}
}

Response samples

application/json

{"sku": "new-sku"
}