Earn Points

Earns and accumulates points based on core (earn and burn) rules, promotional rules, etc. set at the club level. It is possible, for instance, to set rules that a member will earn 10 points for every $100 spent in a purchase transaction, and 10 points are equivalent to$2. Rules are customizable based on the requirement.
Points are categorized as:
1) Base points: Earned in any purchase transaction based on the core rule.
2) Bonus points: Earned as a bonus for example on a large purchase.
3) Promotional Points: Earned as part of promotional events.
4) Restricted Points: Points to be used only on specified stores.

Earn endpoint uses the following formula for validating Payload:
1) Amount Paid = Gross Amount - Discounts
2) Net Amount = Gross Amount - Taxes - Discounts
3) At the Transaction Item level: Item Price - (Discount/Quantity) = Net Amount / Quantity
4) Total of all Transaction Items' Gross Amount = Total Gross Amount

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details required to earn points

activityTimestamp

string

required

Activity date (in UTC format). An activity could be enrolling a member, making a transaction, etc.

checkForDuplicateTransaction

integer

required

0 indicates the system allows duplicates and 1 indicates there is a validation in place to identity duplicate.

discountValue

integer

required

Discount value on the transaction, if applicable

entityReference

string

required

Name or ID for the store (or entity) where the transaction took place.

Required string length: 1 - 100

fetchUpdatedMemberPointTotals

integer

required

1 indicates the total points are calculated and shown to the member. 0 indicates the total points are not calculated and the member is only notified the earn is successful. Note: The response is faster when the value is 0 because the total points are not calculated on the fly.

netAmount

number

required

Net transaction amount based on the total items in the transaction, after subtracting taxes and discounts.

Required range: x > 0

totalAmountPaid

number

required

Total amount paid for the items. For example, the amount paid for item1 is 100.00 and the amount of item2 is 200.00 so the total amount paid is 300.00.

totalTax

number

required

Total tax based on the number of items in the transaction. For example, the tax amount of item1 is 2.00 and tax amount of item2 is 1.00. The totalTax is 3.00.

transactionExternalReference

string

required

Order ID or receipt ID for a transaction (received from the store). It is needed to cancel or return an order.

Required string length: 1 - 100

transactionGrossAmount

number

required

Gross transaction amount (in currency unit) of the total items earn. For example the gross amount of item1 is 50.00 and gross amount of item2 is 100.00. The transactionGrossAmount is 150.00.

Required range: x > 0

transactionTypeExternalReference

string

required

External reference for the transaction type such as purchase, return, or exchange (Configurable as per requirement).

Required string length: 1 - 100

cancelAuditUser

string | null

Representative who cancelled the earn transaction

Required string length: 1 - 200

discounts

object[]

Represents the discounts on the item.

Show child attributes

discounts.value

number

required

Monetary value of the discount.

discounts.description

string

Description of the discount.

Minimum length: 1

discounts.id

integer

Discount ID

discounts.type

string

Discount type

Minimum length: 1

issueAuditUser

string | null

Representative who issued the earn transaction

Required string length: 1 - 200

profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

reasonCode

string

Reason code to categorize transactions. A parent company can configure custom codes for their stores as required.

Required string length: 1 - 30

reasonDescription

string

When reason codes are not configured, store can make use of the reason description to add notes on the transaction.

Required string length: 1 - 300

redemptionCode

string[] | null

Redemption code to identify and link the rewards used in a specific transaction. This is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

setToPending

boolean

default:

false

true: Points in Pending status <br /> false: Points in Active status. <br />Note:The time period for Pending state is configurable.

transactionItems

object[]

Details of the items in the transaction.

Show child attributes

transactionItems.grossAmount

number

required

Gross amount of the item, before discount application

transactionItems.itemPrice

integer

required

Item price

transactionItems.itemQuantity

integer

required

Item quantity

transactionItems.lineNumber

integer

required

Line number of the item in the purchase order (PO)

transactionItems.netAmount

number

required

Total amount of the item without tax, and after item-discount application

transactionItems.SKU

string

required

Stock Keeping Unit (SKU), a unique identifier of the item.

Required string length: 1 - 100

transactionItems.taxAmount

number

required

Tax on the item

transactionItems.totalAmountPaid

number

required

Amount paid for the item, including tax

transactionItems.couponCodes

string[]

transactionItems.discounts

object[]

Discounts detail of the item

Show child attributes

transactionItems.discounts.id

integer

required

Discount ID

transactionItems.discounts.value

integer

required

Discount amount

transactionItems.discounts.description

string

Description of the discount

transactionItems.discounts.type

string

Type of discount (configurable)

Required string length: 1 - 50

transactionItems.itemName

string

Item name

Minimum length: 1

transactionItems.UOM

string

Unit of Measurement (UOM)

Minimum length: 1

Response

200 - application/json

Metadata for the Earn points response

data

object

Earn details

Show child attributes

data.profileId

string

required

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

data.transactionNumber

string

required

Transaction number. It is same as the transactionExternalReference and indicates a unique order ID or receipt ID.

Minimum length: 1

data.transactionType

enum<string>

required

Refers to the different types of transaction activities on a member account such as Earn Transaction, Burn Transaction, Earn Reverse Transaction and so on

Available options:

EARN,

BURN,

EXPIRY,

EARN_REVERSE,

BURN_REVERSE,

ADJUSTMENT,

DEDUCT,

TRANSFER,

MERGE,

FORFEITED,

CONVERT,

UNMERGE

data.activityTimestamp

string

Activty time (UTC format)

data.basePoints

number

Base points earned in this transaction

data.bonusPoints

number

Bonus points earned in this transaction

data.cancelAuditUser

string | null

Representative who cancelled the earn transaction.

Minimum length: 1

data.currentPointsBalance

number

Total points currently available in the member's account.

data.deviceId

string

Device ID used to capture the transaction

data.discounts

object[]

Represents the discount details.

Show child attributes

data.discounts.id

integer

required

Discount ID

data.discounts.value

number

required

Discount amount

data.discounts.description

string

Description of the discount.

data.discounts.type

string

Discount type (configurable).

Minimum length: 1

data.discountValue

number

Discount amount on the specified transaction.

data.issueAuditUser

string | null

Representative who issued the earn transaction.

Minimum length: 1

data.points

number

Points earned by the member

data.promotionalPoints

number

Promotional points earned in this transaction

data.reasonCode

string | null

Reason code used to categorize transactions. A parent company can configure custom codes for their stores as required.

Minimum length: 1

data.reasonDescription

string

When reason codes are not configured, store can make use of the reason description to add notes on the transaction.

Minimum length: 1

data.rewards

object[]

Represents the variable rewards details

Show child attributes

data.rewards.core_rule_id

integer

ID of the core rule based on which the rewards are generated.

data.rewards.reward_id

integer

Variable reward IDs (also referred to as reward certificate). Note:Multiple rewards can be used a transaction.

data.rewards.reward_portion

number

Total reward amount.

data.totalAmountPaid

number

Total amount paid for items. For example, the amount paid for item1 is 100.00 and the amount of item2 is 200.00 so the total amount paid is 300.00.

data.totalTax

integer

Total tax applied on earning items

data.transactionActivityType

string

Configurable alias for the transactionType

data.transactionCode

string

Transaction Code, which uniquely identifies each transaction

data.transactionDateTime

string

Transaction time (UTC format)

data.transactionEntityReference

string

Transaction entity reference

Minimum length: 1

data.transactionExternalReference

string

Order ID or receipt ID for a transaction (received from the store). This is unique and needed to cancel or return an order.

Minimum length: 1

data.transactionItems

object[]

Details of transaction items

Show child attributes

data.transactionItems.grossAmount

number

required

Gross amount of the item, before discount application

data.transactionItems.itemPrice

integer

required

Item price

data.transactionItems.itemQuantity

integer

required

Item quantity

data.transactionItems.lineNumber

integer

required

Line number of the item in the purchase order (PO)

data.transactionItems.netAmount

number

required

Total amount of the item without tax, and after item-discount application

data.transactionItems.SKU

string

required

Stock Keeping Unit (SKU), a unique identifier of the item.

Required string length: 1 - 100

data.transactionItems.taxAmount

number

required

Tax on the item

data.transactionItems.totalAmountPaid

number

required

Amount paid for the item, including tax

data.transactionItems.couponCodes

string[]

data.transactionItems.discounts

object[]

Discounts detail of the item

Show child attributes

data.transactionItems.discounts.id

integer

required

Discount ID

data.transactionItems.discounts.value

integer

required

Discount amount

data.transactionItems.discounts.description

string

Description of the discount

data.transactionItems.discounts.type

string

Type of discount (configurable)

Required string length: 1 - 50

data.transactionItems.itemName

string

Item name

Minimum length: 1

data.transactionItems.UOM

string

Unit of Measurement (UOM)

Minimum length: 1

data.transactionNetAmount

number

Net total amount of the transaction

data.transactionTypeExternalReference

string

External reference for transaction type such as purchase, return, or exchange. Supports any value as configured by store.

Minimum length: 1

errors

object

In a successful response, this is always a blank object.

message

string

default:

Exception message

Message corresponding to status code.

Minimum length: 1

status

integer

Status code of call