How to group and sort items in catalog
You can add items in groups to create a multilevel catalog. The group can include identical and different types of items:
- Virtual items
- Virtual currency
- Packages of virtual currency
- Bundles
- Game keys
Note
You cannot sort items in an item catalog in Publisher Account.
Main features:
- Add the same item in several groups.
- Add smaller groups to bigger ones to create a multilevel catalog.
- Change the order of the groups.
- Change the order of items.
Set up groups in one of the following ways:
- via Publisher Account (only for virtual items)
- via API calls
Set up via Publisher Account
Create group
To create a group for virtual items:
- Open your project in Publisher Account.
- Click Store in the side menu.
- In the Virtual items pane, click:
- Connect – if you don’t have virtual items.
- Configure – if you previously connected virtual items.
- Click + and select Create group in the drop-down list.
- Specify the following parameters:
- External ID — unique group code.
- Group name.
- Set the Show group in Store toggle to On.
- Click Create group.
Edit group
To edit a group:
- Open your project in Publisher Account.
- Click Store in the side menu.
- In the Virtual items pane, click ••• and in the drop-down list, select Edit group.
- Make the necessary changes.
- Click Save changes.
Note
If you have hidden the group in the store (set the Show group in Store toggle to Off), such a group:
- Is not returned in response when calling the Get items groups list API.
- Is not displayed in the properties of items included in this group when calling client methods for obtaining a list of items.
Add item to group
To add a virtual item to a required group, specify the group when creating a new item or editing the existing item.Note
Items without a specific group are automatically added to the Ungrouped group, located at the end of the list of groups. There are the following restrictions for items in this group:
- They cannot be sorted.
- They are not available for calling via the Get items list by specified group API.
Sort items
To sort items (on the example of virtual items):- Open your project in Publisher Account.
- Click Store in the side menu.
- In the Virtual items pane, click:
- Connect – if you don’t have virtual items.
- Configure – if you previously connected virtual items.
- Go to the group.
- Hover over the virtual item number. The ☰ icon will be displayed. Drag the virtual item to the new position.
Set up via API calls
Add item to group
To add an item to the existing group via API calls, pass the array containing the external_id
parameter of the groups that the item should belong to in the group
field:
- Game keys — Use the Create game, Update game by SKU, and Update game by ID API calls.
- Virtual items — Use the Create virtual item and Update virtual item API calls.
- Virtual currency — Use the Create virtual currency and Update virtual currency API calls.
- Packages of virtual currency — Use the Create virtual currency package and Update virtual currency package API calls.
- Bundles — Use the Create bundle and Update bundle API calls.
Example of the request:
Copy
- http
{
"sku": "sword",
"name": {
"en": "Sword",
},
"is_enabled": true,
"is_free": false,
"order": 1,
"description": {
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
},
"prices": [
{
"amount": 100,
"currency": "USD",
"Is_enabled": true,
"is_default": true
}
],
"vc_prices": [ ],
"is_show_in_store": true,
"groups": [
"chests", "bonus"
],
}
Get list of groups
Notice
You can get the list of all groups and the list of items of the specified group via the API calls only for virtual items. Use filtering for working with other groups of items.
external_id
parameter to the Get items list by specified group API call.Filter items
To filter items of the required group:- Get the list of items via the following API calls:
- Game keys — Get games list API call.
- Virtual currency — Get virtual currency list API call.
- Packages of virtual currency —
Get virtual currency package list API call. - Bundles —
Get list of bundles API call.
- Using the filtering, find the items with the
external_id
parameter of the required group specified in thegroups
parameter.
Was this article helpful?
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.Found a typo or other text error? Select the text and press Ctrl+Enter.