Title-Wide Data Management - Get Store Items

Retrieves the set of items defined for the specified store, including all prices defined

POST https://titleId.playfabapi.com/Admin/GetStoreItems

Request Header

Name Required Type Description
SecretKey True
  • string

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

Request Body

Name Required Type Description
CatalogVersion
  • string

Catalog version to store items from. Use default catalog version if null

StoreId True
  • string

Unqiue identifier for the store which is being requested.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SecretKey

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

GetStoreItemsRequest

A store contains an array of references to items defined in the catalog, along with the prices for the item, in both real world and virtual currencies. These prices act as an override to any prices defined in the catalog. In this way, the base definitions of the items may be defined in the catalog, with all associated properties, while the pricing can be set for each store, as needed. This allows for subsets of goods to be defined for different purposes (in order to simplify showing some, but not all catalog items to users, based upon different characteristics), along with unique prices. Note that all prices defined in the catalog and store definitions for the item are considered valid, and that a compromised client can be made to send a request for an item based upon any of these definitions. If no price is specified in the store for an item, the price set in the catalog should be displayed to the user.

GetStoreItemsResult
SourceType
StoreItem

A store entry that list a catalog item at a particular price

StoreMarketingModel

Marketing data about a specific store

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

GetStoreItemsRequest

A store contains an array of references to items defined in the catalog, along with the prices for the item, in both real world and virtual currencies. These prices act as an override to any prices defined in the catalog. In this way, the base definitions of the items may be defined in the catalog, with all associated properties, while the pricing can be set for each store, as needed. This allows for subsets of goods to be defined for different purposes (in order to simplify showing some, but not all catalog items to users, based upon different characteristics), along with unique prices. Note that all prices defined in the catalog and store definitions for the item are considered valid, and that a compromised client can be made to send a request for an item based upon any of these definitions. If no price is specified in the store for an item, the price set in the catalog should be displayed to the user.

Name Type Description
CatalogVersion
  • string

Catalog version to store items from. Use default catalog version if null

StoreId
  • string

Unqiue identifier for the store which is being requested.

GetStoreItemsResult

Name Type Description
CatalogVersion
  • string

The base catalog that this store is a part of.

MarketingData

Additional data about the store.

Source

How the store was last updated (Admin or a third party).

Store

Array of items which can be purchased from this store.

StoreId
  • string

The ID of this store.

SourceType

Name Type Description
API
  • string
Admin
  • string
BackEnd
  • string
Custom
  • string
GameClient
  • string
GameServer
  • string
Partner
  • string

StoreItem

A store entry that list a catalog item at a particular price

Name Type Description
CustomData
  • object

Store specific custom data. The data only exists as part of this store; it is not transferred to item instances

DisplayPosition
  • number

Intended display position for this item. Note that 0 is the first position

ItemId
  • string

Unique identifier of the item as it exists in the catalog - note that this must exactly match the ItemId from the catalog

RealCurrencyPrices
  • object

Override prices for this item for specific currencies

VirtualCurrencyPrices
  • object

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

StoreMarketingModel

Marketing data about a specific store

Name Type Description
Description
  • string

Tagline for a store.

DisplayName
  • string

Display name of a store as it will appear to users.

Metadata
  • object

Custom data about a store.