Elead Sales Customers (プレビュー)
この API を使用すると、Elead CRM 内の見込顧客/顧客情報を管理できます。 この API には、見込顧客/顧客の情報を管理するために次の機能が含まれています。名前、電話番号、メール アドレス、実際の住所など、見込顧客/顧客の情報を追加したり、POST 時に一意に割り当てられた Elead ID を返したり、既存の Elead ID に結び付けられた見込顧客/顧客の連絡先情報の更新、検索、取得を行ったりすることができます。
このコネクタは、次の製品および地域で利用可能です。
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | CDK Global |
[URL] | https://serviceconnect.support.cdk.com |
メール | mbd_support@cdk.com |
Connector Metadata | |
---|---|
発行者 | CDK Global |
Web サイト | https://fortellis.io |
プライバシー ポリシー | https://fortellis.io/privacy |
カテゴリ | データ |
この API の機能
この API を使用すると、Elead CRM 内の見込顧客/顧客情報を管理できます。
対象ユーザー
この API は、Elead CRM 内で見込顧客/顧客データを管理する必要があるディーラーおよびベンダーパートナー向けです。
機能と特徴
この API には、見込顧客/顧客情報を管理するための次の機能が含まれています。
- 名前、電話番号、電子メール アドレス、住所などの見込顧客/顧客情報を追加します
- 既存の Elead ID に関連付けられている見込顧客/顧客の連絡先情報を更新します
- Elead ID で見込顧客/顧客を取得します
- 名前、電子メール アドレス、または電話番号で見込顧客/顧客を検索します
- Elead ID で見込顧客/顧客所有の車両を取得します
前提条件
続行するには、次のものが必要です
- コネクタを使用するには、Fortellis ユーザーである必要があります
- API の呼び出し中に使用されるクライアント ID とシークレットを生成するには、Fortellis でソリューションを作成する必要があります
詳細なドキュメントは次のサイトで確認できます
https://apidocs.fortellis.io/specs/ba092364-accc-4ad9-865f-fac51c34cdb1
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
ID で車両を取得する |
Elead 顧客 ID によって見込顧客/顧客車両レコードを取得します。 Elead の顧客 ID は現在、次のように取得されます。
|
ID で顧客を取得する |
Elead 顧客 ID によって見込顧客/顧客レコードを取得します。 Elead の顧客 ID は現在、次のように取得されます。
|
顧客の検索 |
顧客の検索 |
顧客を作成する |
見込顧客/顧客を作成する |
顧客を更新する |
見込顧客/顧客情報を更新する |
ID で車両を取得する
Elead 顧客 ID によって見込顧客/顧客車両レコードを取得します。 Elead の顧客 ID は現在、次のように取得されます。
POST/sales/v1/elead/customers によって顧客を作成します
GET/sales/v1/elead/Opportunities/search によって営業案件を検索します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
顧客 ID
|
customerId | True | string |
形式 - UUID。 |
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。 |
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。 |
サブスクリプション ID
|
subscription_id | True | string |
指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。 |
承認
|
Accept | string |
ヘッダーの承諾 |
|
Charset の承諾
|
Accept-Charset | string |
Charset の承諾ヘッダー |
|
エンコードの承諾
|
Accept-Encoding | string |
エンコードの承諾ヘッダー |
|
言語の承諾
|
Accept-Language | string |
言語の承諾ヘッダー |
|
If-Match
|
If-Match | string |
If-Match ヘッダー |
|
If-None-Match
|
If-None-Match | string |
If-None-Match ヘッダー |
|
優先
|
Prefer | string |
優先する顧客 |
|
要求 ID
|
Request-Id | True | string |
形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID |
戻り値
ID で顧客を取得する
Elead 顧客 ID によって見込顧客/顧客レコードを取得します。 Elead の顧客 ID は現在、次のように取得されます。
POST/sales/v1/elead/customers によって顧客を作成します
GET/sales/v1/elead/Opportunities/search によって営業案件を検索します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
顧客 ID
|
customerId | True | string |
形式 - UUID。 |
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。 |
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。 |
サブスクリプション ID
|
subscription_id | True | string |
指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。 |
承認
|
Accept | string |
ヘッダーの承諾 |
|
Charset の承諾
|
Accept-Charset | string |
Charset の承諾ヘッダー |
|
エンコードの承諾
|
Accept-Encoding | string |
エンコードの承諾ヘッダー |
|
言語の承諾
|
Accept-Language | string |
言語の承諾ヘッダー |
|
If-Match
|
If-Match | string |
If-Match ヘッダー |
|
If-None-Match
|
If-None-Match | string |
If-None-Match ヘッダー |
|
優先
|
Prefer | string |
優先する顧客 |
|
要求 ID
|
Request-Id | True | string |
形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID |
戻り値
- 本文
- Customer
顧客の検索
顧客の検索
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページ
|
page | integer |
形式 - int32。 |
|
ページ サイズ
|
pageSize | integer |
形式 - int32。 |
|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。 |
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。 |
サブスクリプション ID
|
subscription_id | True | string |
指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。 |
承認
|
Accept | string |
ヘッダーの承諾 |
|
Charset の承諾
|
Accept-Charset | string |
Charset の承諾ヘッダー |
|
エンコードの承諾
|
Accept-Encoding | string |
エンコードの承諾ヘッダー |
|
言語の承諾
|
Accept-Language | string |
言語の承諾ヘッダー |
|
If-Match
|
If-Match | string |
If-Match ヘッダー |
|
If-None-Match
|
If-None-Match | string |
If-None-Match ヘッダー |
|
優先
|
Prefer | string |
優先する顧客 |
|
要求 ID
|
Request-Id | True | string |
形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID |
firstName
|
firstName | string |
顧客の名の文字列を検索する |
|
lastName
|
lastName | string |
顧客の姓の文字列を検索する |
|
phoneNumber
|
phoneNumber | string |
顧客の電話番号の文字列を検索する |
|
emailAddress
|
emailAddress | string |
顧客のメール アドレスの文字列を検索する |
戻り値
顧客を作成する
見込顧客/顧客を作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。 |
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。 |
サブスクリプション ID
|
subscription_id | True | string |
指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。 |
承認
|
Accept | string |
ヘッダーの承諾 |
|
Charset の承諾
|
Accept-Charset | string |
Charset の承諾ヘッダー |
|
エンコードの承諾
|
Accept-Encoding | string |
エンコードの承諾ヘッダー |
|
言語の承諾
|
Accept-Language | string |
言語の承諾ヘッダー |
|
If-Match
|
If-Match | string |
If-Match ヘッダー |
|
If-None-Match
|
If-None-Match | string |
If-None-Match ヘッダー |
|
優先
|
Prefer | string |
優先する顧客 |
|
要求 ID
|
Request-Id | True | string |
形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID |
isBusiness
|
isBusiness | boolean |
この顧客が事業かどうかを示す true/false |
|
businessName
|
businessName | string |
事業名 (isBusiness が true の場合に設定される) |
|
businessContact
|
businessContact | string |
業務担当者の名前 (isBusiness が true の場合に設定される) |
|
タイトル
|
title | string |
顧客のタイトル |
|
firstName
|
firstName | string |
顧客の名 |
|
middleName
|
middleName | string |
顧客のミドル ネーム |
|
lastName
|
lastName | string |
顧客の姓 |
|
nickname
|
nickname | string |
顧客のニックネーム |
|
生年月日
|
birthday | date-time |
顧客の生年月日 |
|
アドレス
|
address | True | string |
顧客のメール アドレス |
emailType
|
emailType | True | string | |
doNotEmail
|
doNotEmail | boolean |
メール送信不可を示す true/false |
|
isPreferred
|
isPreferred | boolean |
顧客の優先メール アドレスかどうかを示す true/false |
|
数値
|
number | True | string |
電話番号 |
phoneType
|
phoneType | True | string | |
preferredTimeToContact
|
preferredTimeToContact | True | string | |
doNotCall
|
doNotCall | boolean |
電話連絡不可を示す true/false |
|
doNotText
|
doNotText | boolean |
ショート メッセージ不可を示す true/false |
|
preferCall
|
preferCall | boolean |
顧客が電話連絡を希望するかどうかを示す true/false |
|
preferText
|
preferText | boolean |
顧客がショート メッセージでの連絡を希望するかどうかを示す true/false |
|
addressLine1
|
addressLine1 | string |
顧客住所 1 |
|
addressLine2
|
addressLine2 | string |
顧客住所 2 |
|
city
|
city | string |
顧客の市区町村 |
|
状態
|
state | string |
顧客の都道府県 |
|
郵便番号
|
zip | True | string |
顧客の郵便番号 |
country
|
country | string |
顧客の国 |
|
county
|
county | string |
顧客の郡 |
|
doNotMail
|
doNotMail | boolean |
郵送不可を示す true/false |
|
isPreferred
|
isPreferred | boolean |
顧客の優先住所かどうかを示す true/false |
戻り値
- 本文
- Customer
顧客を更新する
見込顧客/顧客情報を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
顧客 ID
|
customerId | True | string |
形式 - UUID。 |
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。 |
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。 |
サブスクリプション ID
|
subscription_id | True | string |
指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。 |
承認
|
Accept | string |
ヘッダーの承諾 |
|
Charset の承諾
|
Accept-Charset | string |
Charset の承諾ヘッダー |
|
エンコードの承諾
|
Accept-Encoding | string |
エンコードの承諾ヘッダー |
|
言語の承諾
|
Accept-Language | string |
言語の承諾ヘッダー |
|
If-Match
|
If-Match | string |
If-Match ヘッダー |
|
If-None-Match
|
If-None-Match | string |
If-None-Match ヘッダー |
|
優先
|
Prefer | string |
優先する顧客 |
|
要求 ID
|
Request-Id | True | string |
形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID |
isBusiness
|
isBusiness | boolean |
この顧客が事業かどうかを示す true/false |
|
businessName
|
businessName | string |
事業名 (isBusiness が true の場合に設定される) |
|
businessContact
|
businessContact | string |
業務担当者の名前 (isBusiness が true の場合に設定される) |
|
タイトル
|
title | string |
顧客のタイトル |
|
firstName
|
firstName | string |
顧客の名 |
|
middleName
|
middleName | string |
顧客のミドル ネーム |
|
lastName
|
lastName | string |
顧客の姓 |
|
nickname
|
nickname | string |
顧客のニックネーム |
|
生年月日
|
birthday | date-time |
顧客の生年月日 |
|
アドレス
|
address | True | string |
顧客のメール アドレス |
emailType
|
emailType | True | string | |
doNotEmail
|
doNotEmail | boolean |
メール送信不可を示す true/false |
|
isPreferred
|
isPreferred | boolean |
顧客の優先メール アドレスかどうかを示す true/false |
|
数値
|
number | True | string |
電話番号 |
phoneType
|
phoneType | True | string | |
preferredTimeToContact
|
preferredTimeToContact | True | string | |
doNotCall
|
doNotCall | boolean |
電話連絡不可を示す true/false |
|
doNotText
|
doNotText | boolean |
ショート メッセージ不可を示す true/false |
|
preferCall
|
preferCall | boolean |
顧客が電話連絡を希望するかどうかを示す true/false |
|
preferText
|
preferText | boolean |
顧客がショート メッセージでの連絡を希望するかどうかを示す true/false |
|
addressLine1
|
addressLine1 | string |
顧客住所 1 |
|
addressLine2
|
addressLine2 | string |
顧客住所 2 |
|
city
|
city | string |
顧客の市区町村 |
|
状態
|
state | string |
顧客の都道府県 |
|
郵便番号
|
zip | True | string |
顧客の郵便番号 |
country
|
country | string |
顧客の国 |
|
county
|
county | string |
顧客の郡 |
|
doNotMail
|
doNotMail | boolean |
郵送不可を示す true/false |
|
isPreferred
|
isPreferred | boolean |
顧客の優先住所かどうかを示す true/false |
戻り値
- 本文
- Customer
定義
顧客
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | uuid |
一意の顧客識別子 |
isBusiness
|
isBusiness | boolean |
この顧客が事業かどうかを示す true/false |
businessName
|
businessName | string |
事業名 (isBusiness が true の場合に設定される) |
businessContact
|
businessContact | string |
業務担当者の名前 (isBusiness が true の場合に設定される) |
タイトル
|
title | string |
顧客のタイトル |
firstName
|
firstName | string |
顧客の名 |
middleName
|
middleName | string |
顧客のミドル ネーム |
lastName
|
lastName | string |
顧客の姓 |
nickname
|
nickname | string |
顧客のニックネーム |
生年月日
|
birthday | date-time |
顧客の生年月日 |
電子メール
|
emails | array of CustomerEmail |
顧客の電子メール アドレス |
電話
|
phones | array of CustomerPhone |
顧客の電話番号 |
アドレス
|
address | CustomerAddress | |
リンク
|
links | array of LinkDescriptionObject |
HATEOAS リンクのコレクション |
CustomerEmail
名前 | パス | 型 | 説明 |
---|---|---|---|
アドレス
|
address | string |
顧客のメール アドレス |
emailType
|
emailType | string | |
doNotEmail
|
doNotEmail | boolean |
メール送信不可を示す true/false |
isPreferred
|
isPreferred | boolean |
顧客の優先メール アドレスかどうかを示す true/false |
CustomerPhone
名前 | パス | 型 | 説明 |
---|---|---|---|
数値
|
number | string |
電話番号 |
phoneType
|
phoneType | string | |
preferredTimeToContact
|
preferredTimeToContact | string | |
doNotCall
|
doNotCall | boolean |
電話連絡不可を示す true/false |
doNotText
|
doNotText | boolean |
ショート メッセージ不可を示す true/false |
preferCall
|
preferCall | boolean |
顧客が電話連絡を希望するかどうかを示す true/false |
preferText
|
preferText | boolean |
顧客がショート メッセージでの連絡を希望するかどうかを示す true/false |
CustomerAddress
名前 | パス | 型 | 説明 |
---|---|---|---|
addressLine1
|
addressLine1 | string |
顧客住所 1 |
addressLine2
|
addressLine2 | string |
顧客住所 2 |
city
|
city | string |
顧客の市区町村 |
状態
|
state | string |
顧客の都道府県 |
郵便番号
|
zip | string |
顧客の郵便番号 |
country
|
country | string |
顧客の国 |
county
|
county | string |
顧客の郡 |
doNotMail
|
doNotMail | boolean |
郵送不可を示す true/false |
isPreferred
|
isPreferred | boolean |
顧客の優先住所かどうかを示す true/false |
SearchCustomersResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
項目
|
items | array of SearchCustomer |
顧客検索結果のコレクション |
totalItems
|
totalItems | integer |
指定された検索の顧客の合計数 |
totalPages
|
totalPages | integer |
指定された検索の顧客のページの合計数 |
pageNumber
|
pageNumber | integer |
ページに別れたこの結果セットの現在のページ番号 |
pageSize
|
pageSize | integer |
ページに別れたこの結果セットのページ サイズ |
リンク
|
links | array of LinkDescriptionObject |
HATEOAS リンクのコレクション |
SearchCustomer
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | uuid |
この顧客を表す一意識別子 |
firstName
|
firstName | string |
顧客の名 |
lastName
|
lastName | string |
顧客の姓 |
電子メール
|
emails | array of CustomerEmail |
顧客の電子メール アドレス |
電話
|
phones | array of CustomerPhone |
顧客の電話番号 |
アドレス
|
address | CustomerAddress | |
順位
|
rank | float |
この顧客検索結果の関連性ランク |
CustomerVehicleCollection
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | uuid |
この車両の一意識別子 |
exteriorColor
|
exteriorColor | string |
車両の外装の色 |
interiorColor
|
interiorColor | string |
車両の内装の色 |
走行距離
|
mileage | integer |
車両の走行距離 |
milesPerWeek
|
milesPerWeek | integer |
週あたりの平均走行距離 |
年
|
year | integer |
製造年 |
メーカー
|
make | string |
車両のブランド |
モデル
|
model | string |
車両の名前 |
装飾
|
trim | integer |
装飾の説明 |
VIN
|
vin | string |
車両識別番号 |
オプション
|
options | CustomerVehicleOptions |
車両のオプション |
vehicleOwner
|
vehicleOwner | CustomerVehicleOwner |
車両の所有者 |
CustomerVehicleOptions
車両のオプション
名前 | パス | 型 | 説明 |
---|---|---|---|
fuelType
|
fuelType | string |
燃料の種類 |
interiorType
|
interiorType | string |
内装の種類 |
vehicleCondition
|
vehicleCondition | string |
車両の状態 |
bodyStyle
|
bodyStyle | string |
車体のスタイル |
engineDescription
|
engineDescription | string |
エンジンの種類 |
modelCode
|
modelCode | string |
型式コード |
numberOfCylinders
|
numberOfCylinders | integer |
気筒数 |
numberOfDoors
|
numberOfDoors | byte |
ドア数 |
トランスミッション
|
transmission | string |
トランスミッションの種類 |
isAutomaticTransmission
|
isAutomaticTransmission | boolean |
車両が AT かどうかを示す true/false |
hasAirBags
|
hasAirBags | boolean |
車両がエア バッグ装備かどうかを示す true/false |
hasCruiseControl
|
hasCruiseControl | boolean |
車両がクルーズ コントロール装備かどうかを示す true/false |
hasAirConditioning
|
hasAirConditioning | boolean |
車両がエアコン装備かどうかを示す true/false |
CustomerVehicleOwner
車両の所有者
名前 | パス | 型 | 説明 |
---|---|---|---|
isActive
|
isActive | boolean |
所有者がアクティブかどうかを示す true/false |
customerId
|
customerId | uuid |
車両所有者の一意識別子 |
vehicleId
|
vehicleId | uuid |
車両の一意識別子 |
LinkDescriptionObject
名前 | パス | 型 | 説明 |
---|---|---|---|
href
|
href | string |
ターゲット URI |
rel
|
rel | string |
リンクの関連付けの種類 |
メソッド
|
method | string |
リンクのターゲットに要求を作成するために使用する必要がある HTTP 動詞 |
タイトル
|
title | string |
オブジェクトを説明するタイトル |