Order Tracking

Create orders in Gameball to award points for customer purchases. This API is used to track orders and reward customers for their completed purchases.

Security: Provide both apikey and secretkey headers.

Authorizations

apikey

string

header

required

Body

application/json

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.

Example:

"cust_123456789"

orderId

string

required

Unique identifier for the order on your system. This ID is case-sensitive.

Example:

"ORD12345"

orderDate

string<date-time>

required

Timestamp of when the order was placed.

Example:

"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.

Example:

250.75

string

Customer's email address. Note: This is required if your account uses email-based channel merging.

Example:

"john.doe@example.com"

mobile

string

Customer's mobile number. Note: This is required if your account uses mobile-based channel merging.

Example:

"+1234567890"

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.

Example:

300

totalDiscount

number

Total discount applied to the order.

Example:

50

totalShipping

number

Total shipping cost associated with the order.

Example:

10

totalTax

number

Total tax amount for the order.

Example:

15

lineItems

object[]

An array containing details about each product in the order. If not provided, the calculation will only consider the total order values.

Show child attributes

lineItems.productId

string

Unique identifier for the product or service being purchased.

Example:

"PROD98765"

lineItems.quantity

number

Number of units purchased for this product or service.

Example:

2

lineItems.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.

Example:

100

lineItems.sku

string

Stock Keeping Unit (SKU) for the product.

Example:

"SKU98765"

lineItems.tags

string[]

Tags associated with the product for categorization or promotional purposes.

Example:

["electronics", "smartphone"]

lineItems.category

string[]

Product category, such as fashion or electronics. It can include one or multiple categories.

Example:

["mobile phones"]

lineItems.weight

number

Weight of the product.

Example:

0.5

lineItems.vendor

string

Vendor or manufacturer of the product.

Example:

"TechVendor"

lineItems.collection

string[]

Collection ID(s) to which the product belongs. It can include one or multiple collections.

Example:

["latest gadgets"]

lineItems.title

string

Product title or name.

Example:

"Smartphone XYZ"

lineItems.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.

Example:

7.5

lineItems.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.

Example:

25

lineItems.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.

Example:

{ "subClass": "SUBCLASS123" }

redemption

object

Redemption details for the order, including points held for redemption.

Show child attributes

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.

Example:

"HOLD123"

redemption.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.

Example:

"LOCK123"

redemption.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.

Example:

["DISCOUNT10"]

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.

Example:

{ "paymentMethod": "CREDIT CARD" }

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.

Show child attributes

merchant.uniqueId

string

Unique identifier for the merchant.

Example:

"MERCH001"

merchant.name

string

Name of the merchant.

Example:

"TechGadgetStore"

merchant.branch

object

Branch information where the order took place.

Show child attributes

merchant.branch.uniqueId

string

Unique identifier for the branch where the order took place.

Example:

"BRANCH001"

merchant.branch.name

string

Name of the branch where the order took place.

Example:

"Downtown Branch"

guest

boolean

default:false

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.

Example:

false

channel

enum<string>

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.

Available options:

mobile,

pos,

web,

callcenter

Example:

"pos"

cartId

string

Identifier for the shopping cart associated with the order.

Example:

"CART98765"

cashbackConfigurations

object

This object contains configurations related to the cashback settings.

Show child attributes

cashbackConfigurations.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).

Required range: 0 <= x <= 7300

Example:

7

Response

200 - application/json

Order tracked successfully

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.

Example:

"cust_123456789"

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.

Example:

1000

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.

Example:

101

lineItems

object[]

Details about each product or service in the order, including points rewarded.

Show child attributes

lineItems.productId

string

Unique identifier for the product or service.

Example:

"PROD98765"

lineItems.quantity

number

Number of units purchased for this product or service.

Example:

2

lineItems.decimalPoints

number

Fractional points rewarded for this line item.

Example:

91.25

lineItems.points

number

Any points rewarded for this line item.

Example:

91

lineItems.score

number

Any score awarded for the line item, if applicable.

Example:

0

API documentation

Webhooks

Authorizations

Body

Response