SHshoplineapp
Customers

Update Customer Member Points

Changed on

Using open API to update customer member points

post/customers/{id}/member_points

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/customers/{id}/member_points
  • Auth
    HTTP bearer

Path parameters

idstring required

Customer ID<br>顧客ID

Request body

valueinteger required

Points to be added or deducted<br>增加或減除點數<br>-<br>*Number can be -999999~999999

remarksstring required

Reason for adding or deducting member points<br>增加或減除點數原因<br>-<br>*Limit to max 50 characters

email_target1 | 3

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

sms_notification_target1 | 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全部都送

performer_idstring

Performer ID<br>操作者ID

performer_type'User' | 'Agent'

Performer Type<br>操作者類型

expire_datestring date nullable

Expiry date of points (YYYY-MM-DD format, e.g. 2026-03-19).<br> Only available when feature member_points_expiry_enhancement is enabled.<br> - date string: expires at end of day in merchant timezone (23:59:59.999)<br> - null: never expires<br> - omitted: expiry calculated from global earn_from_order rule

Example request

{
  "value": 39,
  "remarks": "add 100 member points",
  "email_target": 1,
  "sms_notification_target": 1,
  "expire_date": "2027-03-19"
}

Response

CREATED

customer_idstring

Customer ID

point_balanceinteger

Member Point<br>現有點數

remarksstring

Point Change Reason<br>點數更動原因

valueinteger

Point<br>點數

order_idstring

Order ID

order_numberstring

Order Number

type'manual' | 'auto_reward' | 'expired' | 'order_redeemed' | 'redeemed_to_cash' | 'order_split_revert' | 'product_review_reward' | 'member_info_reward' | 'return_order_revert' | 'order_edit_revert'

Member point type<br>點數種類 <br>----<br> manual: 手動增減點數（店家手動發送、取消訂單/退貨訂單回補）<br> auto_reward: 點數回饋<br> expired: 點數過期<br> order_redeemed: 使用點數兌換贈品於訂單<br> redeemed_to_cash: 使用點數折現於訂單<br> order_split_revert: 回補點數（來自拆單）<br> product_review_reward: 商品評價獎賞<br> member_info_reward: 會員資料獎賞<br> return_order_revert: 退貨單回補會員點數<br> order_edit_revert: 訂單編輯回補會員點數

is_redeemboolean

Redeemed?<br>已兌換?

end_atstring date-time nullable

Expiry date, a null value means never expired<br>到期日期, null 表示不會到期

created_atstring

Created Time<br>點數創建時間

Example response

{
  "customer_id": "5f8e5dc08a8bb70a5c9cd93c",
  "point_balance": 500,
  "remarks": "Reward",
  "value": 100,
  "order_id": "5f8e5dc08a8bb70a5c9cd93c",
  "type": "auto_reward",
  "end_at": "2020-10-20T03:50:00.323Z",
  "created_at": "2019-12-30T09:16:46.142Z"
}

Changes

  • d2518391b149Revision changes
    • breaking

      request body became required

    • breaking

      for the path request parameter id, the minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the response property became nullable for the status

    • warning

      the request property's maxLength was set to 50

    • warning

      the request property's max was set to 999999.00

    • warning

      the request property's min was set to -999999.00