コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

会員一覧取得

GET
/customers

会員情報一覧を取得します。

対象プラン

  • プレミアムプラス
  • フードビジネス
  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
fields
array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort
string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

  • customerId：会員ID
  • customerCode：会員コード
limit
integer

上限数

page
integer

ページ

customer_code
string

会員コード

customer_id-from
string

会員ID(From)

customer_id-to
string

会員ID(To)

customer_no
string

会員番号

upd_date_time-from
string

更新日時(From)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

upd_date_time-to
string

更新日時(To)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
object
customerId

会員ID

string
customerCode

会員コード

string
customerNo

会員番号

string
rank

会員ランク

string
staffRank

社員ランク

string
firstName

名

string
lastName

姓

string
firstKana

名カナ

string
lastKana

姓カナ

string
postCode

郵便番号

string
address

住所

string
phoneNumber

電話番号

string
faxNumber

FAX番号

string
mobileNumber

携帯電話番号

string
mailAddress

メールアドレス

string
mailAddress2

メールアドレス2

string
mailAddress3

メールアドレス3

string
companyName

会社名

string
departmentName

部署名

string
managerialPosition

役職

string
sex

性別 0：不明、1：男、2：女

string
birthDate

生年月日：[YYYY-MM-DD]

string
pointExpireDate

ポイント失効予定日：[YYYY-MM-DD]

string
lastComeDateTime

最終来店日時：[YYYY-MM-DDThh:mm:ssTZD]

string
entryDate

入会日：[YYYY-MM-DD]

string
leaveDate

退会日：[YYYY-MM-DD]

string
pointGivingUnitPrice

ポイント付与単位(金額)

string
pointGivingUnit

ポイント付与単位(ポイント)

string
pinCode

PINコード

string
passportNo

旅券番号：パスポート番号

string
nationality

国籍

string
alphabetName

アルファベット氏名

string
mailReceiveFlag

案内メール受取許可フラグ（0：拒否、1：許可）

string
note

備考：1000文字以内。

string
note2

備考2：1000文字以内。

string
favoriteList

お気に入りリスト：1000文字以内。

string
browsingList

閲覧履歴リスト：1000文字以内。

string
status

会員状態区分（0：利用可、1：利用停止、2：紛失、3：退会、4：名寄せ）

string
storeId

対象店舗ID

string
insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
Example
[
  {
    "customerId": "string",
    "customerCode": "string",
    "customerNo": "string",
    "rank": "string",
    "staffRank": "string",
    "firstName": "string",
    "lastName": "string",
    "firstKana": "string",
    "lastKana": "string",
    "postCode": "string",
    "address": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "mobileNumber": "string",
    "mailAddress": "string",
    "mailAddress2": "string",
    "mailAddress3": "string",
    "companyName": "string",
    "departmentName": "string",
    "managerialPosition": "string",
    "sex": "string",
    "birthDate": "string",
    "pointExpireDate": "string",
    "lastComeDateTime": "string",
    "entryDate": "string",
    "leaveDate": "string",
    "pointGivingUnitPrice": "string",
    "pointGivingUnit": "string",
    "pinCode": "string",
    "passportNo": "string",
    "nationality": "string",
    "alphabetName": "string",
    "mailReceiveFlag": "string",
    "note": "string",
    "note2": "string",
    "favoriteList": "string",
    "browsingList": "string",
    "status": "string",
    "storeId": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]