Calculate Order Cashback

Calculate the cashback points to be rewarded for a specific order. This estimates rewards based on your configured rules and eligibility; it does not perform any reward.

Security: Provide apikey header.

Authorizations

apikey

string

header

required

Body

application/json

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. This is the value used to calculate any points or rewards earned from the order.

Example:

350

totalDiscount

number

required

Total discount applied to the order. Must be positive.

Required range: x >= 0

Example:

0

totalShipping

number

required

Total shipping cost for the order.

Example:

0

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. If provided, the cashback calculation will consider the customer's tier. Special tier-based configurations, such as enhanced point accrual rates, may affect the points calculation.

Example:

"cust_12345abc"

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:

350

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:

"875511"

lineItems.quantity

number

Number of units purchased for this product or service.

Example:

1

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:

150

lineItems.sku

string

Stock Keeping Unit (SKU) for the product.

Example:

"sku123"

lineItems.tags

string[]

Tags associated with the product for categorization or promotional purposes.

lineItems.category

string[]

Product category, such as fashion or electronics. It can include one or multiple categories. Example: ["natural", "cosmetics"]

lineItems.weight

number

Weight of the product.

lineItems.vendor

string

Vendor or manufacturer of the product.

lineItems.collection

string[]

Collection ID(s) to which the product belongs. It can include one or multiple collections. Example: ["14313", "4343"]

Example:

["123"]

lineItems.title

string

Product title or name.

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:

0

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:

0

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.

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"

Response

200 - application/json

Cashback calculated successfully

totalPoints

number

Total points expected to be earned from the entire order.

Example:

19000

totalScore

number

Total score expected to be earned from the entire order.

Example:

0

lineItems

object[]

An array of individual line items and their cashback calculation details.

Show child attributes

lineItems.productId

string

Unique identifier for the product.

Example:

"875511"

lineItems.quantity

number

The quantity of the product purchased.

Example:

1

lineItems.totalDecimalPoints

number

The total decimal points earned for this line item, including any campaign impact.

Example:

15000

lineItems.totalPoints

number

The total points earned for this line item, including any campaign impact. Example: If the base points for a product are 50 and a campaign adds 150 points, the totalPoints would be 200.

Example:

15000

lineItems.totalScore

number

The total score earned for this line item. This value is separate from point and is based on your cashback rewards configuration.

Example:

0

lineItems.rewardWalletFactor

number

The multiplier applied to the product price to calculate the base points earned for this line item. This factor represents how many points are earned per unit of currency spent on the product. Example: If the store rewards 10 points for every $1 spent, the rewardWalletFactor would be 10.

Example:

20

lineItems.campaignId

integer | null

The unique identifier for the active transactional campaign that affects the cashback reward for purchasing this line item. If no campaign is applicable, this field will be null.

Example:

2149

lineItems.campaignName

string | null

The name of the active transactional campaign that affects the cashback reward for purchasing this line item. If no campaign is applicable, this field will be null. Example: If a store is running a "Double Points Weekend" campaign, the campaignName could be "Double Points Weekend."

Example:

"5x Points Campaign"

lineItems.campaignEndDate

string<date-time> | null

The end date of the active campaign affecting the line item. This is the date when the campaign will no longer influence points or rewards.

Example:

"2024-11-01T08:39:00"

lineItems.campaignImpactWalletFactor

number

The multiplier applied by the campaign to the base points calculation. This factor adjusts the final points earned for the line item based on the campaign's impact. Present only if a campaign is applicable. Example: If the campaign offers 3x points, the campaignImpactWalletFactor would be 3, multiplying the regular points earned by three.

Example:

5

lineItems.campaignImpactPoints

number

The total number of points given for this line item due to the campaign's impact. This value reflects the additional points earned from the campaign. Example: If the base points for an item are 100 and the campaign offers 5x points, the campaignImpactPoints would be 400 (totaling 500 points with the base points included).

Example:

12000

API documentation

Webhooks

Authorizations

Body

Response