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
Within the group, you can arrange items in a specific order to increase sales and show popular items to users. When requesting items by group, you get the items in the order they are sorted in the Publisher Account.

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:

Set up via Publisher Account

Create group

To create a group for virtual items:

  1. Open your project in Publisher Account.
  2. Click Store in the side menu.
  3. In the Virtual items pane, click:
    • Connect – if you don’t have virtual items.
    • Configure – if you previously connected virtual items.
  4. Click + and select Create group in the drop-down list.

  1. Specify the following parameters:
    • External ID — unique group code.
    • Group name.
  2. Set the Show group in Store toggle to On.
  3. Click Create group.

Edit group

To edit a group:

  1. Open your project in Publisher Account.
  2. Click Store in the side menu.
  3. In the Virtual items pane, click ••• and in the drop-down list, select Edit group.

  1. Make the necessary changes.
  1. 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:

Sort items

To sort items (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:
    • Connect – if you don’t have virtual items.
    • Configure – if you previously connected virtual items.
  4. Go to the group.
  5. 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:

Example of the request:

Copy
Full screen
Small screen

{
   "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.
To get the list of all groups, use the Get items group list API call. To get the list of items of the specified group, pass the external_id parameter to the Get items list by specified group API call.

Filter items

To filter items of the required group:
  1. Get the list of items via the following API calls:
  2. Using the filtering, find the items with the external_id parameter of the required group specified in the groups parameter.
Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Last updated: October 3, 2024

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!