Rewards
Manages customer rewards programs, including earning and redeeming rewards points.
Offer and Discount
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
GET
Get specific offer
Retrieves detailed information about an offer by its name.
Parameters
name
string
The name given to the offer.
Response
200
500
Success. Check example below or refer `Offer` for more details.
Offer
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
name
string
Optional
rule
object
Optional
share
object (ShareMessages)
Optional
ShareMessages
sub_text
string
Optional
text
string
Optional
type
string
Optional
updated_at
string
Optional
updated_by
string
Optional
url
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get specific offer
getOfferByName
POST
Order from catalogue
Place an reward on order items available in the catalogue.
Parameters
body
object (CatalogueOrderRequest)
Enter article ID
CatalogueOrderRequest
articles
array of object (RewardsArticle)
Optional
Array of RewardsArticle
Response
200
500
Success. Check example below or refer `CatalogueOrderResponse` for more details.
CatalogueOrderResponse
articles
array of object (RewardsArticle)
Optional
Array of RewardsArticle
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Order from catalogue
catalogueOrder
POST
Order discount
Retrieve the discount applied to a specific order.
Parameters
body
object (OrderDiscountRequest)
Enter currency and order amount
OrderDiscountRequest
order_amount
number
currency
string
Optional
Response
200
500
Success. Check example below or refer `OrderDiscountResponse` for more details.
OrderDiscountResponse
order_amount
number
Optional
points
number
Optional
discount
object (DiscountProperties)
Optional
DiscountProperties
base_discount
object (DiscountProperties)
Optional
DiscountProperties
applied_rule_bucket
object (OrderDiscountRuleBucket)
Optional
OrderDiscountRuleBucket
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.
Order discount
getOrderDiscount
Points
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
GET
Points history
Gets the historical data of points earned or spent by the user.
Parameters
pageId
string
Optional
PageID is the ID of the requested page. For first request it should be kept empty.
pageSize
integer
Optional
The number of items to retrieve in each page.
Response
200
500
Success. Check example below or refer `PointsHistoryResponse` for more details.
PointsHistoryResponse
items
array of object (PointsHistory)
Optional
History is the list of points transaction.
Array of PointsHistory
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Points history
getUserPointsHistory
GET
Current points
Retrieves the current reward points balance for the user.
Parameters
No Parameters
Response
200
500
Success. Check example below or refer `PointsResponse` for more details.
PointsResponse
points
number
Optional
Total points available
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Current points
getUserPoints
GET
Referral details
Gets the details of the user’s referral status and codes.
Parameters
No Parameters
Response
200
500
Success. Check example below or refer `ReferralDetailsResponse` for more details.
ReferralDetailsResponse
referral
object (Offer)
Optional
Offer
share
object (ShareMessages)
Optional
ShareMessages
user
object (ReferralDetailsUser)
Optional
ReferralDetailsUser
referrer_info
string
Optional
terms_conditions_link
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Referral details
getUserReferralDetails
POST
Redeem code
Applies a referral code to earn or redeem rewards.
Parameters
body
object (RedeemReferralCodeRequest)
RedeemReferralCodeRequest
device_id
string
Optional
referral_code
string
Optional
Response
200
500
Success. Check example below or refer `RedeemReferralCodeResponse` for more details.
RedeemReferralCodeResponse
redeemed
boolean
Optional
message
string
Optional
referrer_info
string
Optional
referrer_id
string
Optional
points
number
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Example response not available.