---
title: "Get Customer Store Credit History"
method: GET
path: "/customers/{id}/store_credits"
tags: ["Customers"]
---

# Get Customer Store Credit History

`GET /customers/{id}/store_credits`

To get store credit history of a customer<br>獲取顧客的商店購物金紀錄

## Path parameters

- `id` string, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `items` StoreCredit[] — Store credit history data<br>商店購物金紀錄
    - `_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>此訂單的建立者
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量

## Other responses

- `401` — Bad authentication
- `403` — Forbidden
- `404` — Product 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)
