Get Voucher Batches

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

note

To get multiple voucher batches.

Request Parameters

note

No request parameter is required for this endpoint.

Response Parameters

Parameter	Type	Description	Example
items	[]Object	Voucher object array	(Refer to explanation below)
code	String	Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)	"SUCCESS"

Voucher object (items):

Parameter	Type	Description	Example
id	String	Voucher ID	“6544507929221794245"
key	String	Vocher Key	"EhQKCE1lcmNoYW50EJXVzd3wraq TORIVCgdWb3VjaGVyGgp OQWtsRWZiVmRW"
label	String	label of voucher for merchant remarks	"Free Breakfast”
type	String	Define type of vouchers: DISCOUNT, GIFT, “CASH"	“GIFT"
amount	Uint	Required if type = CASH, notation in cents, eg. RM 1.00 = 100	10000
discountRate	Uint	Required if type = DISCOUNT, notation without decimals, eg. 1% = 100	0
minimumSpendAmount	Uint	Minimum spend amount	0
imageUrl	String	Image URL of current voucher, optional	Image Url link (refer to below code)
quantity	Uint	Total quantity of voucher(s) in this batch	1
balanceQuantity	Uint	Total quantity of voucher(s) remaining in this batch	0
usedQuantity	Uint	Total quantity of voucher(s) used/assigned/redeemed in this batch	1
status	String	Voucher's status	"COMPLETED"
expiry	Object of Expiry	Expiry date time of current voucher	(Refer below)
origin	String	SYSTEM (voucher code generated from RM server), SELF (voucher code uploaded from merchant csv file)	“SYSTEM”
isShipping	Boolean	True if items/goods to be delivered physically to customers	false
reason	String	Will show if voucher batch is fail during creation. Optional.	”"
staticCode	String	Voucher's code	"ABC123"
isDeviceRedeem	Boolean	TRUE means only can be redeemed through merchant app. FALSE means customer can do redemption from own loyalty app.	false
createdAt	DateTime	Date time of voucher being created (UTC)	"2018-06-21T11:08:00Z"
updatedAt	DateTime	Date time of voucher being updated (UTC)	"2018-09-28T17:19:44.686549977Z"

Example Response

{
  "items": [
    {
      "id": "6544507929221794245",
      "key": "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQxZP495jpsOla",
      "label": "Shell Voucher",
      "type": "CASH",
      "amount": 10000,
      "discountRate": 0,
      "imageUrl": "https://storage.googleapis.com/rm-sandbox-merchant/4118165203679668885/gallery/1d2721426e06da4b2b459446135da29e.jpeg",
      "quantity": 1,
      "balanceQuantity": 0,
      "usedQuantity": 1,
      "status": "COMPLETED",
      "expiry": {
        "type": "DYNAMIC",
        "day": 1,
        "expiredAt": "2050-12-31T23:59:59Z"
      },
      "origin": "SYSTEM",
      "isShipping": false,
      "reason": "",
      "isDeviceRedeem": true,
      "createdAt": "2018-09-21T07:12:31Z",
      "updatedAt": "2018-09-26T07:15:54Z"
    },
    {
      "id": "8223209398981211509",
      "key": "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQ9eq2n5SsrY9y",
      "label": "Wedding",
      "type": "GIFT",
      "discountRate": 0,
      "imageUrl": "https://storage.googleapis.com/rm-sandbox-merchant/4118165203679668885/gallery/1d2721426e06da4b2b459446135da29e.jpeg",
      "quantity": 2,
      "balanceQuantity": 0,
      "usedQuantity": 0,
      "status": "COMPLETED",
      "expiry": {
        "type": "DYNAMIC",
        "day": 1,
        "expiredAt": "2050-12-31T23:59:59Z"
      },
      "origin": "SYSTEM",
      "isShipping": false,
      "reason": "",
      "isDeviceRedeem": false,
      "createdAt": "2018-09-19T03:41:54Z",
      "updatedAt": "2018-09-19T03:41:54Z"
    },
    {
      "id": "1626310995848872959",
      "key": "EhQKCE1lcmNoYW50EJXVzd3wraqTORIYCgxWb3VjaGVyQmF0Y2gQ_4eJj7-n9MgW",
      "label": "ALA10OFF",
      "type": "DISCOUNT",
      "discountRate": 1000,
      "minimumSpendAmount": 100,
      "imageUrl": "https://storage.googleapis.com/rm-sandbox-merchant/4118165203679668885/gallery/f03508e50866abd615fc65c63857858f.jpeg",
      "quantity": 50,
      "balanceQuantity": 48,
      "usedQuantity": 2,
      "status": "COMPLETED",
      "expiry": {
        "type": "DYNAMIC",
        "day": 1,
        "expiredAt": "2050-12-31T23:59:59Z"
      },
      "origin": "SYSTEM",
      "isShipping": false,
      "isStatic": true,
      "staticCode": "ALA10OFF",
      "isDeviceRedeem": true,
      "source": "",
      "sourceType": "",
      "sourcePrefix": "",
      "isMarketPlace": false,
      "createdAt": "2021-07-15T01:03:15Z",
      "updatedAt": "2021-07-15T01:53:38Z"
   }
  ],
  "code": "SUCCESS",
  "meta": {
    "count": 3
  }
}