Get Customers Store Credits
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 |
Response Fields
Parameter | Type | Description | Example |
---|---|---|---|
items | Store Credit History | Credit Item 購物金 | Please check the link of the left |
pagination | Pagination | Pagination Data 頁面資訊 | Please check the link of the left |
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
}
],
"pagination": {
"current_page": 1,
"per_page": 100,
"total_pages": 1,
"total_count": 10
}
}
Updated about 3 years ago