SHshoplineapp
Store Credits

Get Store Credits

Changed on

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

get/user_credits

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/user_credits
  • Auth
    HTTP bearer

Query parameters

created_at_afterstring

Filter store credits by those created after specific time.<br> 取得 created_at 大於指定時間的購物金(包含指定時間)<br> *Should use UTC time'

created_at_beforestring

Filter store credits by those create before specific time.<br> 取得 created_at 小於指定時間的購物金(包含指定時間)<br> *Should use UTC time'

end_at_afterstring

Filter store credits by those end after specific time.<br> 取得 end_at 大於指定時間的購物金(包含指定時間)<br> *Should use UTC time'

end_at_beforestring

Filter store credits by those end before specific time.<br> 取得 end_at 小於指定時間的購物金(包含指定時間)<br> *Should use UTC time'

pageinteger

Page Number<br>頁數

per_pageinteger

Numbers of Orders per Page<br>每頁顯示 n 筆資料

excludes[]string[]

Could exclude certain parameters in the response<br>結果要排除哪些參數

[
  "items.id"
]
fields[]string[]

Could only show certain parameters in the response<br>結果只顯示哪些參數

[
  "items.id"
]

Response

OK

Example response

{
  "items": [
    {
      "_id": "5f55ad58d9ce6d003c1fd62f",
      "customer_id": "5f47c96a86a983001614a834",
      "remarks": "hello",
      "value": 20,
      "end_at": "2021-11-30T00:00:00.000+00:00",
      "performer_id": "61ad96bda6633e004cafe7db",
      "performer_name": "staff1",
      "fulfillment_balance": 10,
      "type": "manual_credit",
      "created_at": "2020-09-07T03:47:44.061Z",
      "status": "active",
      "order_id": "621701406dcff70039642cde",
      "value_dollar": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "user_credit_rule_id": "583d630a69702d70850c0000",
      "order_number": "2019052707260498"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}

Changes

  • d2518391b149Revision changes
    • breaking

      the response property // became nullable for the status

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter previous_id

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      for the query request parameter created_at_after, the format was generalized from date-time to no format

    • info

      for the query request parameter created_at_before, the format was generalized from date-time to no format

    • info

      for the query request parameter end_at_after, the format was generalized from date-time to no format

    • info

      for the query request parameter end_at_before, the format was generalized from date-time to no format