Title-Wide Data Management - Update Store Items
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Updates an existing virtual item store with new or modified items
POST https://titleId.playfabapi.com/Admin/UpdateStoreItemsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| StoreId | True |
string |
Unique identifier for the store which is to be updated |
| CatalogVersion |
string |
Catalog version of the store to update. If null, uses the default catalog. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| MarketingData |
Additional data about the store |
||
| Store |
Array of store items - references to catalog items, with specific pricing - to be added |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Store |
A store entry that list a catalog item at a particular price |
|
Store |
Marketing data about a specific store |
|
Update |
When used for SetStoreItems, this operation is not additive. Using it will cause the indicated virtual store to be created from scratch. If there is an existing store with the same storeId, it will be deleted and replaced with only the items specified in this call. When used for UpdateStoreItems, 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. In both cases, 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. |
|
Update |
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 |
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. |
UpdateStoreItemsRequest
When used for SetStoreItems, this operation is not additive. Using it will cause the indicated virtual store to be created from scratch. If there is an existing store with the same storeId, it will be deleted and replaced with only the items specified in this call. When used for UpdateStoreItems, 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. In both cases, 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 of the store to update. If null, uses the default catalog. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| MarketingData |
Additional data about the store |
|
| Store |
Array of store items - references to catalog items, with specific pricing - to be added |
|
| StoreId |
string |
Unique identifier for the store which is to be updated |
UpdateStoreItemsResult
Error Codes
| Name | Code |
|---|---|
| CatalogNotConfigured | 1218 |
| InvalidItemId | 1093 |
| InvalidJSONContent | 1200 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for