In-Game Purchases

Summary

This guide will help walk you through the needed steps to setup and configure the ability for an item to be purchasable from the client. You will be walked through the the following steps, to configure an item with a price that can be purchased via API calls.

• Create an Item to use as your In-Game Currency.
• Create an Item that can be purchased with the In-Game Currency.
• Create a Price Point to be able to apply price to Loot.
• Create a Price Break Point on the Price Point to define the exact Price.
• Create a Vendor that contains the purchasable Loot.
• Create a Loot that joins the purchasable Item and the Price Point.

Steps

Create In-Game Currency Item

This will be the item that will be used as the payment to purchase other items in game.

1. Under the Catalog section navigate to Items.
2. Click + NEW ITEM to start the creation of a new item.
3. Write a Name for this item.
   • This is a Dev Portal visble only field that helps navigating created items within the portal.
   • Note: For the rest of this document we will refer to this as InGameCurrencyItem.
4. Write a Description for this item.
   • This is a Dev Portal visble only field that helps navigating created items within the portal.
5. For Type field, select Unit.
6. Click SAVE.

After completing this, you should be able to find your new item in the item list of the Items section.

Create In-Game Item To Purchase

This will be an example item that can be purchased in the game.

1. Under the Catalog section navigate to Items.
2. Click + NEW ITEM to start the creation of a new item.
3. Write a Name for this item.
   • This is a Dev Portal visble only field that helps navigating created items within the portal.
   • Note: For the rest of this document we will refer to this as InGamePurchaseItem.
4. Write a Description for this item.
   • This is a Dev Portal visble only field that helps navigating created items within the portal.
5. For Type field, select Unit.
6. Click SAVE.

After completing this, you should be able to find your new item in the item list of the Items section.

Create Price Point

This acts like a price tag in a store that could be placed on an item. We use this to place the price tag on a given item.

1. Under the Catalog section navigate to Pricing Config.
2. Click + NEW PRICE POINT to start the creation of a new price point.
3. Write a Name for this price point.
   • This is a Dev Portal visble only field that helps navigating created price points within the portal.
   • Note: For the rest of this document we will refer to this as ExamplePricePoint.
4. Write a Description for this price point.
   • This is a Dev Portal visble only field that helps navigating created price points within the portal.
5. Click SAVE.

After completing this, you should be able to find your new price point in the price point list of the Pricing Config section.

Create Price Break Point on a Price Point

This is the actual price printed on the price tag, a price point can have multiple break points to represent a sale.

1. Under the Catalog section navigate to Pricing Config.
2. Click on the Price Point you want to add a Break Point to.
   • This would be ExamplePricePoint in this example.
3. Click + NEW BREAK POINT to start the creation.
4. For Type field, select Current.
5. For Item field, find your Curreny Item.
   • This would be InGameCurrencyItem in this example.
6. For Price field, specify how much currency you need to spend on the item.
   • If you set this to 250, it would require 250 InGameCurrencyItem to purchase something with this on it.
7. For Quantity field, specify the quantity at which this price takes effect.
   • Typically this is set to 1.
   • You can create multiple price breakpoints using this to allow for discounts for multiple quanties to be purchased at once.
8. Click SAVE.

After completing this, you should be able to see your new price break point on the price point.

Create Vendor

This allows for the organization of Loot, which is used by the API to complete purchases.

1. Under the Catalog section navigate to Vendors.
2. Click + NEW VENDORS to start the creation of a new vendor.
3. Write a Name for this vendor.
   • This is a Dev Portal visble only field that helps navigating created vendors within the portal.
   • Note: For the rest of this document we will refer to this as ExampleVendor.
4. Write a Description for this price point.
   • This is a Dev Portal visble only field that helps navigating created vendors within the portal.
5. For Type field, select Recipe.
6. Click SAVE.

After completing this, you should be able to find your new vendor in the vendor list of the Vendors section.

Create Loot in the Vendor

This is the Loot that is purchasable.

1. Under the Catalog section navigate to Vendors.
2. Click on the Vendor you want to add Loot to.
   • This would be ExampleVendor in this example.
3. Click + NEW LOOT to start the creation.
4. Write a Name for this vendor.
   • This is a Dev Portal visble only field that helps navigating created loot within the portal.
   • Note: For the rest of this document we will refer to this as ExampleLoot.
5. Write a Description for this price point.
   • This is a Dev Portal visble only field that helps navigating created loot within the portal.
6. For Item field, find your Purchase Item.
   • This would be InGamePurchaseItem in this example.
7. For Quantity field, set it to the amount of this item they user will obtain.
8. For Inv Selector Type field, select Own.
   • This makes it so when obtained this is a permanent inventory record.
9. For Inv Operation field, select Add.
   • This makes it so when obtained this will increate the inventory count.
10. For Active field, check the box.
    • Setting Loot to active makes it available to be purchased.
11. For Current Price Point field, find your Price Point.
    • This would be ExamplePricePoint in this example.
12. Click SAVE.

After completing this, you should be able to see your new loot on the vendor.