Coupon Redemption
You can manually redeem coupons via the dashboard,
but this API allows you to automate the redemption process on your website when users apply a coupon — enabling efficient operations.
This API is available from the Personal plan.
Http Header
PUT /api/coupon/v1/redeem
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"cpnNo": "ZJLF0399WQBEQZJM",
"userId": "x77hu",
"memo": "IP Address: 210.123.111.222, Request Page: example.com/shop/bags/p112233"
}| Fields | Field Descriptions | Description | Required | Type |
|---|---|---|---|---|
| cpnNo | Coupon number | “Redeemed” coupon number to process. Enter only the coupon number, excluding the “-” sign. | string | |
| onsitePwd | On-site coupon usage password | If a password has been set for using on-site coupons, enter the set password. If the password is incorrect, you will not be able to use the coupon. | string | |
| userId | User ID | Used to manage who has issued coupons and who has redeemed them. If the value of Maximum coupon redemptions per person is between 2 and 5, then the user ID must be entered. Typically, you enter the login ID of the member who signed up for your website. | string | |
| memo | Notes | You can enter notes to manage coupon redemptions. Enter the user’s IP address, the page and service where the coupon was redeemed, and other information. When the maximum number of coupon redemptions per person is unlimited, you don’t know who redeemed the coupon, so you can manage by username or note. | string |
Response
{
"code": 0,
"message": "",
"result": null
}
| Fields | Description | Type |
|---|---|---|
| code | Response code (0:Success) | int |
| message | The response message, or a related message if the response code is non-zero. | string |