Documentation

UpdateStoreItems

Updates an existing virtual item store with new or modified items

Request Details

This operation is additive. Items with ItemId values not currently in the store will be added, while those with ItemId values matching items currently in the catalog will overwrite those items with the given values. 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.

UpdateStoreItemsRequest
Request Properties
CatalogVersion String

Catalog version of the store to update. If null, uses the default catalog.

MarketingData StoreMarketingModel

Additional data about the store

Store List<StoreItem>

Array of store items - references to catalog items, with specific pricing - to be added

StoreId (required) String

Unique identifier for the store which is to be updated

POST https://{{TitleID}}.playfabapi.com/Admin/UpdateStoreItems
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StoreId": "BonusStore",
  "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
      }
    }
  ]
}
        

Response Details

UpdateStoreItemsResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
CatalogNotConfigured 1218
InvalidJSONContent 1200