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
- 複数指定顧客ID
顧客を一意に識別するID
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定。
customer_name1 String 1

128
- 顧客名1
customer_name2 String 1

128
- 顧客名2
customer_name3 String 1

128
- 顧客名3
customer_name4 String 1

128
- 顧客名4
customer_name5 String 1

128
- 顧客名5
customer_name6 String 1

128
- 顧客名6
company_name String 1

64
- 会社名
group_id String 8 - グループID
グループを一意に識別するID
email_address1 String 1

256
- メールアドレス1
メールアドレス形式
email_address2 String 1

256
- メールアドレス2
メールアドレス形式
status String 1

59
- ステータス
ステータスを表す任意のコード値を設定可能
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定
例) 000:仮登録、001:本登録、999:解約
business_date String 8 - 業務日付
yyyyMMdd形式
temporary_registration_date_and_time_from String 8 - 仮登録日時From
yyyyMMdd形式
temporary_registration_date_and_time_to String 8 - 仮登録日時To
yyyyMMdd形式
official_registration_date_and_time_from String 8 - 本登録日時From
yyyyMMdd形式
official_registration_date_and_time_to String 8 - 本登録日時To
yyyyMMdd形式
cancellation_date_and_time_from String 8 - 解約日時From
yyyyMMdd形式
cancellation_date_and_time_to String 8 - 解約日時To
yyyyMMdd形式
free_item1 String 1

1000
- フリー項目1
free_item2 String 1

1000
- フリー項目2
free_item3 String 1

1000
- フリー項目3
free_item4 String 1

1000
- フリー項目4
free_item5 String 1

1000
- フリー項目5
free_item6 String 1

1000
- フリー項目6
free_item7 String 1

1000
- フリー項目7
free_item8 String 1

1000
- フリー項目8
free_item9 String 1

1000
- フリー項目9
free_item10 String 1

1000
- フリー項目10
sort_item1 String 1

40
- ソート項目名1
sort1 String 1 - ソート順1
sort_item2 String 1

40
- ソート項目名2
sort2 String 1 - ソート順2
sort_item3 String 1

40
- ソート項目名3
sort3 String 1 - ソート順3
start_position Long 1

9999999
- 開始位置
共通仕様はこちらを参照
end_position Long 1

9999999
- 終了位置
共通仕様はこちらを参照

URI#

/API/v2/api/customers

Sample request uri#

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

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

Parameters in request body#

なし

Return Codes#

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

Response Header#

なし

Response Parameter#

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

  • レスポンス(正常)

Example#

Parameters#

Top