Skip to main content

Rewards

Manages customer rewards programs, including earning and redeeming rewards points.

Customer

Customer encompasses reward specific details such as referral codes, available reward points, reward points history, and to block users from participating in future rewards programs. A referral code is a unique code associated with each user.

Operations
PATCH
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/
# Update user status
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/
# Get a user
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/points/history/
# Get reward user points history
PATCH

Update user status

Change and update the status of a user in the rewards system.
Parameters
userId
string
user id
body
object (AppUser)
UpdateUserStatus
AppUser
_id
string
Optional
active
boolean
Optional
application_id
string
Optional
block_reason
string
Optional
updated_at
string
Optional
updated_by
string
Optional
user_id
string
Optional
Response
200
400
Success
AppUser
_id
string
Optional
active
boolean
Optional
application_id
string
Optional
block_reason
string
Optional
updated_at
string
Optional
updated_by
string
Optional
user_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/
Loading...
Response
Example response not available.
GET

Get a user

Retrieve comprehensive details about a user in the rewards program.
Parameters
userId
string
user id
Response
200
400
Success. Check example below or refer `UserRes` for more details.
UserRes
points
object (Points)
Optional
Points
user
object (RewardUser)
Optional
RewardUser
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/
Loading...
Response
Example response not available.
GET

Get reward user points history

Retrieve the history of points earned and redeemed by a user.
Parameters
userId
string
user id
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 `HistoryRes` for more details.
HistoryRes
items
array of object (PointsHistory)
Optional
History is the list of points transaction.
Array of PointsHistory
page
object (Page)
Optional
Page
points
number
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/points/history/
Loading...
Response
Example response not available.

Giveaways

Award Reward Points to many users at once using Giveaways, helping to engage customers, boost sales and build loyalty. Giveaways can be distributed immediately or can be scheduled for a later date, For example, awarding lakhs of customers (known as audience) with 500 reward points on the occasion of the Christmas Festival to boost sales.

Operations
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways
# List giveaways
POST
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways
# Create a giveaway
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways/{id}
# Get a giveaway
PUT
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways/{id}
# Update a giveaway
GET

List giveaways

Retrieve and display available giveaways.
Parameters
pageId
string
pagination page id
pageSize
integer
pagination page size
Response
200
400
ok
GiveawayResponse
items
array of object (Giveaway)
Optional
Array of Giveaway
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways
Loading...
Response
Example response not available.
POST

Create a giveaway

Store and manage details of a giveaway.
Parameters
body
object (Giveaway)
Add Giveaway
Giveaway
_id
string
Optional
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
audience
object (RewardsAudience)
Optional
RewardsAudience
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
description
string
Optional
name
string
Optional
rule
object (RewardsRule)
Optional
RewardsRule
title
string
Optional
updated_at
string
Optional
Response
200
400
ok
Giveaway
_id
string
Optional
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
audience
object (RewardsAudience)
Optional
RewardsAudience
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
description
string
Optional
name
string
Optional
rule
object (RewardsRule)
Optional
RewardsRule
title
string
Optional
updated_at
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways
Loading...
Response
Example response not available.
GET

Get a giveaway

Retrieve specific giveaway details by its unique identifier.
Parameters
id
string
Giveaway ID
Response
200
400
ok
Giveaway
_id
string
Optional
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
audience
object (RewardsAudience)
Optional
RewardsAudience
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
description
string
Optional
name
string
Optional
rule
object (RewardsRule)
Optional
RewardsRule
title
string
Optional
updated_at
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways/{id}
Loading...
Response
Example response not available.
PUT

Update a giveaway

Modify and update information about a giveaway.
Parameters
id
string
Giveaway ID
body
object (Giveaway)
Update Giveaway Request
Giveaway
_id
string
Optional
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
audience
object (RewardsAudience)
Optional
RewardsAudience
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
description
string
Optional
name
string
Optional
rule
object (RewardsRule)
Optional
RewardsRule
title
string
Optional
updated_at
string
Optional
Response
200
400
ok
Giveaway
_id
string
Optional
_schedule
object (Schedule)
Optional
Schedule
active
boolean
Optional
application_id
string
Optional
audience
object (RewardsAudience)
Optional
RewardsAudience
banner_image
object (Asset)
Optional
Asset
created_at
string
Optional
description
string
Optional
name
string
Optional
rule
object (RewardsRule)
Optional
RewardsRule
title
string
Optional
updated_at
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/giveaways/{id}
Loading...
Response
Example response not available.

Offers

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" This enables you to oversee various types of offers provided on the Fynd Platform. For instance, if the Sign Up offer is activated and set to provide 500 reward points for 30 days: When a new user signs up, 500 reward points will be credited to their account, valid for 30 days.

Operations
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/
# List offers
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/{name}/
# Get offer by name
PUT
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/{name}/
# Update offer by name
GET

List offers

Display available offers for users.
Parameters
No Parameters
Response
200
400
ok
Array of 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
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/
Loading...
Response
Example response not available.
GET

Get offer by name

Retrieve 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
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/{name}/
Loading...
Response
Example response not available.
PUT

Update offer by name

Modify and manage an offer using its name.
Parameters
name
string
The name given to the offer.
body
object (Offer)
Update Offers Request
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
Response
200
400
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?
PUT
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/offers/{name}/
Loading...
Response
Example response not available.

Rewards Configuration

You can employ this tool to establish the package name for the mobile application and link the Terms & Conditions for the rewards. Various validations are executed to check the validity of referral code. Rewards system will fail to redeem the referral code for invalid package name.

Operations
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/configuration/
# Get rewards configuration
POST
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/configuration/
# Set rewards configuration
GET

Get rewards configuration

Retrieve the configuration settings for the rewards program.
Parameters
No Parameters
Response
200
500
Success. Refer `ConfigurationRes` for more details.
ConfigurationRes
valid_android_packages
array of string
Optional
Contains array of string items, Valid android package names.
terms_conditions_link
string
Optional
A URL that redirects to the referral information suport page link
application_id
string
Optional
success
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/configuration/
Loading...
Response
Example response not available.
POST

Set rewards configuration

Configure and modify the settings for the rewards program.
Parameters
body
object (ConfigurationRequest)
Upsert Android paths
ConfigurationRequest
valid_android_packages
array of string
Optional
terms_conditions_link
string
Optional
Response
200
400
ok
SetConfigurationRes
success
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/rewards/v1.0/company/{company_id}/application/{application_id}/configuration/
Loading...
Response
Example response not available.