Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Customer Groups

Get Customer Groups

To get customer groups.<br>獲取顧客分群。

get/customer_groups

Query parameters

pageinteger

Page<br>頁數<br>(Default: 1)

per_pageinteger

Numbers of Customers per page<br>每頁顯示 n 筆資料<br>(Default: 24, Max: 999)

sort_bystring

Setting sort by created time<br>設定依照建立時間排序<br>(Default: desc)

created_afterstring

Filter customers which is later than created_after<br>篩選依據 created_after 時間之後建立的分群<br>-<br> Please fill in to the second level. Default value is 00:00:00 if only fill in dates.<br>請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00

created_beforestring

Filter customers which is earlier than created_before<br>篩選依據 created_before 時間之前建立的分群<br>-<br> Please fill in to the second level. Default value is 00:00:00 if only fill in dates.<br>請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00

status'active' | 'expired'

Filter the customer group is active or expired.<br> 篩選已過期或未過期的顧客分群<br>-<br> If the value isn't given, it will return all customer groups.<br>若不填寫，則會回傳所有顧客分群<br> Don't use created_before or created_after if the status is given.<br> 若有設定 status 欄位，則不要同時設定 created_before 或 created_before 參數

Response

OK

Example response

{
  "items": [
    {
      "id": "5ce0d084e388096bdb229a59",
      "name": "VIP",
      "count": 10,
      "email_users_count": 10,
      "mobile_phone_users_count": 10,
      "updated_at": "2018-07-31T03:57:36.409+00:00",
      "created_at": "2018-07-31T03:57:36.409+00:00",
      "status": "active",
      "update_type": "manual",
      "update_cycle": 7,
      "created_by": "manual",
      "parent_id": "5ce0d084e388096bdb229a59",
      "last_child_id": "643fbf34029235003557bf05",
      "last_updated_at": "2018-07-31T03:57:36.409+00:00",
      "next_update_at": "2018-07-31T03:57:36.409+00:00",
      "expired_at": "2018-07-31T03:57:36.409+00:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}