Player Item Management - Get Character Inventory

  • Reference
Service:
Server
API Version:
241025

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Retrieves the specified character's current inventory of virtual goods

POST https://titleId.playfabapi.com/Server/GetCharacterInventory

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
CharacterId True

string

Unique PlayFab assigned ID for a specific character owned by a user
PlayFabId True

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.
CatalogVersion

string

Used to limit results to only those from a specific catalog version.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

GetCharacterInventoryResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
GetCharacterInventoryRequest

All items currently in the character inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. Also returns their virtual currency balances.
GetCharacterInventoryResult
ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.
VirtualCurrencyRechargeTime

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

GetCharacterInventoryRequest

All items currently in the character inventory will be returned, irrespective of how they were acquired (via purchasing, grants, coupons, etc.). Items that are expired, fully consumed, or are no longer valid are not considered to be in the user's current inventory, and so will not be not included. Also returns their virtual currency balances.

Name Type Description
CatalogVersion

string

Used to limit results to only those from a specific catalog version.
CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PlayFabId

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

GetCharacterInventoryResult

Name Type Description
CharacterId

string

Unique identifier of the character for this inventory.
Inventory

ItemInstance[]

Array of inventory items belonging to the character.
PlayFabId

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.
VirtualCurrency

object

Array of virtual currency balance(s) belonging to the character.
VirtualCurrencyRechargeTimes

VirtualCurrencyRechargeTime

Array of remaining times and timestamps for virtual currencies.

ItemInstance

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

Name Type Description
Annotation

string

Game specific comment associated with this instance when it was added to the user inventory.
BundleContents

string[]

Array of unique items that were awarded when this catalog item was purchased.
BundleParent

string

Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.
CatalogVersion

string

Catalog version for the inventory item, when this instance was created.
CustomData

object

A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog item's custom data.
DisplayName

string

CatalogItem.DisplayName at the time this item was purchased.
Expiration

string

Timestamp for when this instance will expire.
ItemClass

string

Class name for the inventory item, as defined in the catalog.
ItemId

string

Unique identifier for the inventory item, as defined in the catalog.
ItemInstanceId

string

Unique item identifier for this specific instance of the item.
PurchaseDate

string

Timestamp for when this instance was purchased.
RemainingUses

number

Total number of remaining uses, if this is a consumable item.
UnitCurrency

string

Currency type for the cost of the catalog item. Not available when granting items.
UnitPrice

number

Cost of the catalog item in the given currency. Not available when granting items.
UsesIncrementedBy

number

The number of uses that were added or removed to this item in this call.

VirtualCurrencyRechargeTime

Name Type Description
RechargeMax

number

Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen below this value.
RechargeTime

string

Server timestamp in UTC indicating the next time the virtual currency will be incremented.
SecondsToRecharge

number

Time remaining (in seconds) before the next recharge increment of the virtual currency.

Error Codes

Name Code
CharacterNotFound 1135