HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Redeem Coupon

Function

To redeem a coupon for a customer.
外部服務的優惠券核銷機制
(可透過此 API 註記優惠券已被使用,不需要搭配 SHOPLINE 訂單資訊)

*Note: 僅支援領取型優惠券

URL

POST <<api_domain>>/v1/user_coupons/:coupon_code/redeem

Request Parameters

ParameterTypeDescriptionExample
customer_id
*Required
StringCustomer ID
顧客 ID
5e0047dfc4101900263b1450
coupon_code
*Required
StringCoupon Code
優惠代碼
GoGoGo

Request Example

curl -X POST \
  <<api_domain>>/v1/user_coupons/:coupon_code/redeem \
  -H 'Authorization: Bearer access_token' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id":"625d37140f2f2d5ad631a741"
  }'

Error Code List

Error CodeMeaning
NOT_ELIGIBLEpromotion 或是 user_coupon 無法找到
PROMOTION_INACTIVEpromotion 的 status 為 removed 或是 drafted,無法使用
PROMOTION_NOT_AVAILABLE_YETpromotion 還未開始
PROMOTION_EXPIREDpromotion 已結束
USER_INVALID_MEMBERSHIP_TIERpromotion 有限定會員層級,此 user 不符合
PROMOTION_NOT_APPLICABLEpromotion 有 限定會員 tag,此 user 不符合
MEMBER_REQUIRED需要 user 為會員
MAX_USE_COUNT_REACHED已到達此 promotion 最大使用量
USER_FIRST_PURCHASE_ONLY首購限定