Skip to content

顧客を検索する#

Description#

リクエストパラメータを検索条件として該当する顧客情報を検索します。

Method#

GET

Request Header#

共通リクエストヘッダーを参照してください。

Argument#

Name Type Required Length
（Long /Decimalの場合はValue）		 URI Query String Description
customer_id String 15
～
1007		 - ○ 複数指定顧客ＩＤ
顧客を一意に識別するＩＤ
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定。
customer_name1 String 1
～
128		 - ○ 顧客名１
customer_name2 String 1
～
128		 - ○ 顧客名２
customer_name3 String 1
～
128		 - ○ 顧客名３
customer_name4 String 1
～
128		 - ○ 顧客名４
customer_name5 String 1
～
128		 - ○ 顧客名５
customer_name6 String 1
～
128		 - ○ 顧客名６
company_name String 1
～
64		 - ○ 会社名
group_id String 8 - ○ グループＩＤ
グループを一意に識別するＩＤ
email_address1 String 1
～
256		 - ○ メールアドレス１
メールアドレス形式
email_address2 String 1
～
256		 - ○ メールアドレス２
メールアドレス形式
status String 1
～
59		 - ○ ステータス
ステータスを表す任意のコード値を設定可能
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定
例) 000:仮登録、001:本登録、999:解約
business_date String 8 - ○ 業務日付
yyyyMMdd形式
temporary_registration_date_and_time_from String 8 - ○ 仮登録日時Ｆｒｏｍ
yyyyMMdd形式
temporary_registration_date_and_time_to String 8 - ○ 仮登録日時Ｔｏ
yyyyMMdd形式
official_registration_date_and_time_from String 8 - ○ 本登録日時Ｆｒｏｍ
yyyyMMdd形式
official_registration_date_and_time_to String 8 - ○ 本登録日時Ｔｏ
yyyyMMdd形式
cancellation_date_and_time_from String 8 - ○ 解約日時Ｆｒｏｍ
yyyyMMdd形式
cancellation_date_and_time_to String 8 - ○ 解約日時Ｔｏ
yyyyMMdd形式
free_item1 String 1
～
1000		 - ○ フリー項目１
free_item2 String 1
～
1000		 - ○ フリー項目２
free_item3 String 1
～
1000		 - ○ フリー項目３
free_item4 String 1
～
1000		 - ○ フリー項目４
free_item5 String 1
～
1000		 - ○ フリー項目５
free_item6 String 1
～
1000		 - ○ フリー項目６
free_item7 String 1
～
1000		 - ○ フリー項目７
free_item8 String 1
～
1000		 - ○ フリー項目８
free_item9 String 1
～
1000		 - ○ フリー項目９
free_item10 String 1
～
1000		 - ○ フリー項目１０
sort_item1 String 1
～
40		 - ○ ソート項目名１
sort1 String 1 - ○ ソート順１
sort_item2 String 1
～
40		 - ○ ソート項目名２
sort2 String 1 - ○ ソート順２
sort_item3 String 1
～
40		 - ○ ソート項目名３
sort3 String 1 - ○ ソート順３
start_position Long 1
～
9999999		 - ○ 開始位置
共通仕様はこちらを参照
end_position Long 1
～
9999999		 - ○ 終了位置
共通仕様はこちらを参照

URI#

/API/v2/api/customers

Sample request uri#

業務日付、顧客名１を指定しての検索

/API/v2/api/customers?business_date=20150801&customer_name1=顧客名１

Parameters in request body#

なし

Return Codes#

Code Description
200 レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。
401 認証エラー。API認証時のエラー。
403 アクセス不可。
404 対象なし。対象の情報が見つからない場合。
500 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。

Response Header#

なし

Response Parameter#

共通仕様はこちらを参照してください。

  • レスポンス（正常）

Example#

Parameters#

Top