Set 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. Sets all the items in one virtual store

Error codes

This operation may return the following PlayFab errors:

Error	Code
CatalogNotConfigured	1218
InvalidItemId	1093
InvalidJSONContent	1200
ProductDisabledForTitle	1609

POST

Admin

SetStoreItems

Set Store Items

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SetStoreItems \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "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
      }
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SetStoreItems"

payload = {
    "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 }
        }
    ]
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}}
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/SetStoreItems', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SetStoreItems",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SetStoreItems"

	payload := strings.NewReader("{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SetStoreItems")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SetStoreItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-SecretKey

string

header

required

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

Body

application/json

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.

StoreId

string

required

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

object

Additional data about the store

Show child attributes

Store

object[]

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

Show child attributes

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Last modified on October 1, 2026

⌘I

Set Store Items

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SetStoreItems \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "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
      }
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SetStoreItems"

payload = {
    "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 }
        }
    ]
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}}
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/SetStoreItems', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SetStoreItems",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SetStoreItems"

	payload := strings.NewReader("{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SetStoreItems")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SetStoreItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"StoreId\": \"BonusStore\",\n  \"Store\": [\n    {\n      \"ItemId\": \"shield_level_5\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 180,\n        \"GV\": 20\n      },\n      \"RealCurrencyPrices\": {\n        \"GBP\": 100\n      }\n    },\n    {\n      \"ItemId\": \"energy_boost_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 250,\n        \"GV\": 30\n      }\n    },\n    {\n      \"ItemId\": \"starterpack_1\",\n      \"VirtualCurrencyPrices\": {\n        \"RM\": 399\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Set Store Items

Error codes

Authorizations

Body

Response