Skip to main content

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
/service/application/rewards/v1.0/offers/{name}/
# Get specific offer
POST
/service/application/rewards/v1.0/catalogue/offer/order/
# Order from catalogue
POST
/service/application/rewards/v1.0/user/offer/order-discount/
# Order discount
GET

Get specific offer

Retrieves detailed information about an offer by its name.
Parameters
name
string
Required
The name given to the offer.
Response
200
500
Success. Check example below or refer `Offer` for more details.
Offer
_schedule
object (Schedule)
Schedule
active
boolean
application_id
string
banner_image
object (Asset)
Asset
created_at
string
name
string
rule
object
share
object (ShareMessages)
ShareMessages
sub_text
string
text
string
type
string
updated_at
string
updated_by
string
url
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/rewards/v1.0/offers/{name}/
Loading...
Response
Example response not available.
POST

Order from catalogue

Place an reward on order items available in the catalogue.
Parameters
body
object (CatalogueOrderRequest)
Required
Enter article ID
CatalogueOrderRequest
articles
array of object (RewardsArticle)
Array of RewardsArticle
Response
200
500
Success. Check example below or refer `CatalogueOrderResponse` for more details.
CatalogueOrderResponse
articles
array of object (RewardsArticle)
Array of RewardsArticle
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/rewards/v1.0/catalogue/offer/order/
Loading...
Response
Example response not available.
POST

Order discount

Retrieve the discount applied to a specific order.
Parameters
body
object (OrderDiscountRequest)
Required
Enter currency and order amount
OrderDiscountRequest
order_amount
number
Required
currency
string
Response
200
500
Success. Check example below or refer `OrderDiscountResponse` for more details.
OrderDiscountResponse
order_amount
number
points
number
discount
object (DiscountProperties)
DiscountProperties
base_discount
object (DiscountProperties)
DiscountProperties
applied_rule_bucket
object (OrderDiscountRuleBucket)
OrderDiscountRuleBucket
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/rewards/v1.0/user/offer/order-discount/
Loading...
Response
Example response not available.

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
/service/application/rewards/v1.0/user/points/history/
# Points history
GET
/service/application/rewards/v1.0/user/points/
# Current points
GET
/service/application/rewards/v1.0/user/referral/
# Referral details
POST
/service/application/rewards/v1.0/user/referral/redeem/
# Redeem code
GET

Points history

Gets the historical data of points earned or spent by the user.
Parameters
pageId
string
PageID is the ID of the requested page. For first request it should be kept empty.
pageSize
integer
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)
History is the list of points transaction.
Array of PointsHistory
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/rewards/v1.0/user/points/history/
Loading...
Response
Example response not available.
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
Total points available
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/rewards/v1.0/user/points/
Loading...
Response
Example response not available.
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)
Offer
share
object (ShareMessages)
ShareMessages
user
object (ReferralDetailsUser)
ReferralDetailsUser
referrer_info
string
terms_conditions_link
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/rewards/v1.0/user/referral/
Loading...
Response
Example response not available.
POST

Redeem code

Applies a referral code to earn or redeem rewards.
Parameters
body
object (RedeemReferralCodeRequest)
Required
RedeemReferralCodeRequest
device_id
string
referral_code
string
Response
200
500
Success. Check example below or refer `RedeemReferralCodeResponse` for more details.
RedeemReferralCodeResponse
redeemed
boolean
message
string
referrer_info
string
referrer_id
string
points
number
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/rewards/v1.0/user/referral/redeem/
Loading...
Response
Example response not available.