Add

post https://us-central1-readysandbox.cloudfunctions.net/virtualItemsV2-add

Adds a new virtual item to the database attached to the specified application ID.

Responses

Response body

object

virtualItem

object

Represents the data structure of a virtual item within the PLAY ecosystem.

string

Unique id of the virtual item.

name

string | null

Virtual item name. Is used also to store localization key for the name.

description

string | null

Virtual item description. Is used also to store localization key for the description.

requestName

string | null

Virtual item request name. Is used to identify the virtual item in human readable format.

image

object

Virtual item image object. Contains URLs to different sizes of the source uploaded image.

isStackable

boolean

Indicates if an item can be stacked. Non-stackable items create a new item in inventory when added.

isNFT

boolean

Indicates if the virtual item is a NFT. The NFT virtual items require primary user wallet.

appIds

array of strings

required

List of application ids where this item is used.

appIds*

tags

childs

array of strings

List of child virtual items' ids. Used to build tree structure hierarchies.

childs

properties

array of objects

List of virtual item custom json. Used to store game-specific data.

properties

object

appIds

array of strings | null

appIds

json

string | null

prices

array of objects

Array of prices for the virtual item. A virtual item can be sold for different currencies.

prices

object

appIds

array of strings | null

List of application ids where this price information is used

appIds

itemId

string | null

Virtual item id related to this price information This field is optional. If it is not set, then the price is for the whole store offer

name

string | null

Name of the coin. Reserved name is "rgn-coin" This field is used to calculate the price of the virtual item For example: if you sell a virtual item for 100 coins, then the name is "coin_name" This field is optional. If it is not set, then the name is "rgn-coin"

quantity

int32

Quantity of the coins the virtual item is sold for This field is used to calculate the price of the virtual item For example: if you sell a virtual item for 100 coins, then the quantity is 100

quantityWithoutDiscount

int32

Quantity of the coins the virtual item is sold for without discount This field serves UI purposes to indicate "for sale" items

group

string | null

Group information of the price. It is possible to group multiple prices together. For example, you can sell a virtual item for "coin_name_1" and "coin_name_2" coins. This field works like a tag. Two prices with the same group name are combined together.

nextPriceChangeAt

int64

Date and time when the price will be updated in milliseconds since midnight, January 1, 1970 UTC.

totalQuantity

int64

Quantity of goods left (use only for NFT items).

blockchain

object

Blockchain information, in case the virtual item is minted.

marketableFrom

int64

Date and time when the virtual item becomes marketable in milliseconds since midnight, January 1, 1970 UTC. This field is used in marketplace functionality. If not provided, the item is marketable from the creation date.

hidden

boolean

Defaults to false

Indicates if the virtual item is hidden from the user. Hidden items are not displayed in the user's inventory.
To retrieve hidden items, provide the 'includeHidden' flag in the requests.

tradable

boolean

Defaults to true

Indicates if the virtual item is tradable on the marketplace.

createdAt

int64

Date and time when the virtual item was created in milliseconds since midnight, January 1, 1970 UTC. Automatically populated by the backend.

updatedAt

int64

Date and time when the virtual item data was last time updated in milliseconds since midnight, January 1, 1970 UTC. Automatically populated by the backend.

createdBy

string

User Id who created the virtual item. This field is automatically populated by the backend.

updatedBy

string

User Id who last time updated the item. This field is automatically populated by the backend.

400

Bad request

Language

Credentials

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/virtualItemsV2-add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "virtualItem": {
8
    "hidden": false,
9
    "tradable": true
10
  }
11
}
12
'


xxxxxxxxxx
60
}
1
{
2
  "virtualItem": {
3
    "id": "string",
4
    "name": "string",
5
    "description": "string",
6
    "requestName": "string",
7
    "image": {
8
      "source": "string",
9
      "large": "string",
10
      "medium": "string",
11
      "small": "string"
12
    },
13
    "isStackable": true,
14
    "isNFT": true,
15
    "appIds": [
16
      "string"
17
    ],
18
    "tags": [
19
      "string"
20
    ],
21
    "childs": [
22
      "string"
23
    ],
24
    "properties": [
25
      {

200Virtual item added successfully

401Unauthenticated error 401 indicating the user is not authenticated.