v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Store Credits

Bulk Update Store Credits

Bulk update multiple user store credit records. 批量更新多個 users 購物金

post/user_credits/bulk_update

Request body

user_idsstring[] required

List of user IDs to update. user ID 的列表，指定要更新的 user

valuenumber required

The value to set for each user's store credit. 要給予每個 user 的購物金金額

remarksstring required

Remarks for the store credits update. 購物金更新的備註

performer_idstring

The User ID of the performer making the update. Optional. 執行者 User ID

expired_atstring date-time

Expiration date for the store credits. 購物金的過期日期

email_target1 | 3

Allowed 1 & 3. 1 means not send, 3 means send all. 電子郵件是否發送，1為不發送，3為發送

sms_notification_target1 | 2 | 3

Allowed 1~3. 1 means not send, 2 means send with verified, 3 means send all. 簡訊是否發送通知，1為不發送，2為發送至驗證手機，3為全部發送

include_blacklistedboolean

Whether to include blacklisted (login/order-banned, status=blacklisted) customers as recipients. Default false. 是否將黑名單（禁止登入下單，status=blacklisted）顧客納入發放對象，預設 false

Example request

{
  "user_ids": [
    "user1",
    "user2",
    "user3"
  ],
  "value": 100,
  "remarks": "Holiday bonus",
  "performer_id": "performer1",
  "expired_at": "2025-12-31T23:59:59Z",
  "email_target": 1,
  "sms_notification_target": 1
}

Response

Successfully updated the store credits. 成功更新購物金記錄

messagestring

job_idstring

Example response

{
  "message": "Success.",
  "job_id": "67596dd037cdd80016e58022"
}