Function

To get customers store credits
獲取商店購物金紀錄

URL
Get https://open.shopline.io/v1/user_credits

Request Parameters

Parameter	Type	Description	Example
created_at_after	`DateTime`	Filter user credits by those created after specific time. 取得 created_at 大於指定時間的購物金(包含指定時間)	`ruby created_at_after=2018-01-01 00:00:00`
created_at_before	`DateTime`	Filter user credits by those created before specific time. 取得 created_at 小於指定時間的購物金(包含指定時間)	`ruby created_at_before=2018-01-01 00:00:00`
end_at_after	`DateTime`	Filter user credits by those end after specific time. 取得 end_at 大於指定時間的購物金(包含指定時間)	`ruby end_at_after=2018-01-01 00:00:00`
end_at_before	`DateTime`	Filter user credits by those end before specific time. 取得 end_at 小於指定時間的購物金(包含指定時間)	`ruby end_at_before=2018-01-01 00:00:00`
previous_id	`String`	Cursor for the next page: the _id from the previous response's last_id. 上一頁回傳的 last_id。第一頁不需帶。 Presence of this param also enables cursor mode.	`previous_id=5f1e837c1be895004582ad47`
limit	`Integer`	Cursor mode page size (default 24, max 999). Presence of this param enables cursor mode (response returns last_id instead of pagination). Larger values reduce total round trips for large batch jobs (e.g. fetching 60k records with limit=999 takes ~60 calls vs ~2500 with limit=24). cursor 模式每次回傳筆數。帶 limit 即啟用 cursor，response 不再含 pagination。大批次任務建議用較大值以減少請求次數。	`limit=24`

Response Fields

Parameter	Type	Description	Example
items	Store Credit History	Credit Item 購物金	Please check the link of the left
last_id	`String`	Present only in cursor mode (`limit` or previous_id provided). Cursor signal for the next page (pass as `previous_id` on next call). null when current page returned fewer than limit items. 下一頁 cursor signal。當回傳筆數 < `limit` 時為 null。注意：總筆數剛好是 limit 倍數時，最末滿頁 `last_id` 仍非 null，下一次呼叫才會回空陣列 + null。請同時檢查兩個條件。

Response Example

{
    "items": [
        {
            "_id": "60cb0981adce280017608e1b",
            "customer_id": "5d8aeef5a7c9dd1c75263b98",
            "credit_balance": 100,
            "remarks": "10 credits",
            "value": 100,
            "fulfillment_balance": null,
            "end_at": "2021-11-30T00:00:00.000+00:00",
            "performer_id": "5d8aed1bb31a6800336a548f",
            "performer_name": "philip+postman",
            "type": "manual_credit",
            "created_at": "2021-06-17T08:36:17.152Z",
            "customer_ref_user_id": "test01",
            "status": "active",
            "is_redeem": false,
            "order_id": null,
            "value_dollar": null,
            "user_credit_rule_id": null,
            "order_wapos_id": null,
            "order_number": null,
            "merchant_order_number": null,
            "order_created_by": null
        },
        ...
        {
            "_id": "60caef7d4f76020021fa695c",
            "customer_id": "602ca8f267e4f900139bf1c4",
            "credit_balance": 20,
            "remarks": "10 credits",
            "value": 10,
            "fulfillment_balance": null,
            "end_at": "2021-11-30T00:00:00.000+00:00",
            "performer_id": "5d8aed1bb31a6800336a548f",
            "performer_name": "philip+postman",
            "type": "manual_credit",
            "created_at": "2021-06-17T06:45:17.352Z",
            "customer_ref_user_id": "SL001",
            "status": "active",
            "is_redeem": false,
            "order_id": null,
            "value_dollar": null,
            "user_credit_rule_id": null,
            "order_wapos_id": null,
            "order_number": null,
            "merchant_order_number": null,
            "order_created_by": null
        }
    ],
    "last_id":"5f1e837c1be895004582ad47"
}