QueryAvailableCoupons

Function

Query member's available coupons.

Endpoint

• /v1/member-coupon/available

HTTP Method

• POST

Request Headers

• Authorization: Bearer {token}
• X-App-Key: {appKey}

Request Payload

{
  "pageNo": 1,
  "pageSize": 10,
  "memberId": "xxx"
}

Request Parameters

Field	Required	Type	Remark	Sample
pageNo	No	integer	Pagination page number, 0 represents the first page	1
pageSize	No	integer	Number of entries per page, maximum 200	10
memberId	Yes	string	memberId	xxx

Response Payload

{
  "status": 1,
  "errorCode": 0,
  "message": "success",
  "morePage":true,
  "pageNo": 1,
  "pageSize": 1,
  "items": [
    {
      "couponId": "xxxxx",
      "couponNameEn": "Coupon Name（EN）",
      "couponNameSc": "Coupon Name（SC）",
      "couponNameTc": "Coupon Name（TC）",
      "couponType": "Cash",
      "iconUrl": "",
      "usageEffectiveTime": "2024-01-01T00:00:00+08:00",
      "usageExpirationTime": "2024-01-01T23:59:59+08:00",
      "redemptionCode": "xxxx"
    }
  ]
}

Response Parameters

Field	Required	Type	Remark	Sample
status	Yes	string	status code of the api call
message	Yes	string	detail message of the api call
errorCode	No	string
morePage	No	boolean	Whether has more page. If this value is true, you may want to continue to check next page	true
pageNo	Yes	integer	Pagination page number, 0 represents the first page	1
pageSize	Yes	integer	Number of entries per page, maximum 200	10
items	Yes	object[]
couponId	No	string
couponNameEn	No	string	Coupon Name（EN）
couponNameSc	No	string	Coupon Name（SC）
couponNameTc	No	string	Coupon Name（TC）
couponType	Yes	string	Coupon Type: Cash(FixedValue)、 Exchange、 FreeParking、 KTSPPoints	Cash
iconUrl	No	string	Icon Url
usageEffectiveTime	No	string	Effective Time
usageExpirationTime	No	string	Expiration Time
redemptionCode	No	string	Code of the redemption	xxx

Response Headers

Error Codes

Code	Description
1	Internal Error
3	Missing Parameter
4100	Member not found