顧客(customer)
顧客に関する情報の登録・更新・取得・削除ができます。
レコードのidの取得にはSearch APIが使用できます。
顧客取得
必要な権限
顧客参照
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/customer/{id}
HTTP Method
GET
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
顧客登録
必要な権限
顧客登録
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/customer
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | customers.customer.customer_type | 顧客タイプ | string | 顧客タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 2 | customers.customer.customer_logo | 顧客ロゴ | object | ||
| - fileid | ファイルID | string | 事前にcmsにアップロードしたfileIdを指定 | ||
| 3 | customers.customer.customer_name | 顧客名 | |||
| 4 | customers.customer.customer_name_other | 顧客名(かな) | string | ||
| 5 | customers.customer.existing_flg | 存続フラグ | string | "存続", "倒産"のいずれか | |
| 6 | customers.customer.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 7 | customers.customer.tel_no | 電話番号 | string | ||
| 8 | customers.customer.url | URL | string | ||
| 9 | customers.customer.relational_business_card_info | 顧客コンタクト先 | array(object) | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.id | 顧客コンタクト先ID | number | 新規登録の場合はnull, 更新の場合は値指定 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | テキスト名刺に値を設定する場合は、項目自体不要 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | |||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | 紐づき名刺IDに値を設定する場合は、項目自体不要 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.motivation | 意向 | string | 意向マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | trueと指定できるものは一つのみ | ||
| 10 | customers.customer.relational_parent_customer | 紐づき親顧客 | number | ||
| 11 | customers.customer.relational_trading_product | 紐づき取引商品 | array(number) | ||
| 12 | customers.customer.relational_milestone | 顧客シナリオ | array(number) | ||
| 13 | customers.customer.business_type | 業種(選択) | array(string) | ユーザー設定の選択肢名 | |
| 14 | customers.customer.memo | 詳細内容 | string | ||
| 15 | customers.customer.charge_employee @customers.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。 | |
| 16 | customers.customer.charge_employee @customers.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者も含む。 | |
| 17 | customers.customer.charge_department @customers.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。 | |
| 18 | customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署も含む。 | |
| 19 | customers.customer.charge_group @customers.charge_group.main_charge | 主担当グループID | number | グループIDを指定。 | |
| 20 | customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループも含む。 | |
| 21 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"customers.customer.customer_type": "法人",
"customers.customer.customer_logo": {
"fileid": "cd234bbefe27496fa67be84bbd403de8"
},
"customers.customer.customer_name": "ソフトブレーン株式会社",
"customers.customer.customer_name_other": "ソフトブレーン",
"customers.customer.existing_flg": "存続",
"customers.customer.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"customers.customer.tel_no": "0917385793",
"customers.customer.url": "https://www.softbrain.co.jp/",
"customers.customer.relational_business_card_info": [
{
"customers.customer.relational_business_card_info@business_cards.business_card_info.id": 123,
"customers.customer.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"customers.customer.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"customers.customer.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"customers.customer.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"customers.customer.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"customers.customer.relational_business_card_info@business_cards.business_card_info.relational_businesscard": 123
}
],
"customers.customer.relational_parent_customer": 123,
"customers.customer.relational_trading_product": [
123
],
"customers.customer.relational_milestone": [
123
],
"customers.customer.business_type": [
"一般対応"
],
"customers.customer.memo": "メモ",
"customers.customer.charge_employee@customers.charge_employee.main_charge": 123,
"customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
123,
456
],
"customers.customer.charge_department@customers.charge_department.main_charge": 123,
"customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
123,
456
],
"customers.customer.charge_group@customers.charge_group.main_charge": 123,
"customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
123,
456
]
}
顧客更新
必要な権限
顧客変更
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/customer/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | customers.customer.customer_type | 顧客タイプ | string | 顧客タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 2 | customers.customer.customer_logo | 顧客ロゴ | object | 事前にcmsにアップロードしたfileIdを指定 | |
| - fileid | ファイルID | string | |||
| 3 | customers.customer.customer_name | 顧客名 | |||
| 4 | customers.customer.customer_name_other | 顧客名(かな) | string | ||
| 5 | customers.customer.existing_flg | 存続フラグ | string | "存続", "倒産"のいずれか | |
| 6 | customers.customer.address | 住所 | object | ||
| - zipcode | 郵便番号 | string | |||
| - country | 国 | string | |||
| - street | 番地 | string | |||
| - building | 建物 | string | |||
| 7 | customers.customer.tel_no | 電話番号 | string | ||
| 8 | customers.customer.url | URL | string | ||
| 9 | customers.customer.relational_business_card_info | 顧客コンタクト先 | array(object) | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.id | 顧客コンタクト先ID | number | 新規登録の場合はnull, 更新の場合は値指定 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | テキスト名刺に値を設定する場合は、項目自体不要 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | |||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | 紐づき名刺IDに値を設定する場合は、項目自体不要 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.motivation | 意向 | string | 意向マスタの設定値 | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | trueと指定できるものは一つのみ | ||
| 10 | customers.customer.relational_parent_customer | 紐づき親顧客 | number | ||
| 11 | customers.customer.relational_trading_product | 紐づき取引商品 | array(number) | ||
| 12 | customers.customer.relational_milestone | 顧客シナリオ | array(number) | ||
| 13 | customers.customer.business_type | 業種(選択) | array(string) | ユーザー設定の選択肢名 | |
| 14 | customers.customer.memo | 詳細内容 | string | ||
| 15 | customers.customer.charge_employee @customers.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。 | |
| 16 | customers.customer.charge_employee @customers.charget_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者も含む。 | |
| 17 | customers.customer.charge_department @customers.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。 | |
| 18 | customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署も含む。 | |
| 19 | customers.customer.charge_group @customers.charge_group.main_charge | 主担当グループID | number | グループIDを指定。 | |
| 20 | customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループも含む。 | |
| 21 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"customers.customer.customer_type": "法人",
"customers.customer.customer_logo": {
"fileid": "cd234bbefe27496fa67be84bbd403de8"
},
"customers.customer.customer_name": "ソフトブレーン株式会社",
"customers.customer.customer_name_other": "メモ",
"customers.customer.existing_flg": "存続",
"customers.customer.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"customers.customer.tel_no": "0917385793",
"customers.customer.url": "https://www.softbrain.co.jp/",
"customers.customer.relational_business_card_info": [
{
"customers.customer.relational_business_card_info@business_cards.business_card_info.id": 123,
"customers.customer.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"customers.customer.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"customers.customer.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"customers.customer.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"customers.customer.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"customers.customer.relational_business_card_info@business_cards.business_card_info.relational_businesscard": 123
}
],
"customers.customer.relational_parent_customer": 123,
"customers.customer.relational_trading_product": [
123
],
"customers.customer.relational_milestone": [
123
],
"customers.customer.business_type": [
"一般対応"
],
"customers.customer.memo": "a",
"customers.customer.charge_employee@customers.charge_employee.main_charge": 123,
"customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
123,
456
],
"customers.customer.charge_department@customers.charge_department.main_charge": 123,
"customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
123,
456
],
"customers.customer.charge_group@customers.charge_group.main_charge": 123,
"customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
123,
456
]
}
顧客削除
必要な権限
顧客削除・顧客一括削除
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/customer/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | customers.customer.id | 顧客ID | number | |
| 2 | customers.customer.customer_type | 顧客タイプ | string | 顧客タイプマスタの選択肢名 |
| 3 | customers.customer.customer_logo | 顧客ロゴ | object | 取得したfileIdを使って、cmsからファイルをダウンロード可能 |
| - fileid | ファイルID | string | ||
| - filename | ファイル名 | string | ||
| 4 | customers.customer.customer_name | 顧客名 | string | |
| 5 | customers.customer.customer_name_other | 顧客名(かな) | string | |
| 6 | customers.customer.existing_flg | 存続フラグ | string | "存続", "倒産"のいずれか |
| 7 | customers.customer.address | 住所 | object | |
| - zipcode | 郵便番号 | string | ||
| - country | 国 | string | ||
| - street | 番地 | string | ||
| - building | 建物 | string | ||
| 8 | customers.customer.tel_no | 電話番号 | string | |
| 9 | customers.customer.url | URL | string | |
| 10 | customers.customer.relational_business_card_info | 顧客コンタクト先 | array(object) | |
| - customers.customer.relational_business_card_info @business_cards.business_card_info.id | 顧客コンタクト先ID | number | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.contact_master | コンタクト先 | string | コンタクト先マスタの設定値 | |
| - customers.customer.relational_business_card_info @business_cards.business_card_info.relational_businesscard | 紐づき名刺ID | number | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.valid_contact_date | 有効接触日 | string | "yyyy/mm/dd"形式の日付 | |
| - customers.customer.relational_business_card_info @business_cards.business_card_info.remarks | 備考 | string | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.text_business_card_name | テキスト名刺 | string | ||
| - customers.customer.relational_business_card_info @business_cards.business_card_info.position | 立ち位置 | string | 立ち位置マスタの設定値 | |
| - customers.customer.relational_business_card_info @business_cards.business_card_info.motivation | 意向 | string | 意向マスタの設定値 | |
| - customers.customer.relational_business_card_info @business_cards.business_card_info.counter | 窓口 | boolean | ||
| 11 | customers.customer.relational_parent_customer | 紐づき親顧客 | number | |
| 12 | customers.customer.relational_trading_product | 紐づき取引商品 | array(number) | |
| 13 | customers.customer.relational_milestone | 顧客シナリオ | array(number) | |
| 14 | customers.customer.business_type | 業種(選択) | array(string) | ユーザー設定の選択肢名 |
| 15 | customers.customer.memo | 詳細内容 | string | |
| 16 | customers.customer.charge_employee @customers.charge_employee.main_charge | 主担当者ID | number | |
| 17 | customers.customer.charge_employee @customers.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 主担当者はこちらにも含まれる。 |
| 18 | customers.customer.charge_department @customers.charge_department.main_charge | 主担当部署ID | number | |
| 19 | customers.customer.charge_department @customers.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 主担当部署はこちらにも含まれる。 |
| 20 | customers.customer.charge_group @customers.charge_group.main_charge | 主担当グループID | number | |
| 21 | customers.customer.charge_group @customers.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | 主担当グループはこちらにも含まれる。 |
| 22 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 23 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ |
| 24 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ |
| 25 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 26 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ |
| 27 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID ※取得のみ |
| 28 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のページを参照する |
Example
{
"customers.customer.id": 123,
"customers.customer.customer_type": "法人",
"customers.customer.customer_logo": {
"fileid": "cd234bbefe27496fa67be84bbd403de8",
"filename": "file.jpg"
},
"customers.customer.customer_name": "ソフトブレーン株式会社",
"customers.customer.customer_name_other": "メモ",
"customers.customer.existing_flg": "存続",
"customers.customer.address": {
"street": "東京都中央区銀座6-18-2",
"country": "JPN",
"zipcode": "03-6779-98",
"building": "野村不動産銀座ビル 11階"
},
"customers.customer.tel_no": "0917385793",
"customers.customer.url": "https://www.softbrain.co.jp/",
"customers.customer.relational_business_card_info": [
{
"customers.customer.relational_business_card_info@business_cards.business_card_info.id": 123,
"customers.customer.relational_business_card_info@business_cards.business_card_info.contact_master": "キーマン",
"customers.customer.relational_business_card_info@business_cards.business_card_info.remarks": "メモ",
"customers.customer.relational_business_card_info@business_cards.business_card_info.text_business_card_name": null,
"customers.customer.relational_business_card_info@business_cards.business_card_info.position": "決裁者",
"customers.customer.relational_business_card_info@business_cards.business_card_info.motivation": "前向き",
"customers.customer.relational_business_card_info@business_cards.business_card_info.relational_businesscard": 123
}
],
"customers.customer.relational_parent_customer": 123,
"customers.customer.relational_trading_product": [
123
],
"customers.customer.relational_milestone": [
123
],
"customers.customer.business_type": [
"一般対応"
],
"customers.customer.memo": "a",
"customers.customer.charge_employee@customers.charge_employee.main_charge": 123,
"customers.customer.charge_employee@customers.charge_employee.target_employee@employees.employee.id": [
123
],
"customers.customer.charge_department@customers.charge_department.main_charge": 123,
"customers.customer.charge_department@customers.charge_department.target_department@employees.department.id": [
123
],
"customers.customer.charge_group@customers.charge_group.main_charge": 123,
"customers.customer.charge_group@customers.charge_group.target_group@employees.group.id": [
123
],
"system_reg_date": "2024/01/01 00:00",
"system_reg_user": 123,
"system_reg_employee": 456,
"system_upd_date": "2024/01/02 00:00",
"system_upd_user": 123,
"system_upd_employee": 456
}