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

顧客一覧取得

GET
/customers
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/customers?limit=100&page=1&fields=customerId%2CcustomerName&customer_id=1%2C2&customer_id_from=1&customer_id_to=100&status=1%2C2&create_date_from=2024-01-01%2000%3A00%3A00&create_date_to=2024-12-31%2023%3A59%3A59&update_date_from=2024-01-01%2000%3A00%3A00&update_date_to=2024-12-31%2023%3A59%3A59&last_login_date_from=2024-01-01%2000%3A00%3A00&last_login_date_to=2024-12-31%2023%3A59%3A59&sort=customerId%3Adesc' \
  --header 'Authorization: Bearer <token>'

顧客の一覧を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 100 >= 1 <= 1000

取得件数

page
integer
default: 1 >= 1

ページ

fields
Array<string>
>= 1 items unique items
Allowed values: customerId companyName customerName customerKana tel zip pref addr01 addr02 point customerStatus createAt updateAt

取得するフィールドをカンマ区切りで指定します。 指定がない場合すべてのフィールドを取得します。

主な指定可能パラメータ

  • customerId：顧客ID
  • companyName：会社名
  • customerName：顧客名
  • customerKana：顧客名カナ
  • tel：電話番号
  • zip：郵便番号
  • pref：都道府県
  • addr01：住所１
  • addr02：住所２
  • point：現在の通常ポイント
  • customerStatus：会員ステータス
  • createAt：登録日
  • updateAt：更新日
Example
?fields=customerId,customerName
customer_id
Array<string>
>= 1 items unique items

顧客IDで絞り込みを行います。

  • 完全一致で判定します。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: 1,2 は顧客IDが1または2に一致するレコードを返却します）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 1,,2）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?customer_id=1,2
customer_id_from
integer

顧客IDの範囲指定（以上）で絞り込みを行います。

  • 指定値以上の顧客IDを持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
1
customer_id_to
integer

顧客IDの範囲指定（以下）で絞り込みを行います。

  • 指定値以下の顧客IDを持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
100
status
Array<string>
>= 1 items unique items

会員ステータスIDで絞り込みを行います。

  • 完全一致で判定します（部分一致は不可）。
  • カンマ区切りで複数指定した場合はOR条件として扱います（例: 1,2 は1または2に一致するレコードを返却します）。
  • 空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 1,,2）は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
?status=1,2
create_date_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

登録日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以降の登録日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-01-01 00:00:00
create_date_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

登録日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以前の登録日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-12-31 23:59:59
update_date_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

更新日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以降の更新日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-01-01 00:00:00
update_date_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

更新日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以前の更新日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-12-31 23:59:59
last_login_date_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

最終ログイン日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以降の最終ログイン日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-01-01 00:00:00
last_login_date_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

最終ログイン日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD HH:MM:SS形式で指定します。

  • 指定値以前の最終ログイン日を持つレコードを返却します。
  • 空文字を指定した場合は400エラーを返却します。
  • パラメータを省略した場合は絞り込みを行いません。
Example
2024-12-31 23:59:59
sort
string
default: customerId:desc
Allowed values: customerId customerId:desc updateAt updateAt:desc

ソート

  • customerId: 顧客ID
  • updateAt: 更新日
Example
customerId:desc

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
Array<object>
Customer

EC-OMSでのみ活用される項目の説明のみ記載します。

object
customerId

顧客ID

string
>= 1 characters <= 9 characters
companyName

会社名

string
nullable <= 50 characters
companyDepartment

部署名

string
nullable <= 50 characters
customerName

顧客名（姓 名）

string
>= 1 characters <= 101 characters
customerKana

顧客名カナ（セイ メイ）

string
nullable <= 101 characters
country

国

string
nullable <= 50 characters
zip

郵便番号（3桁-4桁形式）

string
nullable <= 10 characters
pref

都道府県

string
nullable <= 50 characters
addr01

住所１

string
nullable <= 200 characters
addr02

住所２

string
nullable <= 200 characters
tel

電話番号（tel01+tel02+tel03の連結）

string
nullable <= 15 characters
tel2

電話番号２（tel02_01+tel02_02+tel02_03の連結）

string
nullable <= 15 characters
fax

FAX

string
nullable <= 15 characters
email01

メールアドレス１

string format: email
nullable <= 50 characters
email02

メールアドレス２

string format: email
nullable <= 50 characters
email03

メールアドレス３

string format: email
nullable <= 50 characters
email04

メールアドレス４

string format: email
nullable <= 50 characters
email05

メールアドレス５

string format: email
nullable <= 50 characters
email01EmailType

メールアドレス１種類

string
nullable <= 1 characters
email02EmailType

メールアドレス２種類

string
nullable <= 1 characters
email03EmailType

メールアドレス３種類

string
nullable <= 1 characters
email04EmailType

メールアドレス４種類

string
nullable <= 1 characters
email05EmailType

メールアドレス５種類

string
nullable <= 1 characters
email01MailmagaFlg

メールアドレス１メルマガ

string
nullable <= 1 characters
email02MailmagaFlg

メールアドレス２メルマガ

string
nullable <= 1 characters
email03MailmagaFlg

メールアドレス３メルマガ

string
nullable <= 1 characters
email04MailmagaFlg

メールアドレス４メルマガ

string
nullable <= 1 characters
email05MailmagaFlg

メールアドレス５メルマガ

string
nullable <= 1 characters
email01ErrorFlg

メールアドレス１送信エラーフラグ

string
nullable <= 1 characters
email02ErrorFlg

メールアドレス２送信エラーフラグ

string
nullable <= 1 characters
email03ErrorFlg

メールアドレス３送信エラーフラグ

string
nullable <= 1 characters
email04ErrorFlg

メールアドレス４送信エラーフラグ

string
nullable <= 1 characters
email05ErrorFlg

メールアドレス５送信エラーフラグ

string
nullable <= 1 characters
email01EcShopId

メールアドレス１EC店舗ID

string
nullable <= 9 characters
email02EcShopId

メールアドレス２EC店舗ID

string
nullable <= 9 characters
email03EcShopId

メールアドレス３EC店舗ID

string
nullable <= 9 characters
email04EcShopId

メールアドレス４EC店舗ID

string
nullable <= 9 characters
email05EcShopId

メールアドレス５EC店舗ID

string
nullable <= 9 characters
sex

性別

string
nullable <= 4 characters
job

お職業

string
nullable <= 50 characters
birth

生年月日

string format: date
nullable <= 10 characters
mailFlag1

サンクスメール送信可否フラグ

string
nullable <= 1 characters
mailFlag2

入金確認メール送信可否フラグ

string
nullable <= 1 characters
mailFlag3

発送完了メール送信可否フラグ

string
nullable <= 1 characters
mailFlag4

フォローメール送信可否フラグ

string
nullable <= 1 characters
mailFlag5

ステップメール送信可否フラグ

string
nullable <= 1 characters
mailFlag6

メルマガー送信可否フラグ

string
nullable <= 1 characters
mailmagaFlg

メールマガジンフラグ

string
nullable <= 1 characters
dmFlag

DMフラグ

string
nullable <= 1 characters
point

現在の通常ポイント

string
>= 1 characters <= 9 characters
blackFlag

顧客識別フラグ

string
nullable <= 50 characters
lightNote

顧客詳細

string
nullable <= 3000 characters
note

顧客備考

string
nullable <= 3000 characters
note01

顧客備考1

string
nullable <= 3000 characters
note02

顧客備考2

string
nullable <= 3000 characters
note03

顧客備考3

string
nullable <= 3000 characters
note04

顧客備考4

string
nullable <= 3000 characters
note05

顧客備考5

string
nullable <= 3000 characters
wishNote

指定-ひとことコメント

string
nullable <= 3000 characters
wishRyoushuType

指定-領収書

string
nullable <= 1 characters
wishNouhinType

指定-納品書

string
nullable <= 1 characters
wishHassoTimeId

指定-お届け時刻

string
nullable <= 9 characters
wishHassoMemo

指定-送り状記事欄

string
nullable <= 3000 characters
wishHassoDelivId

指定-配送業者

string
nullable <= 9 characters
wishNoteAttention

指定-伝達事項

string
nullable <= 3000 characters
userFlag1

ユーザーフラグ１

string
nullable <= 50 characters
userFlag2

ユーザーフラグ２

string
nullable <= 50 characters
userFlag3

ユーザーフラグ３

string
nullable <= 50 characters
customerStatus

会員ステータス

string
>= 1 characters <= 50 characters
mark1

マーク１

string
nullable <= 1 characters
mark2

マーク２

string
nullable <= 1 characters
mark3

マーク３

string
nullable <= 1 characters
createAt

登録日

string format: date-time
>= 1 characters <= 25 characters
updateAt

更新日

string format: date-time
>= 1 characters <= 25 characters
name01

顧客名(姓)

string
nullable <= 50 characters
name02

顧客名(名)

string
nullable <= 50 characters
kana01

顧客名(ﾌﾘｶﾞﾅ・姓)

string
nullable <= 50 characters
kana02

顧客名(ﾌﾘｶﾞﾅ・名)

string
nullable <= 50 characters
customerType

会員種別

string
nullable <= 50 characters
parentCustomerId

紹介者顧客ID

string
nullable <= 9 characters
parentName

紹介者名

string
nullable <= 50 characters
friendCampaignId

紹介キャンペーンコード

string
nullable <= 50 characters
friendCampaignName

紹介キャンペーン名

string
nullable <= 50 characters
firstBuyAt

初回購入日

string format: date-time
nullable <= 25 characters
lastBuyAt

最終購入日

string format: date-time
nullable <= 25 characters
lastLoginAt

最終ログイン日時

string format: date-time
nullable <= 25 characters
buyTimes

購入回数

string
nullable <= 9 characters
buyTotal

累計購入金額

string
nullable <= 9 characters
enrollmentDay

在籍日数

string
nullable <= 9 characters
dormantDay

休眠日数

string
nullable <= 9 characters
cpm0Rank

顧客CPMセグメント

string
nullable <= 50 characters
rfmRank

顧客RFMランク

string
nullable <= 9 characters
customerGroupName

顧客RFMセグメント

string
nullable <= 50 characters
cpm1FirstBuyAt

（CPM1）初回購入日

string format: date-time
nullable <= 25 characters
cpm1LastBuyAt

（CPM1）最終購入日

string format: date-time
nullable <= 25 characters
cpm1BuyTimes

（CPM1）購入回数

string
nullable <= 9 characters
cpm1BuyTotal

（CPM1）累計購入金額

string
nullable <= 9 characters
cpm1EnrollmentDay

（CPM1）在籍日数

string
nullable <= 9 characters
cpm1DormantDay

（CPM1）休眠日数

string
nullable <= 9 characters
cpm1Rank

（CPM1）顧客CPMセグメント

string
nullable <= 50 characters
cpm2FirstBuyAt

（CPM2）初回購入日

string format: date-time
nullable <= 25 characters
cpm2LastBuyAt

（CPM2）最終購入日

string format: date-time
nullable <= 25 characters
cpm2BuyTimes

（CPM2）購入回数

string
nullable <= 9 characters
cpm2BuyTotal

（CPM2）累計購入金額

string
nullable <= 9 characters
cpm2EnrollmentDay

（CPM2）在籍日数

string
nullable <= 9 characters
cpm2DormantDay

（CPM2）休眠日数

string
nullable <= 9 characters
cpm2Rank

（CPM2）顧客CPMセグメント

string
nullable <= 50 characters
cpm3FirstBuyAt

（CPM3）初回購入日

string format: date-time
nullable <= 25 characters
cpm3LastBuyAt

（CPM3）最終購入日

string format: date-time
nullable <= 25 characters
cpm3BuyTimes

（CPM3）購入回数

string
nullable <= 9 characters
cpm3BuyTotal

（CPM3）累計購入金額

string
nullable <= 9 characters
cpm3EnrollmentDay

（CPM3）在籍日数

string
nullable <= 9 characters
cpm3DormantDay

（CPM3）休眠日数

string
nullable <= 9 characters
cpm3Rank

（CPM3）顧客CPMセグメント

string
nullable <= 50 characters
cpm4FirstBuyAt

（CPM4）初回購入日

string format: date-time
nullable <= 25 characters
cpm4LastBuyAt

（CPM4）最終購入日

string format: date-time
nullable <= 25 characters
cpm4BuyTimes

（CPM4）購入回数

string
nullable <= 9 characters
cpm4BuyTotal

（CPM4）累計購入金額

string
nullable <= 9 characters
cpm4EnrollmentDay

（CPM4）在籍日数

string
nullable <= 9 characters
cpm4DormantDay

（CPM4）休眠日数

string
nullable <= 9 characters
cpm4Rank

（CPM4）顧客CPMセグメント

string
nullable <= 50 characters
cpm5FirstBuyAt

（CPM5）初回購入日

string format: date-time
nullable <= 25 characters
cpm5LastBuyAt

（CPM5）最終購入日

string format: date-time
nullable <= 25 characters
cpm5BuyTimes

（CPM5）購入回数

string
nullable <= 9 characters
cpm5BuyTotal

（CPM5）累計購入金額

string
nullable <= 9 characters
cpm5EnrollmentDay

（CPM5）在籍日数

string
nullable <= 9 characters
cpm5DormantDay

（CPM5）休眠日数

string
nullable <= 9 characters
cpm5Rank

（CPM5）顧客CPMセグメント

string
nullable <= 50 characters
jponCustomerCode

他システム顧客コード

string
nullable <= 50 characters
nextCustomerRankBuyTotal

次回ランク条件金額

string
nullable <= 9 characters
bbcMemberCode

BBC加盟店コード

string
nullable <= 9 characters
bbcCompanyName

BBC加盟店名

string
nullable <= 50 characters
memberStaffId

BBC加盟店スタッフID

string
nullable <= 9 characters
memberStaffName

BBC加盟店スタッフ名

string
nullable <= 50 characters
memberSalesChargeId

営業担当者ID

string
nullable <= 9 characters
memberSalesChargeName

営業担当者

string
nullable <= 50 characters
customerCharge

カスタマー担当者ID

string
nullable <= 9 characters
customerChargeName

カスタマー担当者

string
nullable <= 50 characters
Examples
Exampledefault
[
  {
    "customerId": "1",
    "companyName": null,
    "companyDepartment": null,
    "customerName": "山田 太郎",
    "customerKana": "ヤマダ タロウ",
    "country": "日本",
    "zip": "910-0015",
    "pref": "福井県",
    "addr01": "福井市",
    "addr02": "順化町11-9",
    "tel": "09000000000",
    "tel2": null,
    "fax": null,
    "email01": null,
    "email02": null,
    "email03": null,
    "email04": null,
    "email05": null,
    "email01EmailType": "1",
    "email02EmailType": null,
    "email03EmailType": null,
    "email04EmailType": null,
    "email05EmailType": null,
    "email01MailmagaFlg": "1",
    "email02MailmagaFlg": null,
    "email03MailmagaFlg": null,
    "email04MailmagaFlg": null,
    "email05MailmagaFlg": null,
    "email01ErrorFlg": "0",
    "email02ErrorFlg": "0",
    "email03ErrorFlg": "0",
    "email04ErrorFlg": "0",
    "email05ErrorFlg": "0",
    "email01EcShopId": null,
    "email02EcShopId": null,
    "email03EcShopId": null,
    "email04EcShopId": null,
    "email05EcShopId": null,
    "sex": "男性",
    "job": null,
    "birth": null,
    "mailFlag1": "0",
    "mailFlag2": "0",
    "mailFlag3": "0",
    "mailFlag4": "0",
    "mailFlag5": "0",
    "mailFlag6": "0",
    "mailmagaFlg": "1",
    "dmFlag": "0",
    "point": "-54",
    "blackFlag": "なし",
    "lightNote": null,
    "note": null,
    "note01": null,
    "note02": null,
    "note03": null,
    "note04": null,
    "note05": null,
    "wishNote": null,
    "wishRyoushuType": null,
    "wishNouhinType": null,
    "wishHassoTimeId": null,
    "wishHassoMemo": null,
    "wishHassoDelivId": null,
    "wishNoteAttention": null,
    "userFlag1": null,
    "userFlag2": null,
    "userFlag3": null,
    "customerStatus": "本会員",
    "mark1": "0",
    "mark2": "0",
    "mark3": "0",
    "createAt": "2021-10-21T15:58:16+09:00",
    "updateAt": "2025-03-13T18:30:23+09:00",
    "name01": "山田",
    "name02": "太郎",
    "kana01": "ヤマダ",
    "kana02": "タロウ",
    "customerType": "2",
    "parentCustomerId": null,
    "parentName": null,
    "friendCampaignId": null,
    "friendCampaignName": null,
    "firstBuyAt": "2021-10-20T11:47:48+09:00",
    "lastBuyAt": "2021-10-21T17:57:03+09:00",
    "lastLoginAt": null,
    "buyTimes": "3",
    "buyTotal": "16000",
    "enrollmentDay": "1",
    "dormantDay": "1239",
    "cpm0Rank": "超優良顧客",
    "rfmRank": "5",
    "customerGroupName": "優良リピート顧客",
    "cpm1FirstBuyAt": "2021-10-20T11:47:48+09:00",
    "cpm1LastBuyAt": "2021-10-21T17:57:03+09:00",
    "cpm1BuyTimes": "3",
    "cpm1BuyTotal": "16000",
    "cpm1EnrollmentDay": "1",
    "cpm1DormantDay": "1239",
    "cpm1Rank": "超優良顧客",
    "cpm2FirstBuyAt": null,
    "cpm2LastBuyAt": null,
    "cpm2BuyTimes": "0",
    "cpm2BuyTotal": "0",
    "cpm2EnrollmentDay": "0",
    "cpm2DormantDay": "0",
    "cpm2Rank": null,
    "cpm3FirstBuyAt": null,
    "cpm3LastBuyAt": null,
    "cpm3BuyTimes": "0",
    "cpm3BuyTotal": "0",
    "cpm3EnrollmentDay": "0",
    "cpm3DormantDay": "0",
    "cpm3Rank": null,
    "cpm4FirstBuyAt": null,
    "cpm4LastBuyAt": null,
    "cpm4BuyTimes": "0",
    "cpm4BuyTotal": "0",
    "cpm4EnrollmentDay": "0",
    "cpm4DormantDay": "0",
    "cpm4Rank": null,
    "cpm5FirstBuyAt": null,
    "cpm5LastBuyAt": null,
    "cpm5BuyTimes": "0",
    "cpm5BuyTotal": "0",
    "cpm5EnrollmentDay": "0",
    "cpm5DormantDay": "0",
    "cpm5Rank": null,
    "jponCustomerCode": null,
    "nextCustomerRankBuyTotal": null,
    "bbcMemberCode": null,
    "bbcCompanyName": null,
    "memberStaffId": null,
    "memberStaffName": null,
    "memberSalesChargeId": null,
    "memberSalesChargeName": null,
    "customerCharge": null,
    "customerChargeName": null
  }
]

Headers

Section titled “Headers”
Link
string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

Section titled “400”
  • limitが範囲外の場合
  • pageが範囲外の場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜1000の範囲で入力してください",
  "status": 400
}

500

Section titled “500”

サーバー内部エラー

Media typeapplication/json
object
type
required
string
title
required
string
detail
One of:
string
status
integer
Examples
Exampledefault
{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}