Skip to content

Latest commit

 

History

History
938 lines (553 loc) · 18.2 KB

REWARDS.md

File metadata and controls

938 lines (553 loc) · 18.2 KB
Raw
Back to Application docs

Rewards Methods

Earn and redeem reward points

Methods with example and description

getOfferByName

Get offer by name

applicationClient.rewards.getOfferByName(name: name) { (response, error) in
    // Use response
}
Argument Type Required Description
name String yes The name given to the offer.

Use this API to get fetch the specific offer details and configuration by the name of the offer.

Returned Response:

Offer

Success. Check example below or refer Offer for more details.

  Examples:
  Success 
{
  "value": {
    "_id": "63bfb9c1195d62ac089641cd",
    "application_id": "5d5c304a4df829372e2ad6d1",
    "name": "order",
    "_schedule": {},
    "active": true,
    "banner_image": {
      "aspect_ratio": "2:1",
      "secure_url": "https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/dbY4bHh9d-reward-banner.png"
    },
    "created_at": "2023-01-12T07:41:53.356Z",
    "display": {
      "validity": 1000,
      "validity_unit": "hours"
    },
    "info_action": {
      "type": "",
      "page": {
        "type": "",
        "params": {
          "slug": null
        },
        "url": ""
      }
    },
    "rule": {
      "claimed": true,
      "value": 10,
      "value_type": "percent",
      "validity": 60000
    },
    "share": {
      "default": "Hey, join me on {{application_name}} and get exciting offers and reward points. Signup today and quickly earn Rs.{{offer_amount}}. Visit {{offer_link}} now!",
      "text": ""
    },
    "sub_text": "Purchase and get reward points",
    "text": "Order & Earn",
    "type": "earn",
    "updated_at": "2023-01-12T15:46:04.854Z",
    "updated_by": "6678589f5d0df704c9996644",
    "url": ""
  }
}

catalogueOrder

Get all transactions of reward points

applicationClient.rewards.catalogueOrder(body: body) { (response, error) in
    // Use response
}
Argument Type Required Description
body CatalogueOrderRequest yes Request body

Use this API to evaluate the amount of reward points that could be earned on any catalogue product.

Returned Response:

CatalogueOrderResponse

Success. Check example below or refer CatalogueOrderResponse for more details.

  Examples:
  Success 
{
  "value": {
    "articles": [
      {
        "id": "qwer",
        "price": 2356,
        "points": 1000
      }
    ]
  }
}

getUserPointsHistory

Get all transactions of reward points

applicationClient.rewards.getUserPointsHistory(pageId: pageId, pageSize: pageSize) { (response, error) in
    // Use response
}
Argument Type Required Description
pageId String? no PageID is the ID of the requested page. For first request it should be kept empty.
pageSize Int? no The number of items to retrieve in each page.

Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.

Returned Response:

PointsHistoryResponse

Success. Check example below or refer PointsHistoryResponse for more details.

  Examples:
  Success 
{
  "value": {
    "items": [
      {
        "_id": "6464a9eb70e0debb8462667d",
        "application_id": "000000000000000000000001",
        "user_id": "000000000000000009802478",
        "points": 500,
        "remaining_points": 500,
        "txn_name": "signup_credit",
        "claimed": true,
        "expires_on": "2023-06-14T10:18:19.118Z",
        "meta": {
          "offer_id": "630e0b8e349f3f1cfbec572f"
        },
        "created_at": "2023-05-17T10:18:19.118Z",
        "updated_at": "2023-05-17T10:18:19.118Z",
        "text_1": "Signup points",
        "text_2": "Additional Points",
        "text_3": "Will expire on 3:48 PM, 14 Jun'23"
      },
      {
        "_id": "6464a9d370e0debb84626677",
        "application_id": "000000000000000000000001",
        "user_id": "000000000000000009802478",
        "points": 500,
        "remaining_points": 500,
        "txn_name": "signup_credit",
        "claimed": true,
        "expires_on": "2023-06-14T10:17:55.588Z",
        "meta": {
          "offer_id": "630e0b8e349f3f1cfbec572f"
        },
        "created_at": "2023-05-17T10:17:55.588Z",
        "updated_at": "2023-05-17T10:17:55.588Z",
        "text_1": "Signup points",
        "text_2": "Additional Points",
        "text_3": "Will expire on 3:47 PM, 14 Jun'23"
      }
    ],
    "page": {
      "current": 0,
      "item_total": 2,
      "type": "cursor",
      "size": 1,
      "has_previous": true,
      "has_next": false,
      "next_id": ""
    }
  }
}

getUserPoints

Get total available points of a user

applicationClient.rewards.getUserPoints() { (response, error) in
    // Use response
}

Use this API to retrieve total available points of a user for current application.

Returned Response:

PointsResponse

Success. Check example below or refer PointsResponse for more details.

  Examples:
  Success 
{
  "value": {
    "points": 100
  }
}

getUserReferralDetails

Get referral details of a user

applicationClient.rewards.getUserReferralDetails() { (response, error) in
    // Use response
}

Use this API to retrieve the referral details like referral code of a user.

Returned Response:

ReferralDetailsResponse

Success. Check example below or refer ReferralDetailsResponse for more details.

  Examples:
  Success 
{
  "value": {
    "referral": {
      "_id": "6325b07224c4f10f7ca2ef0b",
      "application_id": "000000000000000000000001",
      "name": "referral",
      "_schedule": {
        "start": "2020-01-27T20:07:27.418Z",
        "end": "2030-01-27T18:30:00.000Z"
      },
      "active": true,
      "banner_image": {
        "secure_url": "https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/rewards/pictures/landscape-banner/original/05ZGi_YkI-reward-banner.png",
        "aspect_ratio": "2:1"
      },
      "created_at": "2022-09-17T11:33:06.862Z",
      "display": {
        "validity": 4,
        "validity_unit": "weeks"
      },
      "info_action": {
        "type": "",
        "page": {
          "type": "",
          "params": {
            "slug": null
          },
          "url": ""
        }
      },
      "rule": {
        "amount": 100,
        "referrer_amount": 200,
        "amount_validity": 40320,
        "threshold": 10000,
        "counter": 0
      },
      "share": {
        "default": "",
        "text": "👋 Hey there!\n\nI just gave you 100 points.\n\nShop from brands like Campus Sutra, Snitch, Freakins, Off Duty, and other streetwear and athleisure brands\n\n10 GoFynd points = ₹1 off on your next order.\n\nLet me break it down for you: Every 10 GoFynd Points you have will get you a ₹1 discount on your transaction. So, for example, if you have 1000 GoFynd Points, you can enjoy a fabulous ₹100 off during checkout.\n\nJoin me on GoFynd and signup using my code E4WZC5\n\nVisit Now: https://www.fynd.com/l/E4WZC5"
      },
      "sub_text": "When your friends sign up using your referral code.\n\nYou get ₹200 and They get ₹100",
      "text": "Refer & Earn",
      "type": "earn",
      "updated_at": "2023-05-22T13:59:28.295Z",
      "updated_by": "b360c46c3f5c939dadf8f9ab",
      "url": "",
      "updated_by_name": "jaykaria_gofynd_com_39144"
    },
    "share": {
      "default": "",
      "text": "👋 Hey there!\n\nI just gave you 100 points.\n\nShop from brands like Campus Sutra, Snitch, Freakins, Off Duty, and other streetwear and athleisure brands\n\n10 GoFynd points = ₹1 off on your next order.\n\nLet me break it down for you: Every 10 GoFynd Points you have will get you a ₹1 discount on your transaction. So, for example, if you have 1000 GoFynd Points, you can enjoy a fabulous ₹100 off during checkout.\n\nJoin me on GoFynd and signup using my code E4WZC5\n\nVisit Now: https://www.fynd.com/l/E4WZC5"
    },
    "referrer_info": "Code redeemed",
    "user": {
      "blocked": false,
      "referral_code": "E4WZC5",
      "redeemed": true
    },
    "terms_conditions_link": "https://fynd.freshdesk.com/support/solutions/folders/33000111619"
  }
}

getOrderDiscount

Calculates the discount on order-amount

applicationClient.rewards.getOrderDiscount(body: body) { (response, error) in
    // Use response
}
Argument Type Required Description
body OrderDiscountRequest yes Request body

Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer.

Returned Response:

OrderDiscountResponse

Success. Check example below or refer OrderDiscountResponse for more details.

  Examples:
  Success 
{
  "value": {
    "order_amount": 3000,
    "discount": {
      "absolute": 0,
      "currency": "INR",
      "percent": 0,
      "display_absoulte": "0.00",
      "display_percent": "0%"
    },
    "base_discount": {
      "absolute": 0,
      "currency": "INR",
      "percent": 0,
      "display_absoulte": "0.00",
      "display_percent": "0"
    },
    "points": 0,
    "applied_rule_bucket": {
      "low": 1,
      "high": -1,
      "max": 1000,
      "value": 10,
      "value_type": "percent"
    }
  }
}

redeemReferralCode

Redeems a referral code and credits reward points to referee and the referrer as per the configuration

applicationClient.rewards.redeemReferralCode(body: body) { (response, error) in
    // Use response
}
Argument Type Required Description
body RedeemReferralCodeRequest yes Request body

Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.

Returned Response:

RedeemReferralCodeResponse

Success. Check example below or refer RedeemReferralCodeResponse for more details.

  Examples:
  Success 
{
  "value": {
    "redeemed": true,
    "message": "Successfully redeemed referral code",
    "referrer_info": "Referred by Abhinav Maurya",
    "referrer_id": "600693a01faf8695d70a15df",
    "points": 100
  }
}

Schemas

RewardsArticle

Properties Type Nullable Description
id String? yes
points Double? yes
price Double? yes

CatalogueOrderResponse

Properties Type Nullable Description
articles [RewardsArticle]? yes

CatalogueOrderRequest

Properties Type Nullable Description
articles [RewardsArticle]? yes

PointsResponse

Properties Type Nullable Description
points Double? yes Total points available

ReferralDetailsUser

Properties Type Nullable Description
blocked Bool? yes
points Double? yes
redeemed Bool? yes
referralCode String? yes

Offer

Properties Type Nullable Description
schedule Schedule? yes
active Bool? yes
applicationId String? yes
bannerImage Asset? yes
createdAt String? yes
name String? yes
rule [String: Any]? yes
share ShareMessages? yes
subText String? yes
text String? yes
type String? yes
updatedAt String? yes
updatedBy String? yes
url String? yes

Schedule

Properties Type Nullable Description
duration Int? yes
end String? yes
start String? yes
cron String? yes

Error

Properties Type Nullable Description
code Int? yes
exception String? yes
info String? yes
message String? yes

Asset

Properties Type Nullable Description
aspectRatio String? yes
id String? yes
secureUrl String? yes

ShareMessages

Properties Type Nullable Description
email Int? yes
facebook String? yes
fallback String? yes
message String? yes
messenger String? yes
sms String? yes
text String? yes
twitter String? yes
whatsapp String? yes

ReferralDetailsResponse

Properties Type Nullable Description
referral Offer? yes
share ShareMessages? yes
user ReferralDetailsUser? yes
referrerInfo String? yes
termsConditionsLink String? yes

OrderDiscountRequest

Properties Type Nullable Description
orderAmount Double no
currency String? yes

OrderDiscountRuleBucket

Properties Type Nullable Description
high Double? yes
low Double? yes
max Double? yes
value Double? yes
valueType String? yes

DiscountProperties

Properties Type Nullable Description
absolute Double? yes
currency String? yes
displayAbsolute String? yes
displayPercent String? yes
percent Double? yes

OrderDiscountResponse

Properties Type Nullable Description
orderAmount Double? yes
points Double? yes
discount DiscountProperties? yes
baseDiscount DiscountProperties? yes
appliedRuleBucket OrderDiscountRuleBucket? yes

RedeemReferralCodeRequest

Properties Type Nullable Description
deviceId String? yes
referralCode String? yes

RedeemReferralCodeResponse

Properties Type Nullable Description
redeemed Bool? yes
message String? yes
referrerInfo String? yes
referrerId String? yes
points Double? yes

PointsHistoryResponse

Properties Type Nullable Description
items [PointsHistory]? yes History is the list of points transaction.
page Page? yes

PointsHistory

Properties Type Nullable Description
id String? yes
applicationId String? yes
claimed Bool? yes
createdAt String? yes
expiresOn String? yes
meta [String: Any]? yes
points Double? yes
remainingPoints Double? yes
text1 String? yes
text2 String? yes
text3 String? yes
txnName String? yes
updatedAt String? yes
userId String? yes

Page

Properties Type Nullable Description
current Int? yes
hasNext Bool? yes
hasPrevious Bool? yes
itemTotal Int? yes
nextId String? yes
size Int? yes
type String? yes