getCustomers
Get a list of customers from your store. Filter by membership, name, email, phone, gender, registration date, and more with pagination.
Instructions
顧客を一覧取得します。会員顧客とゲスト購入由来の非会員顧客の両方が対象で、member=true で会員のみ、member=false で非会員のみに絞り込めます。氏名・メール・電話番号・郵便番号などでの部分一致検索、顧客 ID 指定、性別・メールマガジン購読状況などの属性絞り込み、登録日・更新日による期間絞り込みが可能(具体的なパラメータと指定方法はスキーマを参照)。limit(最大 100、デフォルト 10)/ offset でページング。特定顧客 1 件は getCustomer、新規登録は postCustomers、情報更新は updateCustomers を参照。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | 顧客IDで検索。カンマ区切りで複数指定可能 | |
| sex | No | 顧客の性別で検索 - `male`: 男性 - `female`: 女性 - `not_applicable`: 未回答 | |
| tel | No | 顧客の電話番号で部分一致検索 | |
| No | 顧客メールアドレスで部分一致検索 | ||
| name | No | 顧客名で部分一致検索 | |
| limit | No | レスポンスの件数を指定。指定がない場合は10。最大100 | |
| member | No | `true`なら会員登録済みの顧客から検索 | |
| offset | No | 指定した数値+1件目以降のデータを返す | |
| postal | No | 顧客の郵便番号で部分一致検索 | |
| furigana | No | 顧客フリガナで部分一致検索 | |
| line_uid | No | LINE UIDで完全一致検索 | |
| make_date_max | No | 指定日時以前に登録された顧客から検索 | |
| make_date_min | No | 指定日時以降に登録された顧客から検索 | |
| update_date_max | No | 指定日時以前に更新された顧客から検索 | |
| update_date_min | No | 指定日時以降に更新された顧客から検索 | |
| receive_mail_magazine | No | メルマガ受信可否で検索 |