Documentation

GetCatalogItems

Retrieves the specified version of the title's catalog of virtual goods, including all defined properties

Request Details

GetCatalogItemsRequest
Request Properties
CatalogVersion String

Which catalog is being requested. If null, uses the default catalog.

POST https://{{TitleID}}.playfabapi.com/Client/GetCatalogItems
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "CatalogVersion": "1"
}
        

Response Details

If CatalogVersion is not specified, only inventory items associated with the most recent version of the catalog will be returned.

GetCatalogItemsResult
Result Properties
Catalog List<CatalogItem>

Array of items which can be purchased.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Catalog": [
      {
        "ItemId": "shield_level_5",
        "ItemClass": "shields",
        "CatalogVersion": "5",
        "DisplayName": "Level 5 Shield",
        "Description": "Strong defense against projectile attacks",
        "VirtualCurrencyPrices": {
          "RM": 199,
          "GV": 25
        },
        "RealCurrencyPrices": {
          "GBP": 149,
          "EUR": 169
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "energy_boost_1",
        "ItemClass": "boosts",
        "CatalogVersion": "5",
        "DisplayName": "Energy Drink Six-Pack",
        "Description": "Get a quick burst of energy whenever you need it",
        "VirtualCurrencyPrices": {
          "RM": 199,
          "GV": 25
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "required_item_for_grant_a_1",
        "ItemClass": "sets",
        "CatalogVersion": "5",
        "DisplayName": "Grant Set Item 1",
        "Description": "Item 1 from the set of items needed to get Granted Item A for free",
        "VirtualCurrencyPrices": {
          "RM": 249,
          "GV": 1500
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "required_item_for_grant_a_2",
        "ItemClass": "sets",
        "CatalogVersion": "5",
        "DisplayName": "Grant Set Item 2",
        "Description": "Item 2 from the set of items needed to get Granted Item A for free",
        "VirtualCurrencyPrices": {
          "RM": 249,
          "GV": 1500
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "required_item_for_grant_a_3",
        "ItemClass": "sets",
        "CatalogVersion": "5",
        "DisplayName": "Grant Set Item 3",
        "Description": "Item 3 from the set of items needed to get Granted Item A for free",
        "VirtualCurrencyPrices": {
          "RM": 249,
          "GV": 1500
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "required_item_for_grant_a_4",
        "ItemClass": "sets",
        "CatalogVersion": "5",
        "DisplayName": "Grant Set Item 4",
        "Description": "Item 4 from the set of items needed to get Granted Item A for free",
        "VirtualCurrencyPrices": {
          "RM": 249,
          "GV": 1500
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "granted_item_a",
        "ItemClass": "sets",
        "CatalogVersion": "5",
        "DisplayName": "Granted Item A",
        "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "consumable_item_1",
        "ItemClass": "Consumables",
        "CatalogVersion": "5",
        "DisplayName": "Consumable Item 1",
        "Description": "Item demonstrating usage-based consumables",
        "VirtualCurrencyPrices": {
          "GV": 500
        },
        "Consumable": {
          "UsageCount": 3
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "consumable_item_2",
        "ItemClass": "Consumables",
        "CatalogVersion": "5",
        "DisplayName": "Consumable Item 2",
        "Description": "Item demonstrating time-based consumables",
        "VirtualCurrencyPrices": {
          "GV": 750
        },
        "Consumable": {
          "UsagePeriod": 3600,
          "UsagePeriodGroup": "usage_group_1"
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "sub_bundle_item_1",
        "ItemClass": "Bundles",
        "CatalogVersion": "5",
        "DisplayName": "Bundled Item 1",
        "Description": "Item which is added to the user inventory as part of a bundle",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "sub_bundle_item_2",
        "ItemClass": "Bundles",
        "CatalogVersion": "5",
        "DisplayName": "Bundled Item 2",
        "Description": "Item which is added to the user inventory as part of a bundle",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "item_bundle_1",
        "ItemClass": "Bundles",
        "CatalogVersion": "5",
        "DisplayName": "Item bundle 1",
        "Description": "Item which, when added to the user inventory, also adds other bundled items",
        "VirtualCurrencyPrices": {
          "RM": 599
        },
        "Bundle": {
          "BundledItems": [
            "sub_bundle_item_1",
            "sub_bundle_item_2"
          ],
          "BundledResultTables": [
            "random_result_1"
          ],
          "BundledVirtualCurrencies": {
            "GV": 1000
          }
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "key_item_1",
        "ItemClass": "Containers",
        "CatalogVersion": "5",
        "DisplayName": "Key Item 1",
        "Description": "Key used to unlock Container 1",
        "VirtualCurrencyPrices": {
          "RM": 199
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "sub_container_item_1",
        "ItemClass": "Containers",
        "CatalogVersion": "5",
        "DisplayName": "Container Item 1",
        "Description": "Item which is added to the user inventory as part of opening a container",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "sub_container_item_2",
        "ItemClass": "Containers",
        "CatalogVersion": "5",
        "DisplayName": "Container Item 2",
        "Description": "Item which is added to the user inventory as part of opening a container",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "item_container_1",
        "ItemClass": "Containers",
        "CatalogVersion": "5",
        "DisplayName": "Item Container 1",
        "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
        "VirtualCurrencyPrices": {
          "RM": 499
        },
        "Consumable": {
          "UsageCount": 1
        },
        "Container": {
          "KeyItemId": "key_item_1",
          "ItemContents": [
            "sub_container_item_1",
            "sub_container_item_2"
          ],
          "ResultTableContents": [
            "random_result_1"
          ],
          "VirtualCurrencyContents": {
            "GV": 1000
          }
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "item_container_2",
        "ItemClass": "Containers",
        "CatalogVersion": "5",
        "DisplayName": "Item Container 2",
        "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
        "VirtualCurrencyPrices": {
          "RM": 99
        },
        "Consumable": {
          "UsageCount": 1
        },
        "Container": {
          "VirtualCurrencyContents": {
            "GV": 1000
          }
        },
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      },
      {
        "ItemId": "starterpack_1",
        "ItemClass": "starterpacks",
        "CatalogVersion": "5",
        "DisplayName": "Super Starter Pack",
        "Description": "Everything you need to get started fast track at the right price",
        "CanBecomeCharacter": false,
        "IsStackable": false,
        "IsTradable": false,
        "IsLimitedEdition": false,
        "InitialLimitedEditionCount": 0
      }
    ]
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code