Home
HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Claim Coupon

Suggest Edits

🚧

Upcoming Breaking Changes

Sept. 11, 2024 領取優惠券 API 與參數異動 Claim Coupon API & Parameters’ Breaking Change

Function

To claim a coupon for a customer.
外部服務的領取優惠券動作
(可透過此 API 幫顧客領取優惠券，不需要透過 SHOPLINE 後台)

URL

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

Request Parameters

ParameterTypeExample
customer_id
*Required		StringCustomer ID
顧客 ID		5e0047dfc4101900263b1450
locale
*Optional		StringDescriptiondefault: en
options: zh-hant zh-cn

Request Example

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

Error Message List

enzh-hantzh-cn
Coupon {code} is not applicable.優惠券 {code} 不適用优惠券 {code} 不适用
This coupon code {code} is invalid.代碼 {code} 無效代码 {code} 无效
Coupon {code} is expired.優惠券 {code} 已過期优惠券 {code} 已过期
Coupon {code} has reached usage limit.優惠券 {code} 已達使用次數限制优惠券 {code} 已达使用次数限制
Coupon {code} is only applicable for members優惠券 {code} 僅限會員使用优惠券 {code} 仅限会员使用
Coupon {code} is only for the first purchase order.優惠券 {code} 限定首次購買使用优惠券 {code} 限定首次购买使用
Coupon {code} has reached usage limit.優惠券 {code} 已達使用次數限制优惠券 {code} 已达使用次数限制
You have already claimed this coupon. Please proceed to checkout and use it first.您已領取此優惠券，請前往結帳使用您已领取此优惠券，请前往结帐使用
You have already used this coupon.您已使用此優惠券您已使用此优惠券

Response Example

{
    "success": true,
    "coupon_code": "multi3",
    "promotion_name": "多組折扣"
}


{
    "message": "您已領取此優惠券，請前往結帳使用",
    "code": 422,
    "extras": {}
}

Updated 3 months ago