Access
Connect cross-platform accounts & identity management
AccelByte Cloud’s E-Commerce service allows you to manage your store, put games, in-game items, or add-ons up for sale, and sort these items into categories. E-Commerce includes several features, such as:
Permissions (opens new window) are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage E-Commerce in the Admin Portal. For a full list of permissions that impact E-Commerce, see the Platform/Commerce tab of the permissions reference (opens new window). reference.
Usage | Resource | Action |
---|---|---|
Create a Store | ADMIN:NAMESPACE:{namespace}:STORE | Create |
Create a Category | ADMIN:NAMESPACE:{namespace}:CATEGORY | Create |
Create a KeyGroup | ADMIN:NAMESPACE:{namespace}:KEYGROUP | Create |
Create an Item in Store | ADMIN:NAMESPACE:{namespace}:ITEM | Create |
Permissions work slightly differently depending on whether they are assigned to IAM clients or are Roles assigned to users. For more information, read the Authentication and Authorization documentation.
In the Admin Portal, go to the Commerce section and click the Stores menu.
On the Stores page, go to the Draft Store section and click the Create Draft Store button.
NOTE
You can only have one draft store.
A form appears and you need to fill in the required information into the form below.
When you’re done, click Create.
The draft store appears on the Stores page. The next thing you need to do is add item categories and items to your store.
Creating a category is useful for you to organize the items from your store into groups.
In the Draft Store, click the more options under the Action column and choose View to add categories.
In your draft store, open the Categories tab, and click the Create Category button.
The Create Category form appears and you need to fill the required information into the form below.
When you’re done, the new category will be added to the list.
NOTE
Changes you made inside the store will not appear in the Player Portal until the store is published.
Creating a Key Group is useful if you need to add a Product Key that can be redeemed on the desired platform.
Go to Platform Configurations in the Admin Portal and click Product Keys.
On the Product Key page, click Add Key Group.
Fill in the required fields.
When you’re done, the new Key Group is added to the list.
In your store page, go to the Items tab, click the Create Item button.
Choose whether you want to create a new item or clone one from another namespace. In these steps, we will choose to Create a New Item.
NOTE
You can only clone items from the Publisher Namespace.
The Create Item form appears.
The Add Item form will appear. Choose the type of item you want to create in the Item Type field. Available item types include:
App: Used for application items like games, demos, DLC, or software. You can only create this type of item in Publisher Namespace.
In-Game Item: A durable or consumable item used in a game.
NOTE
Before you can create in-game items, you need to register an App with the Game type in your store.
Bundle: A package containing one or more items from your store combined into a single purchasable item. You need to create at least two items before you can make a bundle.
Coin: Credit that can be used to top up a player’s virtual currency wallet.
Code: Used by players to redeem apps, in-game items, bundles, etc.
Subscription: Used to create a subscription package.
Media: Items such as music, exclusive art, etc.
Season: A limited-time-only event that uses passes and tiers to engage participating players. You can only create this type of item in a game namespace. For more information, see the Season Pass documentation.
Option Box: This can be used as a reward that contains collections of items, and the player can choose which item they want as a reward.
TIP
We highly recommend that you create any pass or tier items in a draft store so you don’t have to take your store offline every time you wish to make edits. Pass and tier items do not have to be available in your published store for them to be usable in Season events.
After choosing the item type, another field will appear for information based on the item type you chose.
First, fill in the Basic Information field group:
Item Name: Input the name of the item.
Category: Assign the item to a category that you created earlier.
App Type: Choose the category.
App ID: This is a unique identifier, made up of alphanumeric characters, that is used to identify your game when you upload it.
NOTE
You can't change the App ID after it has been defined.
Required Game: The game your bundle will be associated with.
Currency Code: The currency code for the coin.
KeyGroup: Select a keygroup that you created earlier.
Item: Choose Pass to create a pass item that allows players to participate in seasonal events. Passes can be made free or available for player purchase. Choose Tier to create a tier item that grants players access to rewards. You can give players the option to purchase tiers to access rewards they have not earned through participation in season events.
Fill the Store Configuration section:
SKU Number: The ID of the item from the third-party platform that supports in-app purchases using an SKU Number. Fill this field if you want to map this item to a third-party platform. Below is a list of third-party platforms that support in-app purchases, and the values you need to enter into the SKU Number field:
Third Party Platform | Value |
---|---|
PSN | Entitlement Label |
Xbox | StoreID |
Twitch | Reward ID |
productId | |
Apple | productId |
Stadia | product_id |
Epic | productId |
Target Namespace: The game namespace where the item will be sold.
Item Purchase Limit: Define the purchase limit of this item for your store. For example, if you set the item purchase limit to 100, this means that 100 units of that particular item will be available for purchase in your store. To make this value unlimited, input -1.
User Purchase Limit: Define the purchase limit of this item for each account. For example, if you set the user purchase limit of this item to 100, this means that 100 units of that particular item will be available for purchase in your store, for each account. To make this value unlimited, input -1.
Entitlement Type: If you want to repeatedly use an item, choose Durable. If your item is single-use, choose Consumable.
Follow these additional steps for Consumable items:
Display Order: Set the order of the item will be displayed in the Player Portal.
Visible in Store: Select True to make the item visible, or False to hide the item from your published store.
Purchasable in Store: Select True to make your item available for purchase, or False to make it unavailable for purchase.
There are three scenarios you can apply to Visible in Store and Purchasable in Store fields:
Third-party Store Integration: Use this field if this item is also available in the third-party store.
Features: This field works like a tag. Use this field to include a feature of the item, for example, Christmas Special Edition, Summer Beach, Blinky Mushroom Era, etc. Each item can have more than one feature. This field is optional.
Extension: Use this field to add further information to an item for custom usage. Must be written in a valid JSON format. Array of objects is not allowed.
Fill the Subscription Configuration section:
Billing Cycle: How often subscribing players will be billed. You can choose to charge the user Weekly, Monthly, Quarterly, or Yearly.
Grace Period: Give players extra time to pay, in case of payment processing issues. The default setting is 7 days.
Free Trial: Toggle to Active to set the item available for trial.
Length: Enter the duration of the trial.
There are three types of trial you can choose form:
No Trial
Paid Trial
Free Trial
Fill the Pricing Configuration section:
If you choose Option Box, click Next to include the items in the Option Box. If not, continue to step 14.
In the Create Item page, click Add Items to add items to the Option Box.
NOTE
You can only add an item that's already been created.
The Add Item form appears. Fill in the following information:
If you need to add more options, click Add More Items.
When you have finished adding items, click Save.
When you have finished, click Add or Create and your item is added to your store’s Item list.
You can disable an item in your draft store. Here’s what will happened if you disable an item:
To disable an item, follow steps below:
In the Admin Portal, go to your draft store and find the item you want to disable.
Click the three-dots icon in the Action column, then click Disable.
A Disable Item confirmation box appears.
Click the Disable button.
You can delete an item in your draft store. Follow steps below:
In the Admin Portal, go to your draft store and find the item you want to delete.
Click the three-dots icon in the Action column, then click Delete.
A Delete Item confirmation box appears.
Type DELETE in the field provided, then click the Delete button.
You can set purchasing requirements for each item, meaning that the player can only purchase the item if they have satisfied the requirements.
You can create multiple purchasing requirements for each item you want to sell in your store. Each purchasing requirement stored in a group can contain more than one requirement.
The interaction between groups is OR, meaning that a player could pass only one group to be able to purchase an item.
The interaction between requirements within the same group is AND, meaning that the player must fulfill every requirement in the group if that group is used to decide whether the player can purchase this item or not.
To add purchasing requirements to an item, follow steps below:
In the Admin Portal, go to your draft store and find the item you want to add purchasing requirements to.
Click View in the Action column to open the item.
In the Basic Information section, next to the Purchasing Requirement, click View Configurations.
The Purchasing Requirement Configurations form appears.
Click the Add Configuration button.
A new group appears in the form. Enter the Requirement name and choose the Subject of the requirement from the dropdown.
NOTE
Currently the only Subject you can choose is Entitlement.
Three more fields display in the row. These are all connected to each other and are used to specify the requirements for the group .
Here are some examples:
Choose between include or not include from the dropdown.
Enter the number of items in the any…of field.
Add an item to the list by clicking the Item Selected dropdown, then click Add Item.
The Add Item form appears. Fill in the following information:
When you have finished, click Add.
To add new requirements to a group, click the Add Requirement button.
Click the Group button to add another group.
Create the requirements inside that group.
When you have finished creating the purchasing requirements, click the Save Configuration button.
To check which players that can purchase the requirements, do the following:
In the Admin Portal, go to your published store and find the item you want to do the user validation check for.
Open the item by clicking **View in the Action **column.
In the Basic Information section, next to the Purchasing Requirement, click User Validation.
The Purchasing Requirement Configurations form appears.
Select whether you want to search by Email or by User ID.
Type the player’s account information.
Press Enter.
The purchasing requirements for that player display.
After you’ve created a bundle, you can add items to the bundle by following the steps below.
In the Admin Portal, go to your draft store and find the bundle you want to add items to.
Open the bundle by clicking View.
Scroll down to the Bundle Items to see the list of items contained within that bundle.
To add more items or edit them, click the Add/Edit Item button.
The Add/Edit Item form appears. Select the items you want to add to the bundle.
To add more items click Add More Item, then fill out the fields for the new item as seen above.
When you’re done, click the Save button. The items you added will appear in the Bundle Items section.
By default, your item’s price is set in the default country for your store. To add different prices for different regions, follow the steps below:
In the Admin Portal, go to your item details. In the Pricing panel, click Add New to add new pricing.
Input the following information into the Add Price window:
When you’re finished, click the Add button to update the price.
Publishing content consists of the information and media used to show and describe your items, such as the item descriptions, videos, images, product information, and system requirements.
Choose this publishing content type if you would like to add an item description for each of the available localizations.
In the Admin Portal, go to your item details.
In the Publishing Content section, open the Localization tab.
Click the Add button.
The Add Language Data form appears.
Once completed, click the Add button.
Choose this publishing content type if you would like to add video to the game details. The top video will be displayed as the main video. You can rearrange the display order by clicking the Manage Video Order button.
NOTE
The video must be already uploaded to YouTube.
In the Admin Portal, go to your item details.
In the Publishing Content section, open the Videos tab.
Click the Add button.
The Add Link form appears.
Enter the YouTube link of the video.
Once you have completed the field, click the Add button.
Choose this publishing content type if you would like to add images to the game details.
In the Admin Portal, go to your item details.
In the Publishing Content section, open the Images tab.
Click the Upload button.
The Upload Images form appears.
Select the image you want to upload from your local directory. After the image is selected, you can use the image in a number of ways, for example, if you want to set the image as a product banner, you can fill the Set As field with product-banner.
Once you have completed the fields, click the Submit button.
Choose this publishing content type if you would like to add detailed product information.
In the Admin Portal, go to your item details.
In the Publishing Content section, open the Product Information tab.
Fill out the Product Information fields:
Choose this publishing content type if you would like to add system requirements.
In the Admin Portal, go to your item details.
In the Publishing Content section, open the System Requirement tab.
Fill out the Minimum Requirement fields.
Fill out the Recommended Requirement fields.
You can add your games to the subscription plan by following the steps below. Make sure you’ve created a subscription plan and added a game to your store.
In the Admin Portal, go to your newly created Subscription Item and switch to the Subscription Contents tab. Then, click the Add New button to add an Item to the Subscription.
A modal appears. Here you can select the Item you want to add.
When you’re done, click Add and the item will be added to the subscription content list.
You can also remove an item from the subscription plan, but be aware that this will make current players lose access to the item.
Besides adding items in the Subscription Content, you can also add a game into Subscription Plan via item details. Make sure you have created a subscription item.
Choose the game from your store and click View to open the item details.
Go to Include in the Subscription Content section and click the Add to Subscription button.
A pop-up appears and you need to choose the subscription plan where you want to add the game to.
Once you’ve done, click Add and the game will be added to the chosen subscription plan.
To see your recent changes, open the Admin Portal, go to your draft store, and open the Recent Changes tab. In this tab, you can see all the changes made in your draft store before publishing. Every time your draft store is published, the changes list will be wiped, and then refreshed if any subsequent changes are made.
You can filter the Recent Changes list by:
You can publish all the changes you’ve made in a store or just selected changes.
Select the Store you want to publish. Click the Action field then choose Publish.
Select Publish all changes to publish all changes made to a store. Confirm that you are ready to publish your store by typing PUBLISH in the text field and click Publish Now to confirm.
After you have published a draft store, the draft store will still exist as a draft. This will allow you to make further changes without affecting the published store.
Select the Store you want to publish. Click the Action field then select Publish.
Select Publish partial changes only to publish only the selected changes made to store. Click the Continue button to confirm.
The Recent Changes page will appear. Select the changes that you want to publish. Once completed, click Publish.
Confirm that you are ready to publish your store by typing PUBLISH in the text field and click Publish Now. Your store will be published.
After you publish your draft store, the store will exist as both a draft and published store. This allows you to make further changes to your draft store without affecting the published store.
Select the Store you want to clone. In the Action column, click Clone to Draft and a form will appear.
A form will appear and you need to select the Target Store from the list, then click Clone. The target store will receive the cloned data from the source store.
Here you can see the Target Store has been cloned to Draft Stores.
As an administrator, you can also import or export a store to or from the Admin Portal, to be used by another administrator. Before you import a store, make sure you’ve performed the following actions:
In the Admin Portal, select the Store you want to export. Click the Action field then choose Export from the dropdown menu.
The store will be exported as a ZIP file, which when extracted will produce a JSON file containing your store data.
In the Admin Portal, select the Store you want to import store data into. Click the Action field then choose Import from the dropdown menu.
The Import Store modal appears. Click the Browse button to search for the store data you want to import.
Select which store you want to upload from the directory. After the store has been uploaded, click the Import button.
The target store now contains the imported data.
The store category is useful to organize items in your store catalog into groups. The category APIs can be called by using the functions on AccelByte::FRegistry::Category.
Retrieve root or top most level categories.
Retrieve information on a specified category.
Retrieve a list of subcategories that is one level below a specified category.
Retrieve a list of subcategories that are multiple levels below a specified category.
The Item APIs can be called by using the functions on AccelByte::FRegistry::Item and the APIs can be used to get an item from specific Id, get items that match some criterias, search items with specific keywords.
Get an item information from the published store by specifying itemId parameter.
Get a list of items from the published store that match specific criterias/filters. Available criterias are like the following:
Search items from the published store by using keywords in the title, description, and long description. The function is language constrained, which requires a language code to properly function. If items don’t exist in the specified region, default region items will be returned. When offset and limit value is less than 0, the default value will be used which are 0 for offset and 20 for limit
Before using the Store (opens new window) service from the SDK, you will need to initialize your server-side SDK to ensure you are authorized and able to perform create, read, update, and delete actions.
Before using the Store service from the Golang SDK, you will need to initialize the SDK by following the steps below:
storeService := &platform.StoreService{
Client: factory.NewPlatformClient(&repository.ConfigRepositoryImpl{}),
TokenRepository: &repository.TokenRepositoryImpl{},
}
Once completed, you can use the Golang SDK to create, read, update, or delete Stores (opens new window) from your serverless app.
Before using the Store service from the Python SDK, you will need to initialize the SDK by following the steps below:
Once completed, you can use the Python SDK to create, read, update, or delete Stores (opens new window) from your serverless app.
Before using the Platform service, you will need to set some permissions. Use the following .NET namespaces:
using AccelByte.Sdk.Api.Platform.Model;
using AccelByte.Sdk.Api.Platform.Operation;
using AccelByte.Sdk.Api.Platform.Wrapper;
Before using the Platform service, you will need to set some permissions. Initialize the Store wrapper from the Platform service using the following code:
Store wStore = new Store(sdk);
Once completed, you can use the SDK to create, read, update, or delete stores.
Use the following function to create a store (opens new window):
Use the following function to delete a store (opens new window):
Use the following function to retrieve a store (opens new window):
Use the following function to update a store (opens new window):