Get by Id

post https://us-central1-readysandbox.cloudfunctions.net/inventoryV2-getById

Retrieve virtual item inventory data by owned item ID

Responses

Response body

object

inventoryItem

object

Represents the data structure of an inventory item within the PLAY ecosystem.

appIds

array of strings

required

List of application ids where this item is used.

appIds*

string

required

Unique id of the inventory item.

virtualItemId

string

required

The Virtual Item id for this inventory item.

offerId

string | null

The ID of the marketplace offer in case the item is on sale.

tags

array of strings

List of tags to filter the offers. Multiple inventory items can be categorized under one tag.

tags

quantity

integer

required

Represents the count of Virtual Items in user inventory. For non-stackable Virtual Items, this value is always one.

isLocked

boolean

Indicates if the inventory item is locked. Locked items cannot be traded or sold. The item becomes locked when a marketplace offer is created. The item is unlocked when the offer is deleted or the item is sold.

status

string

Current status of inventory item. Confirmed for nonNFT items and can have pending status for NFT items after
purchase, changing to confirmed after blockchain confirmation. The status can be also 'marketplace_pending' for items
that are sold in the marketplace.
Possible values are:

pending - The item is pending. This status is used for NFT items after purchase.
confirmed - The item is confirmed. After blockchain confirmation, the status changes to confirmed.
on_sale - The item is on sale in the marketplace.
marketplace_pending - The item is pending in the marketplace. This status is used for items that are sold in the marketplace.

pending confirmed on_sale marketplace_pending

hidden

boolean

Defaults to false

Indicates if the inventory item is hidden from the user. If you want to hide the item, set the 'hidden' flag to true in Virtual Item data.
If you want to get the hidden items, you need to use the 'includeHidden' flag in the requests.

tradable

boolean

Defaults to true

Indicates if the inventory item is tradable on marketplace. If you want to make the item non tradable, set the 'tradable' flag to false in Virtual Item data.

createdAt

int64

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

updatedAt

int64

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

itemUpgrades

array of objects

List of upgrades for non-stackable virtual items, allowing multiple upgrades with different names and values for one item.

itemUpgrades

object

upgradeId

string

required

Identifier for the specific upgrade.

upgradeLevel

integer

required

The level of the upgrade.

properties

array of objects

List of inventory item custom json properties used to store game-specific json.

properties

object

appIds

array of strings | null

appIds

json

string | null

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

array of strings

List of tags to filter the items. Used for categorization.

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, invalid input parameters.

410

Owned item not found in inventory.

500

Internal server error.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/inventoryV2-getById \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"version":2}'


xxxxxxxxxx
92
}
1
{
2
  "inventoryItem": {
3
    "appIds": [
4
      "string"
5
    ],
6
    "id": "string",
7
    "virtualItemId": "string",
8
    "offerId": "string",
9
    "tags": [
10
      "string"
11
    ],
12
    "quantity": 0,
13
    "isLocked": true,
14
    "status": "pending",
15
    "hidden": false,
16
    "tradable": true,
17
    "createdAt": 0,
18
    "updatedAt": 0,
19
    "itemUpgrades": [
20
      {
21
        "upgradeId": "string",
22
        "upgradeLevel": 0
23
      }
24
    ],
25
    "properties": [

200Virtual item inventory data retrieved successfully.

401Unauthenticated error 401 indicating the user is not authenticated.