CampaignCouponList

Function

Get a list of campaign coupon

Endpoint

• /v1/coupon/campaign/list

HTTP Method

• POST

Request Headers

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

Request Payload

{
  "pageNo": 1,
  "pageSize": 10,
  "channelType": "APP_REDEMPTION"
}

Request Parameters

Field	Required	Type	Remark	Sample
pageNo	No	integer	Pagination page number, 0 represents the first page	1
pageSize	No	number	Number of entries per page, maximum 200	10
channelType	Yes	string	Channel Type: GC_PAGE、APP_REDEMPTION	APP_REDEMPTION
couponType	No	string	Coupon Type	Cash
isFeatured	No	number	isFeatured, 0:NonFeatured, 1:Featured	1

Response Payload

{
  "status": 1,
  "errorCode": 0,
  "message": "success",
  "morePage":true,
  "pageNo": 1,
  "pageSize": 1,
  "items": [
    {
      "campaignId": "1",
      "campaignName": "Name",
      "campaignStatus": "Active",
      "effectiveDate": "2024-01-01",
      "expirationDate": "2024-02-28",
      "requiredPoints":0,
      "coupons": [
        {
          "couponId": "couponId",
          "couponNameEn": "Coupon Name（EN）",
          "couponNameSc": "Coupon Name（SC）",
          "couponNameTc": "Coupon Name（TC）",
          "couponType": "Cash",
          "couponStatus": "Active",
          "iconUrl": "https://xxx",
          "campaignStock": 10
        }
      ],
      "isFeatured": 1,
      "label": "Featured"
    }
  ]
}

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[]
campaignId	No	string	Campaign Id
couponName	No	string	Campaign Name
campaignStatus	No	string	Campaign Status: Active 、 Inactive	Active
effectiveDate	No	string	Effective Date
expirationDate	No	string	Expiration Date
requiredPoints	No	number	required Points	0
coupons	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
. couponStatus	No	string	Coupon Status: Active 、 Inactive	Active
. iconUrl	No	string	Icon Url
. campaignStock	No	number	Campaign Stock Value	10
isFeatured	No	number	isFeatured, 0:NonFeatured， 1:Featured	1
label	No	string	label: Featured、 Limited	Featured

Response Headers

Error Codes

Code	Description
1	Internal Error
3	Missing Parameter
4	Invalid Input