Last Updated: 9/13/2022, 5:26:32 AM

# Orders

# Overview

Players can acquire an item found in your store by ordering it. After a player places an order for an item and pays for it, the Fulfillment service is triggered and the player is granted the item they ordered. Player orders can be viewed and refunded from the Admin Portal.

# Permissions

Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage orders in the Admin Portal. For a full list of permissions that impact orders management, see the Platform/Commerce tab of the permissions reference (opens new window).

Usage Permission Tag Action
Query user orders ADMIN:NAMESPACE:{namespace}:USER:{userId}:ORDER Read
Get user orders history ADMIN:NAMESPACE:{namespace}:USER:{userId}:ORDER Read
Download user order receipt ADMIN:NAMESPACE:{namespace}:USER:{userId}:ORDER Read
Refund order ADMIN:NAMESPACE:{namespace}:USER:{userId}:ORDER Update

Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.

# Order status

You can see your order status. Each order status is explained in the table below.

Order Status
Status Description
ALL Display all orders, regardless of status.
Unpaid Unpaid orders occur if there has been an issue with the payment process, or when the player did not proceed to payment.
Paid Paid orders are orders that have been successfully paid for.
Chargeback Chargeback indicates that the player has issued a complaint regarding the transaction to their credit card or payment provider and that they have been issued a refund. You can either accept or dispute the chargeback.
Chargeback Reversed Chargeback Reversed indicates that you have successfully disputed a chargeback request and the disputed funds have been returned to you.
Fulfilled Fulfilled indicates that the order was successful and the player has been granted the item.
Fulfill Failed Fulfill Failed occurs when the ordered item is no longer available, so the order cannot be fulfilled. If this happens, you’ll need to refund the player for the order.
Refunding Refunding occurs when our platform has already sent a refund request to the 3rd party payment provider but has not yet received a notification.
Refunded Refunded indicates that the refund for the order has been successfully processed.
Refund Failed Refund Failed indicates that a technical issue has prevented the refund from being processed.
Closed Closed indicates that an order has been left unpaid for so long that it’s expired. Unpaid orders expire after 10 minutes.

# Managing Orders in the Admin Portal

# Query an Order

  1. In the Admin Portal, choose the Publisher Namespace. Go to the E-Commerce section, click Sales, and select the Orders menu.

    orders

  2. In the Orders menu, find the desired order using either the Email address of the player who made the order, the full Order ID of the order, the User ID of the player who made the order, or the Payment Processor Reference ID. You can also filter your search by Order Status. When you’re done setting your search parameters, press Enter to search.

  3. The list of orders will appear. Click View in an order’s Action column to open more detailed information about that order.

    orders

  4. The Order Details page will appear. Here you can see more detailed information about the order. You can also open the player’s order history by clicking the Order History button.

    orders

  5. Click the Order History button so see a complete order history for the selected player.

    orders

# Download an Order Receipt

  1. In the Admin Portal, choose the Publisher Namespace. Go to the E-Commerce section, click Sales, and select the Orders menu.

    orders

  2. In the Orders menu, find the desired order using either the Email address of the player who made the order, the full Order ID of the order, the User ID of the player who made the order, or the Payment Processor Reference ID. You can also filter your search by Order Status. When you’re done setting your search parameters, press Enter to search.

  3. The list of orders will appear. Click View in an order’s Action column to open more detailed information about that order.

    orders

  4. In the Order Details panel, click the Order Receipt button.

    orders

  5. The download will start immediately. The order receipt will be saved as a .csv file.

# Refund an Order

  1. In the Admin Portal, choose the Publisher Namespace.

    orders

  2. In the Orders menu, find the desired order using either the Email address of the player who made the order, the full Order ID of the order, the User ID of the player who made the order, or the Payment Processor Reference ID. You can also filter your search by Order Status. When you’re done setting your search parameters, press Enter to search.

  3. The list of orders will appear. Click View in an order’s Action column to open more detailed information about that order.

    orders

  4. In the Order Details panel, click the Refund button.

    orders

  5. The Refund Order form appears. Type the reason for the refund in the Reason field. When you’re done, click Refund.

    orders

# Implementing Orders using SDK

Our SDK can be used to allow a game client to create an order.

# Create an Order

The following function can be triggered to create an order. When an order is created, the ordered items will be identified by their Item IDs, a unique identifier created by our platform for each item you create. For more information about items, see the Catalog documentation.

The ordered item will be granted automatically to the player as an Entitlement after the Payment is successful.

If you encounter the following error, it means that the player already owns the maximum number of the item that they can. You can verify this using the Check Entitlement function.

ErrorCode.ExceedItemMaxCountPerUser

# Cancel an Order

You can use the following code to allow players to cancel orders they’ve made in-game.

# Retrieve an Order

Call this function to retrieve information about a particular order. The order number is used to retrieve the information about the order. That information includes the User ID of the player that made the order, the Item ID of the item ordered, the price of that item, the current status of the order, and other information.

# Retrieve a List of a Player’s Orders

This function returns a list of all of the orders the player has made. The list will include the User ID of the player that made the order, the Item ID of the item ordered, the price of that item, the current status of the order, and other information. You can define the pagination of these records by setting the Page and Size parameters in the function below. Page refers to the offset, or which record you want to start on, whereas Size refers to how many records will be displayed per page. So for example, if you set Page to 1 and Size to 5, the player’s orders will be displayed starting from their first order, with five orders appearing on each page.

# Retrieve a Player’s Complete Order History

This function can be used to retrieve a player’s order history. Each order the player has made will be listed, along with the status each order went through and at what time. For example, precise timestamps will be given for when each order was Unpaid, Paid, Fulfilled, and so on.

  • Read Wallets to learn more about how users can store virtual currency they can use to make orders.
  • Read more about Fulfillment.