Skip to main content

UseCoupon

Function

use a Coupon

Endpoint

  • /v1/member-coupon/use

HTTP Method

  • POST

Request Headers

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

Request Payload

{
"redemptionCode": "Code of the redemption",
"memberId": "memberId",
"source":"POS",
"storeCode": "KTSP010000001",
"transactionAmount": "100.00"
}

Request Parameters

FieldRequiredTypeRemarkSample
redemptionCodeYesstringCode of the redemptionxxx
memberIdYesstringmemberIdxxx
sourceYesstringsource: POSPOS
storeCodeYesstringstoreCodeKTSP010000001
transactionAmountYesstringtransaction amount100.00

Response Payload

{
"status": 1,
"errorCode": 0,
"message": "success",
"redemptionCode": "Code of the redemption"
}

Response Parameters

FieldRequiredTypeRemarkSample
statusYesstringstatus code of the api call
messageYesstringdetail message of the api call
errorCodeNostring
redemptionCodeNostringredemption code

Response Headers

Error Codes

CodeDescription
1Internal Error
3Missing Parameter
4Invalid Input: [field name]
4100Member not found
10411Redemption not found
10412Invalid Coupon
10413Invalid Store
10414quotaExceeded
10415minimumSpendAmount not match
10416Coupon already used
10417Coupon only available to KDP member