Get Vouchers

GET/v3/loyalty/me/vouchers

• Using Query String to Get Vouchers by input the country code and phone number
• Using Query String to set a limit: ~/?limit=< limit >
• To implement a pagination cursor, you may use query string: ~/?cursor= < cursor >
• Example : https://open.revenuemonster.my/v3/loyalty/me/vouchers?countryCode=60&phoneNumber=187824152&limit=100&cursor=asdas

Request Parameters

Response Parameters

itemsArray

Vouchers object

Example: (Refer to explanation below)

codeString

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"

metaObject

Inside meta have count key example "count": 2

Example: 2

Vouchers object (item):

keyString

Voucher Key (Internal Usage)

Example: "EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY"

labelString

Voucher Label

Example: "asdasd"

voucherBatchKeyString

Voucher Batch Key

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQs4n7iuzioaQW"

typeString

Voucher Type ("CASH", "DISCOUNT", "GIFT")

Example: "CASH"

amountUint

Amount of the voucher

Example: 100

discountRateUint

Voucher Discount Rate

Example: 0

minimumSpendAmountUint

Set a Minimum Spend Amount

Example: 0

originString

Origin is for determine voucher source ("SYSTEM", "SELF", "MARKETPLACE")

Example: "SYSTEM"

imageUrlString

Voucher Image

Example: ""

memberProfileObject

Member Profile (refer to profile page)

Example: null

assignedAtDateTime

Voucher Assign

Example: "0001-01-01T00:00:00Z"

payloadObject

Refer to explanation below

Example: (Refer to explanation below)

qrUrlString

Voucher QRcode URL

Example: ""

codeString

Voucher Code

Example: "xR43u4bRhUU"

isShippingBool

Voucher Shipping

Example: false

addressObject

Refer to explanation below

Example: (Refer to explanation below)

expiryObject

Refer to explanation below

Example: (Refer to explanation below)

usedAtDateTime

Voucher Use

Example: "2020-11-25T13:58:55+08:00"

redeemedAtDateTime

Voucher Redeem

Example: "2020-11-25T04:33:04Z"

isDeviceRedeemBool

Voucher Redeem Device

Example: true

statusString

Voucher Status ("VALID", "ISSUE", "REDEEMED", "VOID", "EXPIRED", "MARKET_PLACE")

Example: "VOID"

voucherComboKeyString

Voucher Combo Key

Example: null

isMarketPlaceBool

Voucher is in Market Place ?

Example: false

createdAtDateTime

Create date time

Example: "2020-11-18T06:43:19Z"

updatedAtDateTime

Last update date time

Example: "2020-11-25T05:58:56Z"

Payload object:

tncArray

Example: ["T&C"]

contactInfoObject

Refer to explanation below

Example: (Refer to explanation below)

Expiry object:

typeString

Voucher Type ("DYNAMIC" , "STATIC")

Example: "DYNAMIC"

dayUint

Expired Day

Example: 1

expiredAtDateTime

Voucher Expired

Example: "2020-11-26T04:33:04Z"

Address object:

addressLine1String

Address 1

Example: ""

addressLine2String

Address 2

Example: ""

postcodeString

Postcode

Example: ""

cityString

City

Example: ""

stateString

State

Example: ""

countryString

Country

Example: ""