Documentation

PlayFab.Client.Models.ItemInstance

Request Properties
Annotation String

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

BundleContents List<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 Dict<String, String>

A set of custom key-value pairs on the inventory item.

DisplayName String

CatalogItem.DisplayName at the time this item was purchased.

Expiration DateTime

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 DateTime

Timestamp for when this instance was purchased.

RemainingUses int32

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

UnitCurrency String

Currency type for the cost of the catalog item.

UnitPrice (required) uint32

Cost of the catalog item in the given currency.

UsesIncrementedBy int32

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