Get by Ids

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

Retrieve virtual items inventory data by multiple owned item IDs

Responses

Response body

object

inventoryItems

array of objects

inventoryItems

object

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

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

400

Bad request, invalid input parameters.

410

One or more owned items 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-getByIds \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"version":2}'


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

200Virtual items inventory data retrieved successfully.

401Unauthenticated error 401 indicating the user is not authenticated.