Title-Wide Data Management - Get Catalog Items

GetCatalogItemsResult

If CatalogVersion is not specified, only inventory items associated with the most recent version of the catalog will be returned.

ApiErrorWrapper

This is the outer wrapper for all responses with errors

integer

Numerical HTTP code

string

Playfab error code

integer

Numerical PlayFab error code

object

Detailed description of individual issues with the request object

string

Description for the PlayFab errorCode

string

String HTTP code

CatalogItemBundleInfo

defines the bundle properties for the item - bundles are items which contain other items, including random drop tables and virtual currencies

boolean

if true, then an item instance of this type can be used to grant a character to a user.

string

catalog version for this item

CatalogItemConsumableInfo

defines the consumable properties (number of uses, timeout) for the item

CatalogItemContainerInfo

defines the container properties for the item - what items it contains, including random drop tables and virtual currencies, and what item (if any) is required to open it via the UnlockContainerItem API

string

game specific custom data

string

text description of item, to show in-game

string

text name for the item, to show in-game

number

If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited edition item, this value determines the total number of instances to allocate for the title. Once this limit has been reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less than zero, it will be ignored.

boolean

BETA: If true, then only a fixed number can ever be granted.

boolean

if true, then only one item instance of this type will exist and its remaininguses will be incremented instead. RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded

boolean

if true, then an item instance of this type can be traded between players using the trading APIs

string

class to which the item belongs

string

unique identifier for this item

string

URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP URL.

object

override prices for this item for specific currencies

string[]

list of item tags

object

price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies)

string[]

unique ItemId values for all items which will be added to the player inventory when the bundle is added

string[]

unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and add the relevant items to the player inventory when the bundle is added)

object

virtual currency types and balances which will be added to the player inventory when the bundle is added

number

number of times this object can be used, after which it will be removed from the player inventory

number

duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on this item's details have completed)

string

all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values added together, and share the result - when that period has elapsed, all the items in the group will be removed

string[]

unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked

string

ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will open the container, adding the contents to the player inventory and currency balances)

string[]

unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables will be resolved and add the relevant items to the player inventory)

object

virtual currency types and balances which will be added to the player inventory when the container is unlocked

string

Which catalog is being requested. If null, uses the default catalog.

CatalogItem[]

Array of items which can be purchased.