Documentation

GetStoreItems

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

Request Details

A store contains an array of references to items defined in one or more catalog versions of the game, 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.

GetStoreItemsServerRequest
Request Properties
CatalogVersion String

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

PlayFabId String

Optional identifier for the player to use in requesting the store information - if used, segment overrides will be applied

StoreId (required) String

Unqiue identifier for the store which is being requested

POST https://{{TitleID}}.playfabapi.com/Server/GetStoreItems
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StoreId": "BonusStore",
  "PlayFabId": "20394883"
}
        

Response Details

GetStoreItemsResult
Result Properties
CatalogVersion String

The base catalog that this store is a part of.

MarketingData StoreMarketingModel

Additional data about the store.

Source SourceType

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

Store List<StoreItem>

Array of items which can be purchased from this store.

StoreId String

The ID of this store.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Store": [
      {
        "ItemId": "shield_level_5",
        "VirtualCurrencyPrices": {
          "RM": 180,
          "GV": 20
        },
        "RealCurrencyPrices": {
          "GBP": 100
        }
      },
      {
        "ItemId": "energy_boost_1",
        "VirtualCurrencyPrices": {
          "RM": 250,
          "GV": 30
        }
      },
      {
        "ItemId": "starterpack_1",
        "VirtualCurrencyPrices": {
          "RM": 399
        }
      }
    ],
    "Source": "Admin",
    "CatalogVersion": "1",
    "StoreId": "BonusStore",
    "MarketingData": {
      "DisplayName": "Amazing Bonus Store",
      "Description": "Elite tier bonuses available here"
    }
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code