Orders

Overview

AccelByte Commerce services allow you to keep track of all of the orders your players make. You can view orders made, count how many items have been purchased, and even cancel and refund orders. Some of the main features of Orders include:

  • Order Management enables you to create, fulfill, or refund orders.
  • Order History allows you to see a list of completed orders for all players or for a specific player.
  • Order Receipt is used to generate a receipt for a specific order.

How It Works

Order a Free Item

The diagram below shows how players can acquire a free item.

orders

Purchase an Item Using New Funds

This diagram shows how players can order and pay for an item by making the necessary funds available at time of purchase.

orders

Purchase an Item Using Funds from Wallet

This diagram shows how players can order and pay for an item using funds stored in their wallet.

orders

Tutorials

Query a Player’s Order

Query a Player’s Order Using API

  1. Use the Query User Orders - GET /admin/namespaces/{namespace}/users/{userId}/orders endpoint.
  2. Input the Namespace field with the publisher namespace.
  3. Input the User ID.
  4. Select the Status of the order.
  5. Input the Item ID of the item you want to get.

Note:

  • Status and Item ID are optional. You can leave them empty to display all items with every status.

Query a Player’s Order in the Admin Portal

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

orders

  1. Go to the E-Commerce section and open the Orders menu.

orders

  1. In the Orders menu, find the desired orders using either the User ID or Email. You can also filter orders by their Status. The available statuses are shown in the table below. When you’re done setting your search parameters, press Enter.
StatusDescription
ALLDisplay all orders, regardless of status.
UnpaidUnpaid orders occur if there has been an issue with the payment process or when the player did not proceed to payment.
PaidPaid orders are orders that have been successfully paid.
ChargebackChargeback 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 ReversedChargeback Reversed indicates that you have successfully disputed a chargeback request and the disputed funds have been returned to you.
FulfilledFulfilled indicates that the order was successful and the player has been granted the item.
Fulfill FailedFulfill 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 order.
RefundingRefunding occurs when our platform has already sent a refund request to the 3rd party payment provider but has not yet received a notification.
RefundedRefunded indicates that the refund for the order has been successfully processed.
Refund FailedRefund failed indicates that a technical issue has prevented the refund from being processed.
ClosedClosed indicates that an order has been left unpaid for so long that it’s expired. Unpaid orders expire after 10 minutes.

orders

  1. The list of the player’s orders appears, as seen below:

orders

Get a Player’s Order History

Get a Player’s Order History Using API

  1. Use the Get User Order Histories - GET /admin/namespaces/{namespace}/users/{userId}/orders/{orderNo}/history endpoint.
  2. Input the Namespace field with the Publisher Namespace.
  3. Input the User ID.
  4. Input the order number in orderNo field. Upon successful request, the order history will be retrieved.

Get a Player’s Order History in the Admin Portal

  1. After you get a player’s order, you can view their order history by clicking the View button in the Action column.
  2. In the Order Details panel, click the Order History button.

orders

  1. The user’s order history appears. You can see when each item was paid for and fulfilled in the Action column.

orders

Download an Order Receipt

Download an Order Receipt Using API

  1. Use the Download User Order Receipt - GET /admin/namespaces/{namespace}/users/{userId}/orders/{orderNo}/receipt.pdf endpoint.
  2. Input the Namespace field with the Publisher Namespace.
  3. Input the User ID.
  4. Input the order number in orderNo field. Upon successful request, the order receipt will be downloaded.

Download an Order Receipt in the Admin Portal

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

orders

  1. The download will start immediately. The Order Receipt will be saved as a PDF file.

Refund an Order

Refund an Order Using API

  1. Use the PUT /admin/namespaces/{namespace}/orders/{orderNo}/refund endpoint.
  2. Input the Namespace field with Publisher Namespace.
  3. Input the order number in orderNo field.
  4. Fill out the Request Body.
    • Input the Description field with the reason why the order is being refunded.

Refund an Order in the Admin Portal

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

orders

  1. Once the Refund Order form appears, type the Reason why the order is going to be refunded. When you’re done, click the Refund button.

orders

What’s Next?

  • To learn more about orders, check out the API Reference.
  • Check out Wallets to learn more about how users can store currency to use for orders.
  • Read more about Fulfillment.