Search Customers

get

https://open.shopline.io/v1/customers/search

To search customers with specific conditions.
利用特殊條件搜尋顧客列表。

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 1

Page
頁數
(Default: 1)

per_page

integer

Defaults to 24

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

query

string

Support searching fields below:
支援搜尋以下欄位:
name
email
phones
mobile_phone

search_fields

array of strings

To specify searching fields
指定搜尋欄位:
name
email
phones
mobile_phone

search_fields

id[]

array of strings

Customer's ID list
顧客編號列表

id[]

name

string

Customer's Name
顧客姓名
-
*Support equal or not equal.
支援等於或不等於

string

Customer's Email
顧客Email
-
*Support equal or not equal.
支援等於或不等於

phone

string

Customer's Phone
顧客電話
-
Support equal or not equal.
支援等於或不等於

phones

string

Customer's Phones
顧客電話
-
Support equal or not equal.
支援等於或不等於

mobile_phone

string

Customer's Mobile Phone
顧客手機
-
Support equal or not equal.
支援等於或不等於.

gender

string

enum

Customer's Gender
顧客性別
-
Gender allows
male 男性
female 女性
other 其他

Support equal or not equal.
支援等於或不等於.

Allowed:

membership_tier_id

string

Membership Tier
顧客等級
-
With blank will return customers without membership tier
當帶入空值，將回傳無會員等級之顧客

With not: will return customers with membership tier
當帶入not:，將回傳有會員等級之顧客

*Support equal or not equal.
支援等於或不等於.

created_at

string

Filter customers by created time
以顧客創造時間作為搜尋依據
-
Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

Please fill in to the second level. Default value is 00:00:00 if only fill in dates.
請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00

updated_at

string

Filter customers by created time
以顧客更新時間作為搜尋依據
-
*Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

registered_at

string

Filter customers by registered time
以顧客註冊時間作為搜尋依據
-
*Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

birthday

string

Filter customers by birthday
以顧客生日作為搜尋依據
-
*Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

birth_month

string

Filter customers by birth month
以顧客生日月份作為搜尋依據
-
*Support equal or not equal or less than or less than or equal or not equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

credit_balance

string

Filter customers by credit balance
以購物金作為搜尋依據
-
*Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援等於或不等於或小於或小於等於或大於或大於等於

is_member

boolean

Filter member customers.
搜尋是會員的顧客

is_blacklisted

boolean

Filter Blacklisted Customers.
搜尋是黑名單的顧客

is_subscribed_marketing_email

boolean

Filter Customers by Marketing Acceptance.
搜尋接受優惠宣傳的顧客

ref_user_id

string

Third party custom customer id
第三方儲存之顧客ID

200OK

401Bad authentication

403Forbidden

422Unprocessable entity error

500Server error