---
title: "Update Customer Store Credits"
method: POST
path: "/customers/{id}/store_credits"
tags: ["Customers"]
---

# Update Customer Store Credits

`POST /customers/{id}/store_credits`

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

## Path parameters

- `id` string, required

## Query parameters

- `excludes[]` string[]
- `fields[]` string[]

## Request body

- object
  - `value` integer, required — Credits to be added or deducted<br>增加或減除金額<br>-<br>*Number can be -999999~999999
  - `remarks` string, required — Reason for adding or deducting credits<br>增加或減除購物金原因<br>-<br>* Limit to max 50 characters
  - `expires_at` string — Validity Period<br>有效期限<br>* Date cannot be in the past <br>* Date should be within 9999 days from now
  - `email_target` 1 | 3 — Notification with Email<br>是否發送email通知<br>Only applicable for addition<br>僅適用於增加<br>-<br> 1=NOT_SEND全部不送<br> 3=SEND_TO_ALL全部都送
  - `sms_notification_target` 1 | 2 | 3 — Notification with SMS<br>是否發送簡訊通知<br>Only applicable for addition<br>僅適用於增加<br>-<br> 1=NOT_SEND全部不送<br> 2=SEND_VERIFIED只送手機驗證過的<br> 3=SEND_TO_ALL全部都送
  - `replace` boolean — To replace all store credits with the current value<br>以此金額替代之前所有購物金
  - `type` 'manual_credit' | 'welcome_credit' | 'birthday_credit' | 'auto_reward' | 'applied_credit' | 'user_credit_expired' | 'welcome_member_referral_credit' | 'member_referral_credit' | 'member_info_quick_completion_credit' | 'order_split_revert' | 'product_review_reward' | 'return_order_revert' | 'order_edit_revert' — Store credit type<br> 購物金類型<br> * `manual_credit`<br> Manually assign store credit(s) to specific member<br> 手動發送購物金給指定會員<br> * `welcome_credit`<br> Auto assign welcome credits to new registered members<br> 發送購物金鼓勵顧客註冊會員和進行第一次購物<br> * `birthday_credit`<br> Auto assign store credits to members as gifts on their birthday<br> 於會員的生日自動發送購物金作為生日禮物<br> * `auto_reward`<br> Auto reward customers with credits when they meet a minimum amount of purchase<br> 當訂單達到最低金額時自動發送購物金給會員<br> * `applied_credit`<br> Applied user credits when placing an order<br> 在下訂單時已折抵的購物金<br> * `user_credit_expired`<br> Expired user credits<br> 已過期的購物金<br> * `welcome_member_referral_credit`<br> Referral will get store credits after sign up<br> 新會員透過推薦連結註冊成為會員即可獲得購物金<br> * `member_referral_credit`<br> Referrer will get the reward after an order from referral is completed<br> 新顧客註冊後在訂單轉為「已完成」後，推薦人即可獲得購物金<br> * `member_info_quick_completion_credit`<br> Member info reward credit<br> 會員資料獎賞購物金<br> * `order_split_revert`<br> Order split revert credit<br> 訂單拆單回補購物金<br> * `product_review_reward`<br> Product review reward credit<br> 商品評價獎賞購物金<br> * `return_order_revert`<br> Return order revert credit<br> 退貨單回補購物金<br> * `order_edit_revert`<br> Order edit revert credit<br> 訂單編輯回補購物金<br>
  - `performer_id` string — Performer ID<br>操作者ID
  - `performer_type` 'User' | 'Agent' — Performer Type<br>操作者類型

## Response `201`

CREATED

- StoreCredit
  - `_id` string — Record ID<br>紀錄 ID
  - `customer_id` string — Customer ID<br>顧客 ID
  - `credit_balance` integer — Credit balance after this record<br>此紀錄後的購物金餘額
  - `remarks` string — Credit Change Reason <br>購物金更動原因
  - `value` integer — Credit Movement<br>購物金款項
  - `end_at` string — Expiry Date<br>到期日
  - `performer_id` string — ID of the staff who created this record<br>創建紀錄的管理員的ID
  - `performer_name` string — Staff who created this record<br>創建紀錄的管理員
  - `fulfillment_balance` integer — Fulfillment Balance<br>購物金餘額
  - `type` 'manual_credit' | 'welcome_credit' | 'birthday_credit' | 'auto_reward' | 'applied_credit' | 'user_credit_expired' | 'welcome_member_referral_credit' | 'member_referral_credit' | 'order_split_revert' | 'member_info_quick_completion_credit' | 'product_review_reward' | 'return_order_revert' | 'order_edit_revert' — Store credit type<br>購物金類型 <br>----<br> manual_credit: 手動增減購物金（店家手動發送、回補來自取消訂單/退貨訂單）<br> welcome_credit: 新加入會員購物金<br> birthday_credit: 生日購物金<br> auto_reward: 購物金回饋<br> applied_credit: 套用購物金在訂單<br> user_credit_expired: 購物金過期<br> welcome_member_referral_credit: 透過推薦連結註冊成功<br> member_referral_credit: 推薦新顧客進行消費<br> order_split_revert: 回補購物金（來自拆單）<br> product_review_reward: 商品評價獎賞<br> member_info_quick_completion_credit: 會員資料獎賞<br> return_order_revert: 退貨單回補購物金<br> order_edit_revert: 訂單編輯回補購物金
  - `created_at` string — Record creation date<br>創建紀錄日期
  - `customer_ref_user_id` string — Third party custom customer id<br>第三方儲存之顧客ID
  - `status` 'active' | 'removed' | 'expired' | 'used' | 'redeemed' — Status<br>購物金狀態
  - `is_redeem` boolean — Whether the store credit is redeemed<br> 購物金是否已經被兌換
  - `order_id` string — The ID of the order where the store credit earned from<br>賺取購物金的訂單的ID
  - `value_dollar` object — The value of the store credit displayed in dollar<br> 以元表示購物金的價值
    - `cents` integer
    - `currency_symbol` string
    - `currency_iso` string
    - `label` string
    - `dollars` number
  - `user_credit_rule_id` string — The ID of user_credit_rule
  - `order_number` string — Order number<br>訂單號碼
  - `merchant_order_number` string — The order number set by the merchant<br>店家自定義訂單號
  - `order_created_by` string — Order created by<br>此訂單的建立者

## Other responses

- `401` — Bad authentication
- `403` — Forbidden
- `404` — Resource not found error
- `422` — Unprocessable entity error
- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)