Get current user's inventory

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

SecurityXsollaLoginUserJWT

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

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0
platform	string Default: "xsolla" Publishing platform the user plays on. Enum: "playstation_network" "xbox_live" "xsolla" "pc_standalone" "nintendo_shop" "google_play" "app_store_ios" "android_standalone" "ios_standalone" "android_other" "ios_other" "pc_other"

Responses

200

The user’s inventory was successfully retrieved.

Request samples

Response samples

application/json

{"items": [{"instance_id": null,
"sku": "instanciated_item",
"type": "virtual_good",
"name": "Rocket",
"quantity": null,
"description": "Big Rocket - short description",
"image_url": "https://picture.bigrocket.png",
"attributes": [ ],
"groups": [ ],
"remaining_uses": 1,
"virtual_item_type": "non_consumable"
},
{"instance_id": null,
"sku": "shotgun_raider",
"type": "virtual_good",
"name": "SHOTGUN FOR TRUE RAIDERS",
"quantity": 2,
"description": "description",
"image_url": "http://image.png",
"attributes": [ ],
"groups": [ ],
"remaining_uses": 1,
"virtual_item_type": "non_consumable"
},
{"instance_id": null,
"sku": "headphones_for_pro",
"type": "virtual_good",
"name": "HEADPHONES",
"quantity": 5,
"description": null,
"image_url": null,
"attributes": [{"external_id": "stack_size",
"name": "Stack size",
"values": [{"external_id": "stack_size_value_99c25352ab6e34a0e0755fc2a9daa7a76021dce2",
"value": 5
}
]
},
{"external_id": "licensed",
"name": "Licensed",
"values": [{"external_id": "licensed_value_d75d8034dd2f82cb3d2789f5ec1837a6c350b505",
"value": true
}
]
}
],
"groups": [ ],
"remaining_uses": 1,
"virtual_item_type": "non_consumable"
},
{"instance_id": null,
"sku": "platform_currency",
"type": "virtual_currency",
"name": "UNIQUE DIAMONDS",
"quantity": 100,
"description": null,
"image_url": null,
"attributes": [ ],
"groups": [ ],
"remaining_uses": 1
}
]
}