2.3 查詢會員顧客 List Customers

<h3>查詢會員顧客 API</h3> <h5>說明</h5> <ul> <li>提供取得會員顧客資料清單。</li> <li>Request 參數可以不傳，若傳入多個，則代表查詢條件為多個參數的 and 組合。</li> </ul> <hr /> <h5>Request URL</h5> <ul> <li><strong><em><code>GET</code></em></strong> <code>/api/v1/customers/search</code></li> </ul> <hr /> <h5>Request Parameters</h5> <table> <thead> <tr> <th style="text-align: left;">參數</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">類型</th> <th>說明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td style="text-align: left;">會員顧客 ID</td> <td>vqx79r52rz50</td> </tr> <tr> <td style="text-align: left;">customer_code</td> <td style="text-align: left;">string</td> <td style="text-align: left;">會員顧客編號</td> <td>不重複之編號，亦可用不重複之手機號碼</td> </tr> <tr> <td style="text-align: left;">mobile_phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;">手機</td> <td>-</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;">姓名</td> <td>-</td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Email</td> <td>-</td> </tr> <tr> <td style="text-align: left;">birthday</td> <td style="text-align: left;">string</td> <td style="text-align: left;">生日</td> <td>-</td> </tr> <tr> <td style="text-align: left;">created_before</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">建立時間起</td> <td>2021-11-16 00:00:00</td> </tr> <tr> <td style="text-align: left;">created_after</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">建立時間迄</td> <td>2021-11-16 23:59:59</td> </tr> <tr> <td style="text-align: left;">updated_before</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">更新時間起</td> <td>2021-11-16 00:00:00</td> </tr> <tr> <td style="text-align: left;">updated_after</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">更新時間迄</td> <td>2021-11-16 23:59:59</td> </tr> </tbody> </table> <hr /> <h5>Response Parameters</h5> <table> <thead> <tr> <th style="text-align: left;">參數</th> <th style="text-align: left;">類型</th> <th style="text-align: left;">說明</th> <th style="text-align: left;">範例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td style="text-align: left;">會員顧客 ID</td> <td style="text-align: left;">vqx79r52rz50</td> </tr> <tr> <td style="text-align: left;">customer_code</td> <td style="text-align: left;">string</td> <td style="text-align: left;">會員顧客編號</td> <td style="text-align: left;">不重複之編號，亦可用不重複之手機號碼</td> </tr> <tr> <td style="text-align: left;">mobile_phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;">手機</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;">姓名</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">string</td> <td style="text-align: left;">Email</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">birthday</td> <td style="text-align: left;">string</td> <td style="text-align: left;">生日</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">sexual</td> <td style="text-align: left;">string</td> <td style="text-align: left;">性別</td> <td style="text-align: left;">male:男<br>female:女</td> </tr> <tr> <td style="text-align: left;">created_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">建立時間</td> <td style="text-align: left;">-</td> </tr> <tr> <td style="text-align: left;">updated_at</td> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">更新時間</td> <td style="text-align: left;">-</td> </tr> </tbody> </table> <hr /> <h5>Request Sample</h5> <pre><code>{ "name":"陳小明" }</code></pre> <hr /> <h5>Response Sample</h5> <pre><code>{ "status": "success", "data": [ { "id":"vqx79r52rz50", "employee_code":"A090110", "name":"陳小明", "email":"mymail@example.com", "service_unit":"台北微型企業一科", "job_level":"資深專員", "mobile_phone":"0911234567", "line_contact_url":"https://www.ccc.cc/", "avatar_url":"https://www.ccc.cc/", "enabled_at":"2021-11-16 16:49:00", "leave_at":"2021-11-16 16:49:00", "current_branch_id":13 "created_at":"2021-11-16 16:49:00", "updated_at":"2021-11-16 16:49:00" }, { "id":"jexd94l26rl3", "employee_code":"A090111", "name":"陳小明", "email":"mymail2@example.com", "service_unit":"台北微型企業2科", "job_level":"資深專員", "mobile_phone":"0922234567", "line_contact_url":"https://www.ccc.cc/", "avatar_url":"https://www.ccc.cc/", "enabled_at":"2021-11-16 16:49:00", "leave_at":"2021-11-16 16:49:00", "current_branch_id":13 "created_at":"2021-11-16 16:49:00", "updated_at":"2021-11-16 16:49:00" } ] } </code></pre>