Rewards
Manages customer rewards programs, including earning and redeeming rewards points.
Offer allows seller to activate/deactivate and Set available offers in Platform. It will help seller to boost their sales. You can utilize this feature to access details about the available offers on the platform and to see the discounts applied when placing an order. Available offers consist of: - Order - Referral - Sign Up
Operations
GET
# Get specific offer
POST
# Order from catalogue
POST
# Order discount
Parameters
name
string
Required
The name given to the offer.
Response
200
Success. Check example below or refer `Offer` for more details.
Offer
_schedule
object (Schedule)
Schedule
duration
integer
end
string
start
string
cron
string
active
boolean
application_id
string
banner_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
created_at
string
| date-time
name
string
rule
object
share
object (ShareMessages)
ShareMessages
email
integer
facebook
string
fallback
string
message
string
messenger
string
sms
string
text
string
twitter
string
whatsapp
string
sub_text
string
text
string
type
string
updated_at
string
| date-time
updated_by
string
url
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Request body
articles
array of object (RewardsArticle)
Array of RewardsArticle
id
string
points
number
price
number
Response
200
Success. Check example below or refer `CatalogueOrderDetails` for more details.
CatalogueOrderDetails
articles
array of object (RewardsArticle)
Array of RewardsArticle
id
string
points
number
price
number
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Parameters
No Parameters
Request body
order_amount
number
Required
currency
string
Response
200
Success. Check example below or refer `OrderDiscountDetails` for more details.
OrderDiscountDetails
order_amount
number
points
number
discount
object (DiscountProperties)
DiscountProperties
absolute
number
currency
string
display_absolute
string
display_percent
string
percent
number
base_discount
object (DiscountProperties)
DiscountProperties
absolute
number
currency
string
display_absolute
string
display_percent
string
percent
number
applied_rule_bucket
object (OrderDiscountRuleBucket)
OrderDiscountRuleBucket
high
number
low
number
max
number
value
number
value_type
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
User Points refer to the rewards credited to a user's account following various actions such as signing up or placing orders. The Referral Program enables users to share their exclusive code with others, rewarding both the sharer and the recipient with points upon code redemption. This feature grants users access to functions such as checking their accumulated points, reviewing past point-earning activities, and obtaining their unique referral codes. Users can redeem referral codes from fellow users to accrue reward points, which can subsequently be utilized to lower the total amount during order placement.
Operations
GET
# Points history
GET
# Current points
GET
# Referral details
POST
# Redeem code
Parameters
page_id
string
PageID is the ID of the requested page. For first request it should be kept empty.
page_size
integer
The number of items to retrieve in each page.
Response
200
Success. Check example below or refer `PointsHistoryDetails` for more details.
PointsHistoryDetails
items
array of object (PointsHistory)
History is the list of points transaction.
Array of PointsHistory
_id
string
application_id
string
claimed
boolean
created_at
string
| date-time
expires_on
string
meta
object
points
number
remaining_points
number
text_1
string
text_2
string
text_3
string
txn_name
string
updated_at
string
| date-time
user_id
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check example below or refer `PointsDetails` for more details.
PointsDetails
points
number
Total points available
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check example below or refer `ReferralDetails` for more details.
ReferralDetails
referral
object (Offer)
Offer
_schedule
object (Schedule)
Schedule
duration
integer
end
string
start
string
cron
string
active
boolean
application_id
string
banner_image
object (Asset)
Asset
aspect_ratio
string
id
string
secure_url
string
created_at
string
| date-time
name
string
rule
object
share
object (ShareMessages)
ShareMessages
email
integer
facebook
string
fallback
string
message
string
messenger
string
sms
string
text
string
twitter
string
whatsapp
string
sub_text
string
text
string
type
string
updated_at
string
| date-time
updated_by
string
url
string
share
object (ShareMessages)
ShareMessages
email
integer
facebook
string
fallback
string
message
string
messenger
string
sms
string
text
string
twitter
string
whatsapp
string
user
object (ReferralDetailsUser)
ReferralDetailsUser
blocked
boolean
points
number
redeemed
boolean
referral_code
string
referrer_info
string
terms_conditions_link
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Request body
device_id
string
referral_code
string
Response
200
Success. Check example below or refer `RedeemReferralCodeDetails` for more details.
RedeemReferralCodeDetails
redeemed
boolean
message
string
referrer_info
string
referrer_id
string
points
number
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response