Free items

Free items are the type of items that the user can get without spending virtual or real currency. These include:

• Virtual items
• Bundles
• Game keys
• Virtual currency packages

Free items are only available to authorized users.
Unauthorized users can only view the catalog of free items.

Examples of usage:

• You can give away free items on important dates for your project (for example, on the day the project was founded) to reward users for their loyalty.
• You can give away free starter packs for the game in the store to attract new users to the game.

Who can use it

• For partners who have already have Web Shop and want to set up a new type of product — free items.
• For partners who want to increase the loyalty of current users or attract new players.

Integration flow

Create free items in the following ways:

• via Publisher Account
• via API calls

Create via Publisher Account

To create a free item (based on the example of virtual items):

1. Open your project in Publisher Account.
2. Click Store in the side menu.
3. In the Virtual Items pane, click Configure.
4. Click the + icon and choose Create group from the drop-down list.
5. Specify:
   • External ID;
   • Group name.
6. Click Create group and go to the group.
7. Click Create item.
8. Specify:
   • Image
   • SKU
   • One or several groups the item should belong to
   • Name
   • Description
   • Item property: consumable, nonconsumable, or time-limited item

9. In the Price settings block, choose Free item.
10. If you want to limit the availability of items to specific users, switch the Limit number of times one user can buy this item toggle to On and specify the number.
11. If you want to show an item in the store, set the Show item in store toggle to On.
12. Click Create item.

Create via API calls

1. To create free items, use API calls from the Admin subsection:
   • For virtual items — Create virtual item
   • For currency package — Create virtual currency package
   • For bundles — Create bundle
   When creating or editing an item, pass is_free = true in the request body.
2. Get a user’s order status.
3. If you want to limit the availability of items to specific users, call any API method for creating or editing an item and specify the value of the limits.per_user parameter.

Set up in Web Shop

To show free items in Web Shop:

1. Open your project at Publisher Account and go to Site Builder.
2. In the Site section, choose your site and click Configure.
3. In the Store block, go to the Store section.
4. In the Select purchase type field, select free items that you added previously.

Last updated: October 3, 2024