selected title

On this page
Rewards SDK Methods
Method Method detail
getCoupons() Used to fetch the list of all available coupons.
getMyCoupons() Used to fetch the list of logged-in user’s coupons
getPointsCoupons() Used to fetch the list of logged-in user’s coupons.
redeemCoupon() Used to redeem any particular coupon.
  • To Fetch List of all available coupons
    API Class : RewardsInteractor
    Method : getCoupons()
    Used to fetch the list of all available coupons.
    API Request:
    • Request Object : RewardsParams
    • Parameters
    • limit: How many coupons you want in a single response
    • offset: it's the current page/offset
    API Response:
    • Response Object : HomeFeed
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data: It returns list of coupons
    • PerPage : it return current page
    • Total : It returns the total number of coupons available
  • To Fetch List of logged-in user’s coupons
    API Class : RewardsInteractor
    Method : getMyCoupons()
    Used to fetch the list of logged-in user’s coupons.
    API Request:
    • Request Object : RewardsParams
    • Parameters
    • limit: How many coupons you want in a single response
    • offset: it's the current page/offset
    API Response:
    • Response Object : HomeFeed
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data: It returns list of coupons
    • PerPage : it return current page
    • Total : It returns the total number of coupons available
  • To Fetch points history of the logged-in user
    API Class : RewardsInteractor
    Method : getPointsCoupons()
    Used to fetch the list of logged-in user’s coupons.
    API Request:
    • Request Object : RewardsParams
    • Parameters
    • limit: How many coupons you want in a single response
    • offset: it's the current page/offset
    API Response:
    • Response Object : HomeFeed
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data: It returns all historical data of points for the logged-in user
    • PerPage : it return current page
    • Total : It returns the total number of records available
  • To redeem any coupon
    API Class : RewardsInteractor
    Method : redeemCoupon()
    Used to redeem any particular coupon.
    API Request:
    • Request Object : String
    • Parameters
    • couponId: its the coupon id to be redeemed.
    API Response:
    • Response Object : GetCouponCode
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data: It returns data of the successfully redeemed coupon