---
title: "Track Order"
method: POST
path: "/api/v4.0/integrations/orders"
tags: ["Orders"]
---

# Track Order

`POST /api/v4.0/integrations/orders`

The API call is used to track a new order and is specifically designed for e-commerce solutions. It helps capture essential order details, enabling better tracking of customer purchases and order management.

**Security:** Requires both `apikey` and `secretkey` headers.

**Channel Merging Available:** If your system uses different customer IDs across multiple channels (e.g., online and offline), Gameball's channel merging feature helps unify customer profiles. By including the customer's mobile number or email (based on your merging configuration) with each request, Gameball will combine activities into a single profile.

## Request body

- object
  - `customerId` string, required — Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.
  - `email` string — Customer's email address. **Note:** This is required if your account uses email-based channel merging.
  - `mobile` string — Customer's mobile number. **Note:** This is required if your account uses mobile-based channel merging.
  - `orderId` string, required — Unique identifier for the order on your system. This ID is case-sensitive.
  - `orderDate` string, date-time, required — Timestamp of when the order was placed. Must be in UTC (ISO 8601 format), e.g. `2024-10-16T08:13:29.290Z`.
  - `totalPaid` number, required — The actual amount paid by the customer for the order, accounting for any discounts or coupons applied. Unlike `totalPrice`, which reflects the original cost of the order, `totalPaid` represents the final amount the customer paid at checkout after all adjustments. This value is used for reward calculations in Gameball to determine the points or benefits earned from the order. **Example:** A customer purchases items worth $120, including taxes and shipping. If a $20 coupon is applied, the `totalPaid` becomes $100, reflecting the discounted amount the customer paid.
  - `totalPrice` number — The total cost of the order, including all item prices, shipping, taxes, and tips. This value does not account for any discounts or coupons applied and is not used for calculations in Gameball; it is solely saved as historical data linked to the order. Must be a positive value. **Example:** A customer purchases items worth $120, including taxes and shipping. Even if a $20 coupon is applied, the totalPrice remains $120 as it represents the original cost of the order before any discounts are applied.
  - `totalDiscount` number — Total discount applied to the order.
  - `totalShipping` number — Total shipping cost associated with the order.
  - `totalTax` number — Total tax amount for the order.
  - `lineItems` object[] — An array containing details about each product in the order. If not provided, the calculation will only consider the total order values.
    - `productId` string — Unique identifier for the product or service being purchased.
    - `quantity` number — Number of units purchased for this product or service.
    - `price` number — The original price of a single product before any tax or discount is applied. This reflects the cost of one unit of the item, not the total for multiple quantities in an order. **Example:** If the original price of a product is $50 and a customer buys two units, the price for each item would still be recorded as $50, regardless of quantity.
    - `sku` string — Stock Keeping Unit (SKU) for the product.
    - `tags` string[] — Tags associated with the product for categorization or promotional purposes.
    - `category` string[] — Product category, such as fashion or electronics. It can include one or multiple categories.
    - `weight` number — Weight of the product.
    - `vendor` string — Vendor or manufacturer of the product.
    - `collection` string[] — Collection ID(s) to which the product belongs. It can include one or multiple collections.
    - `title` string — Product title or name.
    - `taxes` number — The total amount of taxes applied to the line item, expressed in the shop's currency. This amount must be positive and reflects the total taxes based on the quantity of the item.
    - `discount` number — The total discount applied to this line item, expressed as a positive value. This amount should reflect the total discounts based on the quantity of the item.
    - `extra` object — Key-value pairs containing any extra information about the product, such as size, color, or other custom attributes. The values must be of type string or number.
  - `redemption` object — Redemption details for the order, including points held for redemption.
    - `pointsHoldReference` string — Reference from the Hold Points API for redeeming held points. For more details on how hold references are generated and utilized, refer to the Transactions section.
    - `couponsLockReference` string — The lock reference for the coupon is a unique identifier used to 'lock' a coupon for a specific customer or order. This prevents the coupon from being used by others or on multiple transactions. For more details on how to generate and use lock references, refer to the Coupons section.
    - `couponCodes` string[] — A list of coupon codes that were applied to the order. Each code in the array represents a different discount or promotional coupon used during the checkout process. Coupon codes must be locked before they can be used for redemption.
  - `extra` object — Key-value pairs containing any extra information about the order. The values must be of type string or number. **Example:** If your business offers gift options, you might want to include a personalized gift message with the order. Additionally, specific delivery instructions can be recorded to ensure smooth delivery and provide a personalized experience.
  - `merchant` object — This object contains details about the specific merchant involved in the transaction, which is particularly important for businesses managing multiple merchants or branches under the same Gameball account. This object can provide identifying information about both the main merchant and any associated branch where the transaction took place.
    - `uniqueId` string — Unique identifier for the merchant.
    - `name` string — Name of the merchant.
    - `branch` object — Branch information where the order took place.
      - `uniqueId` string — Unique identifier for the branch where the order took place.
      - `name` string — Name of the branch where the order took place.
  - `guest` boolean — Indicates whether the customer is a guest (not signed up). Set this to `true` for guest users; otherwise, they are treated as registered customers by default.
  - `channel` 'mobile' | 'pos' | 'web' | 'callcenter' — The channel through which the order was placed helps track the origin of the order, particularly useful for systems that support multiple sales or communication channels. By identifying the channel, you can gain valuable insights into customer behavior, optimize channel-specific strategies, and ensure efficient handling of orders across platforms. **Possible values:** `mobile` - The order was placed through your mobile application. `pos` - The order was placed in person using a Point of Sale (POS) system, such as at a physical store or outlet. `web` - The order was placed through your website. `callcenter` - The order was placed over the phone by contacting a customer service representative or a call center.
  - `cartId` string — Identifier for the shopping cart associated with the order.
  - `cashbackConfigurations` object — This object contains configurations related to the cashback settings.
    - `returnWindow` integer — The number of days the cashback will stay in a **pending** state, typically aligning with the return window in e-commerce to account for potential order cancellations or refunds. The value should be between **0 and 7,300 days (20 years)**.

## Response `200`

Order tracked successfully

- object
  - `customerId` string — Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.
  - `redeemedPoints` number — Points redeemed by the customer for this order, if applicable. **Example:** If a customer has accumulated 500 points and decides to redeem 100 points for a discount on their current order, the `redeemedPoints` value for that transaction will be 100. This helps track how many points were used in the transaction and what benefits were applied to the order based on the customer's redeemed points.
  - `rewardedPoints` number — The total number of points rewarded to the customer for making this order. These points are typically awarded based on your configured cashback rewards. **Example:** If the store rewards 10 points for every $1 spent, and a customer places an order worth $50, the **rewardedPoints** for this order would be 500 points.
  - `lineItems` object[] — Details about each product or service in the order, including points rewarded.
    - `productId` string — Unique identifier for the product or service.
    - `quantity` number — Number of units purchased for this product or service.
    - `decimalPoints` number — Fractional points rewarded for this line item.
    - `points` number — Any points rewarded for this line item.
    - `score` number — Any score awarded for the line item, if applicable.

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/3b11e1670d61/schema)