ClaimCampaignCoupon
Function
claim campaign coupon
Endpoint
- /v1/member-coupon/claim-campaign
HTTP Method
- POST
Request Headers
- Authorization: Bearer {token}
- X-App-Key: {appKey}
Request Payload
{
"memberId": "memberId",
"campaignId": "1",
"couponIds": [
"couponId"
]
}
Request Parameters
| Field | Required | Type | Remark | Sample |
|---|---|---|---|---|
| memberId | Yes | string | memberId | xxx |
| campaignId | Yes | string | campaignId | xxx |
| couponIds | Yes | string | couponIds | ["couponId"] |
Response Payload
{
"status": 1,
"errorCode": 0,
"message": "success",
"redemptions": [
{
"couponId": "couponId",
"redemptionCode": "redemptionCode"
}
]
}
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 | ||
| redemptions | No | object[] | ||
| couponId | Yes | string | ID of the coupon | xxx |
| redemptionCode | Yes | string | Code of the redemption | xxx |
Response Headers
Error Codes
| Code | Description |
|---|---|
| 1 | Internal Error |
| 3 | Missing Parameter |
| 4 | Invalid Input: [field name] |
| 4100 | Member not found |
| 10401 | Coupon not found |
| 10402 | Campaign not found |
| 10403 | Invalid campaign coupon |