Create and manage inventory configurations in the Admin Portal

Last updated on October 24, 2024

note

The Inventory service is available upon request. To integrate this service into your environment, please open a request through the AccelByte Customer Support Portal.

Introduction

In the AccelByte Gaming Services (AGS) Inventory service, an inventory configuration contains a set of information and rules to determine the type of inventory that your players can use in-game.

This article walks you through how to create, update, and delete inventory configurations in the AGS Admin Portal.

Prerequisites

• Access to the AGS Admin Portal.
• A publisher or a game namespace.
• You have reviewed the key concepts of the Inventory service and the Inventory service API documentation.

View inventory configurations

1. On the AGS Admin Portal sidebar, go to Progression & Inventory > Inventory > Configurations. The Inventory Configurations page appears.
2. From the inventory configurations list, find the configuration you want to view. You can search for inventories using their code. Click on the configuration's code to open to its details page.

Create inventory configuration

1. On the Inventory Configurations page, click on the Create Configuration button. The Create Configuration form appears.

2. On the form, fill in the required information:

   • Inventory Code: type in an ID for the inventory.

   • Inventory Name: type in a name for the inventory.

   • Initial Slots: set the maximum number of slots a player can have to store their items, or tick the Set as Unlimited checkbox to set it to unlimited. Each slot can store a single non-stackable item or multiple identical items stacked as one.

   • Maximum Slots Upgrade: set the maximum number of slots upgrade a player can own in the inventory, or tick the Set as Unlimited checkbox to set it to unlimited.

   • Maximum Ownership: set the maximum number of inventory that a player can own per inventory.

   • Description: provide a brief description or additional information describing the inventory configuration.

     note

     When you set Initial Slots with Unlimited configuration, it will automatically set the Maximum Slots Upgrade into Unlimited.

3. Click Create. The new inventory is added to the Inventory Configurations list.

Update inventory configuration

If the status of an inventory configuration is INIT, you can update or edit all of its details. If its status is TIED, you can only update its Inventory Name and Description.

To update an inventory configuration, follow these steps:

1. On the AGS Admin Portal sidebar, go to Progression & Inventory > Inventory > Configurations. The Inventory Configurations page appears.
2. From the inventory configurations list, find the configuration you want to update. You can search for inventories using their code. Click on the configuration's code to open to its details page.
3. To edit the value of any field, click on its edit (pencil) icon. Then, edit the value and click on the check button to save your changes in the field.

Delete inventory configuration

You can delete an inventory configuration when its status is INIT. Inventory configurations with the TIED status cannot be deleted.

To delete an inventory configuration, follow these steps:

1. On the AGS Admin Portal sidebar, go to Progression & Inventory > Inventory > Configurations. The Inventory Configurations page appears.
2. From the inventory configurations list, find the configuration you want to delete. You can search for inventories using their code. Click on the configuration's code to open to its details page.
3. On the details page of the configuration, click on the Delete Configuration button and click on OK to delete the inventory. The inventory is immediately deleted from the Inventory Configurations page.