API Documentation

Get Purchased Rewards for User in Connected Orgs

get
https://{host}/v1.1/user/user_rewards?username=&mobile=
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Query Params
string

Mobile number/email/externalId of the customer to fetch rewards.

string

till id used in the authorization of the request

string
enum
Defaults to en

Filters the response based on the reward language. Use this parameter to retrieve rewards in a specific language. For example, to display rewards in English, set the parameter to en

Allowed:
string
enum

Pass asc to order the results in ascending order of sortBy value, desc to order in descending order.

Allowed:
string
enum

Sort the results by a specific parameter. Possible Value (column names in User Rewards table) : "createdOn" "rewardId"

Allowed:
int32

To retrieve details of a specific page. Pass 0 to not apply pagination. For example, page=2&size=10 shows 10 results of page 2.

int64

Results to show per page. Default - 100

string
enum

filter to be used to fetch specific type of rewards instead of all, possible values:- Intouch_Reward, Vendor_Intouch_Reward, Vendor_Only_Reward, Cart_Promotion

Allowed:
int64

filter to be used to fetch rewards by fetching the info based on given inputs like fromPurchaseDate and toPurchaseDate which can serve multiple purpose like Filter rewards by Purchase date : Last 30 days ( from ā†’ last 30 days date, to-> todays date in epoch time)

int64

filter to be used to fetch rewards by fetching the info based on given inputs like fromPurchaseDate and toPurchaseDate which can serve multiple purpose like Filter rewards by Purchase date : Last 30 days ( from ā†’ last 30 days date, to-> todays date in epoch time)

Responses

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago