Get Voucher Batches

{% raw %}

GET/v3/voucher-batches

Method : GET
Url : https://open.revenuemonster.my/v3/voucher-batches
Sandbox Url : https://sb-open.revenuemonster.my/v3/voucher-batches

To get multiple voucher batches.

Request Parameters

No request parameter is required for this endpoint.

Response Parameters

items[]Object

Voucher object array

Example: (Refer to explanation below)

codeString

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

Example: "SUCCESS"

Voucher object (items):

idString

Voucher ID

Example: “6544507929221794245"

keyString

Vocher Key

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIVCgdWb3VjaGVyGgpOQWtsRWZiVmRW"

labelString

label of voucher for merchant remarks

Example: "Free Breakfast”

typeString

Define type of vouchers: DISCOUNT, GIFT, “CASH"

Example: “GIFT"

amountUint

Required if type = CASH, notation in cents, eg. RM 1.00 = 100

Example: 10000

discountRateUint

Required if type = DISCOUNT, notation without decimals, eg. 1% = 100

Example: 0

minimumSpendAmountUint

Minimum spend amount

Example: 0

imageUrlString

Image URL of current voucher, optional

Example: Image Url link (refer to below code)

quantityUint

Total quantity of voucher(s) in this batch

Example: 1

balanceQuantityUint

Total quantity of voucher(s) remaining in this batch

Example: 0

usedQuantityUint

Total quantity of voucher(s) used/assigned/redeemed in this batch

Example: 1

statusString

Voucher's status

Example: "COMPLETED"

expiryObject of Expiry

Expiry date time of current voucher

Example: (Refer below)

originString

SYSTEM (voucher code generated from RM server), SELF (voucher code uploaded from merchant csv file)

Example: “SYSTEM”

isShippingBoolean

True if items/goods to be delivered physically to customers

Example: false

reasonString

Will show if voucher batch is fail during creation. Optional.

Example: ”"

staticCodeString

Voucher's code

Example: "ABC123"

isDeviceRedeemBoolean

TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.

Example: false

createdAtDateTime

Date time of voucher being created (UTC)

Example: "2018-06-21T11:08:00Z"

updatedAtDateTime

Date time of voucher being updated (UTC)

Example: "2018-09-28T17:19:44.686549977Z"

{% endraw %}