v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Customers

Update Customer Store Credits

To update customer store credits with open API 使用open API更新顧客購物金

post/customers/{id}/store_credits

Path parameters

idstring required

Customer ID 顧客ID

Query parameters

excludes[]string[]

Exclude certain parameters in the response 結果要排除哪些參數

[
  "status"
]

fields[]string[]

Only show certain parameters in the response 結果只顯示哪些參數

[
  "status"
]

Request body

valueinteger required

Credits to be added or deducted 增加或減除金額 - *Number can be -999999~999999

remarksstring required

Reason for adding or deducting credits 增加或減除購物金原因 - * Limit to max 50 characters

expires_atstring

Validity Period 有效期限 * Date cannot be in the past * Date should be within 9999 days from now

email_target1 | 3

Notification with Email 是否發送email通知 Only applicable for addition 僅適用於增加 - 1=NOT_SEND全部不送 3=SEND_TO_ALL全部都送

sms_notification_target1 | 2 | 3

Notification with SMS 是否發送簡訊通知 Only applicable for addition 僅適用於增加 - 1=NOT_SEND全部不送 2=SEND_VERIFIED只送手機驗證過的 3=SEND_TO_ALL全部都送

replaceboolean

To replace all store credits with the current value 以此金額替代之前所有購物金

Store credit type 購物金類型 * manual_credit Manually assign store credit(s) to specific member 手動發送購物金給指定會員 * welcome_credit Auto assign welcome credits to new registered members 發送購物金鼓勵顧客註冊會員和進行第一次購物 * birthday_credit Auto assign store credits to members as gifts on their birthday 於會員的生日自動發送購物金作為生日禮物 * auto_reward Auto reward customers with credits when they meet a minimum amount of purchase 當訂單達到最低金額時自動發送購物金給會員 * applied_credit Applied user credits when placing an order 在下訂單時已折抵的購物金 * user_credit_expired Expired user credits 已過期的購物金 * welcome_member_referral_credit Referral will get store credits after sign up 新會員透過推薦連結註冊成為會員即可獲得購物金 * member_referral_credit Referrer will get the reward after an order from referral is completed 新顧客註冊後在訂單轉為「已完成」後，推薦人即可獲得購物金 * member_info_quick_completion_credit Member info reward credit 會員資料獎賞購物金 * order_split_revert Order split revert credit 訂單拆單回補購物金 * product_review_reward Product review reward credit 商品評價獎賞購物金 * return_order_revert Return order revert credit 退貨單回補購物金 * order_edit_revert Order edit revert credit 訂單編輯回補購物金

performer_idstring

Performer ID 操作者ID

performer_type'User' | 'Agent'

Performer Type 操作者類型

Example request

{
  "value": 100,
  "remarks": "add 100 store credits",
  "expires_at": "2021-11-30",
  "email_target": 1,
  "sms_notification_target": 1,
  "replace": true,
  "type": "manual_credit"
}

Response

CREATED

_idstring

Record ID 紀錄 ID

customer_idstring

Customer ID 顧客 ID

credit_balanceinteger

Credit balance after this record 此紀錄後的購物金餘額

remarksstring

Credit Change Reason 購物金更動原因

valueinteger

Credit Movement 購物金款項

end_atstring

Expiry Date 到期日

performer_idstring

ID of the staff who created this record 創建紀錄的管理員的ID

performer_namestring

Staff who created this record 創建紀錄的管理員

fulfillment_balanceinteger

Fulfillment Balance 購物金餘額

Store credit type 購物金類型 ---- manual_credit: 手動增減購物金（店家手動發送、回補來自取消訂單/退貨訂單） welcome_credit: 新加入會員購物金 birthday_credit: 生日購物金 auto_reward: 購物金回饋 applied_credit: 套用購物金在訂單 user_credit_expired: 購物金過期 welcome_member_referral_credit: 透過推薦連結註冊成功 member_referral_credit: 推薦新顧客進行消費 order_split_revert: 回補購物金（來自拆單） product_review_reward: 商品評價獎賞 member_info_quick_completion_credit: 會員資料獎賞 return_order_revert: 退貨單回補購物金 order_edit_revert: 訂單編輯回補購物金

created_atstring

Record creation date 創建紀錄日期

customer_ref_user_idstring

Third party custom customer id 第三方儲存之顧客ID

status'active' | 'removed' | 'expired' | 'used' | 'redeemed'

Status 購物金狀態

is_redeemboolean

Whether the store credit is redeemed 購物金是否已經被兌換

order_idstring

The ID of the order where the store credit earned from 賺取購物金的訂單的ID

user_credit_rule_idstring

The ID of user_credit_rule

order_numberstring

Order number 訂單號碼

merchant_order_numberstring

The order number set by the merchant 店家自定義訂單號

order_created_bystring

Order created by 此訂單的建立者

Example response

{
  "_id": "5f55ad58d9ce6d003c1fd62f",
  "customer_id": "5f47c96a86a983001614a834",
  "credit_balance": 160,
  "remarks": "hello",
  "value": 20,
  "end_at": "2021-11-30T00:00:00.000+00:00",
  "performer_id": "61ad96bda6633e004cafe7db",
  "performer_name": "staff1",
  "fulfillment_balance": 10,
  "type": "manual_credit",
  "created_at": "2020-09-07T03:47:44.061Z",
  "customer_ref_user_id": "MEMBR000000000000019034194",
  "status": "active",
  "order_id": "621701406dcff70039642cde",
  "value_dollar": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "user_credit_rule_id": "583d630a69702d70850c0000",
  "order_number": "2019052707260498"
}