Gameball Developers Guide
v3.0
v3.0
  • Introduction
  • What's New in V3.0
  • Installing Gameball
    • Web
      • Show Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
      • Migration from v1 to v2
    • Flutter
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
    • Retail & Modern POS
      • Initialize Gameball Customer Profile
      • Track Orders & Cashback Reward
      • Track Refunds
      • Enable Redemption
        • Prepare POS for Redemption
        • Using Virtual ID
          • Using Virtual Card
  • REST API
    • Overview
      • Server-Side SDKs
    • Authentication
    • API Reference
      • Customer
      • Event
      • Transactions
      • Order
      • Coupons
      • Leaderboard 👑
      • Notifications 👑
      • Configurations 👑
      • Batches 👑
        • Batch Operations Data
      • OTP
      • Partner 🤝
        • Client 🤝
        • Redemption Rule 🤝
        • Cashback Rule 🤝
    • Webhooks
      • Notifications Webhook
      • Customer Profile Webhook
    • Errors
    • Object Reference
  • Tutorials
    • Build Custom UI Elements 👑
      • Display Reward Campaign Progress
      • Show VIP Tiers
      • Show Customer Points Balance
      • Build Leaderboards
      • Show Notifications Inbox
      • Adapt UI to Configurations
      • Advanced UI Techniques
        • Increase Sales with Cashback UI Elements
        • Derive Engagement with Rewards Campaigns UI Elements
    • Tracking Customer Events
    • Build your Own Notification System
    • Checkout Integration Example
    • Redemption Integration Options
      • Redeem with coupon system
        • Integrate your coupon system
          • Example using e-commerce platform(WooCommerce)
          • Example using a custom coupon system
        • Build couponing experience
          • Using Gameball widget
          • Build custom experience
            • Showing customers available points
            • Allowing customers to create coupons
            • Apply the discount code to your cart
        • Coupon integration reference
      • Redeem with direct debt
        • Get customers points balance
        • Redeem customer points
  • Third Party Integrations
    • Segment Integration
Powered by GitBook
On this page
  1. Installing Gameball
  2. Retail & Modern POS

Track Orders & Cashback Reward

PreviousInitialize Gameball Customer ProfileNextTrack Refunds

Last updated 1 year ago

Start tracking customers' orders on your platform upon order completion and successful payment. This enables rewarding the customer with cashback wallet points for paid amounts as per your cashback program configuration on Gameball.

Cashback rewarding and order tracking can be done via server side Order API which is a tailored API to support retail and e-commerce platforms

The is comprehensive and accepts multiple order data, including line items details, taxes, and discounts. This enables businesses to track customer activity in detail and provide tailored rewards and cashback based on their purchases. For example, businesses can offer customers extra loyalty points for purchasing specific products or spending a certain amount of money.

Order API automatically creates a customer in Gameball if it was not created before via Create Customer API

The identifies the order transaction using the Order ID parameter. Which can be the id of the transaction in the POS system. This helps in consolidation between Gameball and POS systems and refund cases.

A simple example for order API usage can be as below example. Where a customer with id id123 made a purchase of 2 items of a product with id 197765 The total paid was 100.

{
  "playerUniqueId":"id123",
  "orderId":"6253e03b",
  "orderDate":"2019-09-21T16:53:28.190Z",
  "totalPrice":"90",
  "totalPaid":"100",
  "totalDiscount":"0",
  "totalShipping":"0",
  "totalTax":"10",
  "lineItems":[
  {
    "productId":"197765",
    "tag":[
        "VIP"
    ],
    "quantity":2,
    "category":[
        "natural",
        "cosmetics"
    ],
    "vendor":"nike",
    "collection":[
        "14313",
        "4343"
    ]
  }
  ],
  "holdReference":null
}

Track Orders from branches

Order API can be expanded to include information about merchants and branches using the merchant object. The merchant object within the Order API can be used to identify the branch where the transaction has occurred. This can be useful for businesses with multiple locations, as it allows them to track customer activity. The merchant object contains information such as the merchant ID, branch ID, and branch name, which can be used to identify the specific location where the transaction took place. By tracking customer activity at each branch, businesses can gain insights into customer behavior and tailor their rewards and incentives accordingly. This can help to improve customer satisfaction, drive repeat purchases, and ultimately increase revenue.

Merchant module should be enabled in order to work properly.

Suppose the above order example was received in the central park branch of brand Amazing brand. The brand\merchant had the id of m_001 and the branch has the id of b_001.

The payload to be sent to Gameball will look like the below

{
  "playerUniqueId":"id123",
  "orderId":"6253e03b",
  "orderDate":"2019-09-21T16:53:28.190Z",
  "totalPrice":"90",
  "totalPaid":"100",
  "totalDiscount":"0",
  "totalShipping":"0",
  "totalTax":"10",
  "lineItems":[
  {
    "productId":"197765",
    "tag":[
        "VIP"
    ],
    "quantity":2,
    "category":[
        "natural",
        "cosmetics"
    ],
    "vendor":"nike",
    "collection":[
        "14313",
        "4343"
    ]
  }
  ],
  "merchant":{
    "uniqueId":"m_001",
    "name":"amazing brand",
    "branch":{
      "uniqueId":"b_001",
      "name":"central park"
    }
  },
  "holdReference":null
}
{
  "playerUniqueId":"id123",
   "email":"jon.snow@example.com"
  …
   …
   …
   …
}

support the account merging feature too. For case of merge, email or mobile number must be sent top level with the order API payload as below

Order API
Order API
Order API