Coupon Redemption

This API marks an issued coupon as used.

Instead of handling it manually in the dashboard, you can automatically mark issued coupons as used through the API.

This API is available for Personal plans and above.

PUT

/api/coupon/v1/redeem 

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "userId": "x77hu",
    "memo": "IP Address: 210.123.111.222, Request Page: https://example.com/shop/bags/p112233"
}

Request Parameters

cpnNo string required
Coupon number.
onsitePwd string
On-site coupon password. Required if a password is set for the on-site coupon.
userId string
User ID. An identifier for the coupon issuer/user.
Must be provided if the coupon usage limit is set to 2–5.
memo string
Internal reference note. Can be used to record user IP, coupon usage location, or other details.
If coupon usage is unlimited, you can use this field instead of userId to distinguish users. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result null