Catalog

Overview

Catalog services cover Store Management allow you to manage your store, put games, in-game items, or add-ons up for sale, and sort these items into categories. Catalog Management includes several features, such as:

  • Item localization lets you display different names and descriptions of your items for sale in different countries.
  • Item regional data allows items to have different currencies and prices for sale in different countries.
  • Item bundling allows you to sell items in groups for a lower price than if those items were purchased separately.
  • Store isolation allows for only one store to be published online at any time, but you can make as many draft stores as you like. If you want to make changes to your store, you can ensure those changes work as intended in your draft store before putting it online, to reduce the chance of errors occurring.
  • Store Cloning lets you create an exact copy of your store in its environment, for easy editing.
  • Store Import/Export lets you import a store from or export a store to a different environment as a JSON file. If your store is working well in your dev environment, you can export it as a JSON file and import it to your production environment without having to recreate it.
  • Image and Item Tags can be created and assigned to images or items to determine where those objects will appear. For example, you can create a banner tag and define where banner images are displayed, and every banner image will behave the same way on its own page. Item tags are used to select which games or items for sale are featured on the main page of your store. Up to six objects can be featured.
  • Purchase limitations enable you to limit how many times a player can purchase a particular item.

Tutorials

Create a Store

Create a Store using API

  1. Use the Create a Store: POST /admin/namespaces/{namespace}/stores endpoint.
  2. Input the Namespace where the store will be located.
  3. Fill out the Request Body:
    • Input the Title or the name of your store.
    • Input the store’s Description.
    • Input the Default Region of the store e.g. US.
    • Input the Default Language of the store, e.g. en-US.
    • Input the Supported Regions outside of the default, e.g. ID to make the store available in Indonesia. You can add more than one Supported Region and Supported Language.
    • Input the Supported Languages outside of the default language, e.g. ID for Indonesian.
  4. Upon successful request, the store will be created.

Create a Store In the Admin Portal

  1. In the Admin Portal, go to the Commerce section and click the Stores menu.

    catalog

  2. In the Stores page, click the Create button.

    catalog

  3. Input the required information into the form below.

    catalog

    • Input your store Title. The store title will be visible in the Launcher and Player Portal as your store name.

    • Select the Default Language.

    • Select the Default Region.

    • Select the Other Languages supported besides the default language.

    • Select the Other Regions supported besides the default region.

    • Input a Description for your store.

      note

      Other Languages and Regions are optional. You can add more than one Other Languages and Regions.

  4. Once the store is created you will be directed to the newly created store page. The next thing you need to do is add categories and items to your store.

    catalog

Create a Category

Creating a category is useful for you to organize the items in your catalog into groups.

Create a Category using API

  1. Use the Category Create Category: POST /admin/namespaces/{namespace}/categories endpoint.
  2. Input the Publisher Namespace.
  3. Input the Store ID.
  4. Fill out the Request Body:
    • Input the Category Path of the category e.g. /games
    • Input the Localization Display Name with the appropriate format e.g. {"en-US" : "Games"}. The “en-US” refers to the language and “Games” is the category name that you’ve chosen. The first letter of the category name should be uppercase.
  5. After a successful request, the category will be created.

Create a Category In the Admin Portal

  1. Go to the Store page and choose the store you want the category to be in.

    catalog

  2. In your Store, click the Create button, and the Create Category form will be displayed.

    catalog

  3. Input the fields with the appropriate format.

    catalog

    • You can add more paths to create sub-categories. For example, /items/game-items.
    • Input the category name based on other languages and regions that have been registered.
    • Here is an example of categories you can use:
      • /games for games in your store.
      • /coins for virtual currency.
      • /items for all in-game items. You can also separate in-game categories for every game in the store using /items/gameappId.
  4. When you’re done, the new category will be added to the list.

    catalog

  5. Note that the changes you made inside the store will not appear in the Player Portal until the store is published.

Create a KeyGroup

Create a KeyGroup using API

Creating a KeyGroup is useful if you need to add a Product Key that can be redeemed on the desired platform. Players can purchase the Product Key either in Player Portal or Launcher.

  1. Use the Create key group: POST ​/admin​/namespaces​/{namespace}​/keygroups endpoint.
  2. Input the Publisher Namespace.
  3. Fill out the Request Body. - Input the Name of the KeyGroup. - Input the Description of the KeyGroup. - Input the Tags with contextual information about the KeyGroup. - Input the Status of the KeyGroup as either Active or Inactive. After a successful request, the key group will be created.

Create a KeyGroup in the Admin Portal

  1. Go to Platform Configurations in the Admin Portal and click Product Keys.

    catalog

  2. On the Product Key page, click the Add Key Group. catalog

  3. Fill in the required fields.

    • Input the Key Group Name.
    • Input a Description of the KeyGroup.
    • Upload your Key file with the appropriate format.

    catalog

  4. When you’re done, the new KeyGroup will be added to the list.

    catalog

Create an Item

Create an Item in a Store using API

  1. Use the Item: Create an Item - POST /admin/namespaces/{namespace}/items endpoint.

  2. Input the publisher Namespace.

  3. Input the Store ID of the target store.

  4. Fill out the Request Body:

    • Choose the Item Type from the available options: App, Coins, In-Game Item, or Bundle.
    • Input the item’s Name.
    • Choose the Entitlement type, either Durable or Consumable.
    • Input the Use Count of the item. This is only used for Coins and determines how many coins there are in the item.
    • Set the Stackable value to either true or false. Usually Consumable items are stackable.
    • Input the App ID if you chose the App Item Type above. Otherwise leave this field empty.
    • Input the App Type if you chose the App Item Type. The possible options are Demo, DLC, Game, or Software. If you didn’t choose the App Item Type, you can leave this field empty.
    • Input the Target Currency Code if you selected Coins as the Item Type. Otherwise leave this field empty.
    • Input the Target Namespace field with your game’s namespace. This is required if you are selling a game item listed on the publisher’s namespace.
    • Input the Category Path of the item e.g. /game.
    • Input the Localization information such as localized titles or descriptions, if needed.
    • Input the SKU if needed. This is used to map the item from our system to an external system. So for example, if you use our Catalog but not our Entitlements service, you can use the SKU to map the items from the catalog to your game server.
    • Input the fields for Images below:
      • Input the purpose of the uploaded image in the As field.
      • Input the Caption of the image.
      • Input the Height of the image in pixels.
      • Input the Width of the image in pixels.
      • Input the Image URL e.g. http://img-url-required/.
      • Input the Small Image URL e.g. http://small-img-url-required/.
    • Input the Thumbnail URL image.
    • Input the Region Data with the region where the item will be located.
    • Input the Items ID if you selected Bundle as your item type. Otherwise leave this field empty.
    • Input the item Tags.

    These fields are optional:

    • Input the Max Count Per User to define the maximum number of times a player can use the item. To give an item unlimited use, set the value to -1.
    • Input the maximum number of times the item can be sold from the store in the Max Count field. To enable the item to be sold an unlimited number of times, set the value to -1.
    • Input the Clazz for customization use. This is an optional field that lets you group items into categories which affect how those items appear in your store. For example, you can put all weapon items into a group.
    • Input the Ext for customization use. This is also optional and allows you to define any additional properties the item has.

Create an Item in a Store In the Admin Portal

  1. In your store page, go to the Items tab.

    catalog

  2. Click the Create Items button and choose whether you wanted to create a new item or clone from another namespace. In this case, we will choose to Create a New Item.

    catalog

  3. Input the Item Name and choose the Item Type from the list.

    catalog

    Here’s how to add an item of each type:

    a. Add a Coin

    catalog

    • Select Coin as the Item Type.
    • Select the currency code for the coin from the Coin Currency Code dropdown list.

    b. Add a Game

    catalog

    • Select Game as the App Type.
    • Input the App ID with a unique combination of alphanumeric characters. The App ID is a unique identifier that will be used to identify your game when you upload it using BuildUtil. Note that you can not change the App ID after it has been defined.

    c. Add an In-Game Item

    Before creating In-Game Items, make sure you already have a game registered in your store.

    • Input the Required Game.

    • Select the desired game namespace for the Target Namespace.

    • Choose the Entitlement Type. If you want the item to be able to be used repeatedly, choose Durable. If your item is single-use, choose Consumable.

    • Follow these additional steps for Consumable items:

      • Input Use Count to define how many times the item can be used.

      • Set the Stack Entitlement value. Set to True if the item should be stackable. If not, set to False.

        catalog

    d. Add a Bundle

    catalog

    • Select the items you want to include in the bundle from the Item list.
    • Select the game the bundle belongs to from the Required Game list.

    e. Add a Code

    catalog

    • Select Code as the App Type.
    • Select the KeyGroup from the dropdown list.

    f. Add a Subscription Item

    • Select the Billing Cycle. You can choose to charge the user either Weekly, Monthly, Quarterly, or Yearly.

    • Input the desired Grace Period to give players extra time to pay, in case of payment processing issues. The default setting is 7 days.

    • If you want to offer a free trial, toggle the Free button and input the Length of the Free Trial in days.

      catalog

    • Input the Trial Price if you have a trial price or leave it empty if you don’t have one.

    • If you choose not to enable the free trial, you can select the trial cycle or leave it as is. In this case, you need to set the trial price. For example, if you have a one month billing cycle, users will pay a trial price for one months and they will be charged with normal price on the next billing cycle.

      catalog

    • If you want to offer a free trial, toggle the Free button and input the Length of the Free Trial in days.

      catalog

  4. Select the Category of the item you’re creating. The categories you created earlier will appear in the list. For example, if you’re adding a game then, choose /game. Choose /items if you’re adding in-game items. If you’re creating an item bundle you can choose /bundle.

  5. Input the item’s ID from PSN or Xbox into the SKU No if you want to map this item to a 3rd party platform. For PSN, input the Entitlement Label which is derived from the SKU. For Xbox, input the item’s StoreID.

  6. If your in-game item is available in a 3rd Party Store such as Playstation or Xbox, select 3rd Party Store Integration. This option is only used for Coins, In-Game Items, and Bundles.

  7. Set the Purchase Limit to define the purchase limit per account. To make this value unlimited, input -1.

  8. For Coins, In-Game Items, and Bundles, define the Purchase Limit / Account. To make this value unlimited, input -1.

  9. For Coins and consumable In-Game Items, input the Use Count to determine how many times the item can be used.

  10. Set the order sequence to define how the item displayed in the player portal in the Display Order field. This field is optional.

  11. Select the publisher namespace as the Currency Namespace.

  12. Select the Currency Code for your store from the list.

  13. Input the Price of the item. If you are making a free item, set the price to 0. When you set a price for real currency, the last two digits are decimals.

    catalog

  14. When you’re done, click Add and your item will be added to the list.

Add a Regional Price to an Item

By default, your item’s price is set in the default country for your store. To add different prices for different regions, follow the steps below:

  1. In the Admin Portal, go to your item details. In the Pricing panel, click Add New to add new pricing.

    catalog

  2. Input the following information into the Add Price window that appears:

    • Select the Country where you want to set the regional price. If you can’t find the desired region, you can edit the store to add the region to it.
    • Select the publisher namespace as the Currency Namespace.
    • Select the Currency Code from the list.
    • Input the Price of the item. If you are making a free item, set the price to 0. When you set a price for real currency, the last two digits are decimals.
    • If you want to set when the item will be available on the store, you can input the Available From field to make the item available from the desired date and time. Otherwise, the item will appear as soon as the store is published. You can also set when the item will be removed from the store on the Expiry Date field. If left empty, the item will never expire.
    • Set the Discount price if you want to give your item a discount. You can choose to add a discount by an amount or by a percentage.
    • You can also set the Discount Release Date and Discount Expire Date. Like the Available From and Expiry Date fields, these fields determine when your discount begins and ends.

    catalog

  3. When you’re finished, click the Add button and the price will be updated.

    catalog

Setting Up the Publishing Content

Publishing content consists of the information and media used to show and describe your items, such as the item descriptions, images, and information about system specifications and requirements.

  1. Go to the Publishing Content section. In the Localization section, click the View button to add a description of the item. You can input both a Short Description and Long Description. Each of the descriptions has their own function as you can see in the image below.

    catalog

  2. To add description in other languages, go back to the Localization section and click the Add button.

    catalog

  3. The description you added will appear on the product’s detail page in the Player Portal when you select the relevant language.

    catalog

Configure Images in the Admin Portal

  1. In the Publishing Content panel, select the Image tab.

    catalog

  2. Click the Upload button, then select the image you want to upload from your local directory. After the image is selected, you can use the image as you desire. For example, if you want to set the image as a product banner, you can fill the Set As field with product-banner.

    catalog

  3. See the table below for information about image setup in the Admin Portal. You can also configure images in Contentful.

    UI/UX Module

    Location

    Tags

    Set Image as

    Tags

    Behavior

    Set Image as

    Behavior

    Recommended Image Size

    Hero Banner

    [Player Portal] Home Page- Slider Carousel

    banner

    Any product with Banner tags will be shown as the Product Banner and Hero Banner

    hero-banner

    Note: The image for the hero banner can also be set from Contentful

    16:6 ratio with recommended width: 1920px

    Featured Item Thumbnail

    [Player Portal] Home Page- Product under the carousel

    featured

    Any product with the Featured tag will be shown on Featured Games

    product-cover

    The image will be used as the product thumbnail

    4:3 ratio with recommended width: 800px

    Game Icon

    Launcher - Sidebar

    n/a

    n/a

    game-icon

    The image will be used as the icon for the game in Launcher

    1:1 ratio with recommended resolution: 256 x 256px

    Game Logo

    Launcher- Game Logo

    n/a

    n/a

    game-logo

    The image will be used as the logo for the game in Launcher

    Recommended width 180px

    Game Download Cover

    Launcher - Game Download Pop Up Box

    n/a

    n/a

    game-download-cover

    The image will appear when the player is downloading the game in Launcher

    300 x 100px

    Other

       

    unset

    This is an error that occurs when the image is unable to be saved. If this occurs, try to upload your image again.

     
  4. You can add as many images as you need. When you’re done adding an image it will appear in the Publishing Content window, as seen below:

    catalog

    Here is an example of a hero banner in the Player Portal:

    catalog

Add Product Information

  1. In the Publishing Content panel, select the Product Information tab.

  2. Fill out the Product Information fields:

    • Input the Primary Genre of your game.
    • Input any additional genres in the Genre field, if desired. You can input more than one genre.
    • Choose the Platforms supported by your game.
    • Input the Release Date of your game.
    • Input the Developer of your game.
    • Input the Publisher of your game.
    • Input the Website URL.
    • Input the Forum URL.

    catalog

    Here’s an example of product information listed in the Player Portal.

    catalog

Add System Requirements

  1. In the Publishing Content panel, select the System Requirement tab.

    catalog

  2. Fill out the Minimum Requirement fields. catalog

    • Input the minimum supported OS Version.
    • Input the minimum supported Processor.
    • Input the minimum supported amount of RAM.
    • Input the minimum support Graphics card.
    • Input the supported DirectX Version.
    • Input the minimum required amount of Disk Space.
    • Input the minimum supported Sound Card.
  3. Fill out the Recommended Requirement fields.

    catalog

    • Input the recommended OS Version.

    • Input the recommended Processor.

    • Input the recommended amount of RAM.

    • Input the recommended Graphics card.

    • Input the recommended DirectX Version.

    • Input the recommended amount of Disk Space.

    • Input the recommended Sound Card.

      catalog

  4. Here is an example of system requirements in the Player Portal.

    catalog

Manage Subscription Contents

Add Subscription Content

  1. In the Admin Portal, go to your newly created Subscription Item and switch to the Subscription Contents tab. Then, click the Add New button to add an Item to the Subscription.

    catalog

  2. A modal appears. Here you can select the Item you want to add.

    catalog

    When you’re done, click Add.

  3. Your new item will be added to the subscription content list.

    catalog

Publish a Store

  1. Select the Store you want to publish. Click the Action field then choose Publish.

    catalog

  2. Confirm that you are ready to publish your store by typing “PUBLISH” in the field. Your store is now published.

Clone a Store

  1. Select the Store you want to clone. In the Action column, click Clone and a form will appear.

    catalog

  2. Select the Target Store from the list, then click Clone. The target store will receive the cloned data from the source store.

    catalog

    Here you can see the Target Store contains the same items and categories as the Source Store.

    catalog

    catalog

What’s Next?

  • Read about Orders to see how players can use your store once you’ve set it up.
  • If you’re interested in running a promotional campaign, check out our Campaigns page.