CDK Drive Customer (プレビュー)

  • リファレンス

この API を使用すると、CDK Drive でのサービス顧客の検索、取得、およびフィルター処理を行えるようになります。 CDK Drive において、顧客とは、車両を購入した個人、車両の見込顧客、部品の購入者、または販売特約店を介して車両の修理またはサービスを受けた個人であり、CRM システムに存在します。 さらに、このコネクタを使用すると、基本的な顧客レコードを作成できます。 これにより、サービス アドバイザーが、これらのワークフローを顧客に結び付けて、肯定的なエクスペリエンスを提供できます。

このコネクタは、次の製品および地域で利用可能です。

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
カテゴリ データ​​

詳細

CDKDrive Customer API V1 を使用すると、CDK Drive の顧客レコードを検索、表示、作成、および更新できます。

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

重要なコンセプト

顧客

顧客とは、CDK Drive DMS 内の個人であり、次の条件の少なくとも 1 つを満たしています。

  1. 販売店から車両を購入した (または車両購入の見込顧客)
  2. 販売店から部品を購入した
  3. 修理やサービスのために車両を販売店に持ち込んだ

潜在的なユース ケース

CDKDrive Customer API を使用して、次のような状況を処理するソリューションを作成します。

  1. 顧客を検索し、顧客の詳細を表示する
  2. 顧客情報を作成または更新する
  3. 顧客が希望する連絡方法を更新する
  4. CDKDrive Service Vehicles API を使用して車両とリンクするための顧客情報を取得する

関連する API

CDKDrive Customer API は、別々に使用することも、次の API のいずれかと一緒に使用することもできます。

Deals

顧客と、購入またはリースしている車両に関する情報を使用して、取引を検索して作成します。 CDKDrive Customer API を使用して、顧客レコードを取引に関連付けることができます。 Deals API: 販売店従業員の取得。

  1. https://apidocs-dev.fortellis.io/specs/91145f3f-2dd7-43fa-a63d-08908ef9e2e7

CDKDrive Repair Orders

CDK Drive でサービス書き込みワークフローを有効にします。 CDKDrive Customer API を使用して、顧客レコードを修理注文に関連付けることができます。

https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3

CDKDrive Service Vehicles

CDK Drive でサービス ドメイン車両情報を作成、更新、クエリ、および取得します。 CDKDrive Service Vehicles API を使用して、顧客を車両にリンクできます。

https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d

CDKDrive Customer API の使用の開始

前提条件

続行するには、次のものが必要です

• コネクタを使用するには、Fortellis ユーザーである必要があります。

• API の呼び出し中に使用されるクライアント ID とシークレットを生成するには、Fortellis でソリューションを作成する必要があります

詳細なドキュメントは次のサイトで確認できます

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

顧客のクエリ

顧客のクエリ
顧客のクエリ

顧客のクエリ
顧客を作成する

顧客を作成する
顧客を更新する

顧客を更新する

顧客のクエリ

操作 ID:
queryCustomerById

顧客のクエリ

パラメーター

名前 キー 必須 型 説明
顧客 ID
 customerId True string

顧客 ID
サブスクリプション ID
 subscription_id True string

指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。
クライアント ID
 client_id True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。
クライアント シークレット
 client_secret True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。
要求 ID
 Request-Id string

形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID

戻り値

本文​​
Customer

顧客のクエリ

操作 ID:
queryCustomers

顧客のクエリ

パラメーター

名前 キー 必須 型 説明
件名
 name string

名前による顧客のフィルター処理
電子メール
 email string

電子メール アドレスによる顧客のフィルター処理
電話
 phone string

電話番号による顧客のフィルター処理
サブスクリプション ID
 subscription_id True string

指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。
クライアント ID
 client_id True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。
クライアント シークレット
 client_secret True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。
要求 ID
 Request-Id string

形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID

戻り値

本文​​
CustomerCollection

顧客を作成する

操作 ID:
createCustomer

顧客を作成する

パラメーター

名前 キー 必須 型 説明
クライアント ID
 client_id True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。
クライアント シークレット
 client_secret True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。
サブスクリプション ID
 subscription_id True string

指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。
要求 ID
 Request-Id string

形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID
最初
 first True string

顧客の名
ミドル
 middle string

顧客のミドル ネーム
最後
 last True string

顧客の姓
prefix
 prefix string

顧客の接頭辞
敬称
 suffix string

顧客の接尾辞
primaryPhone
 primaryPhone string

顧客の電話番号 1
homePhone
 homePhone string

顧客の自宅電話番号
mobilePhone
 mobilePhone string

顧客の携帯電話番号
ポケットベル
 pager string

顧客のポケットベル番号
pagerAccessCode
 pagerAccessCode string

顧客のアクセス コード番号
homeFax
 homeFax string

顧客の自宅 FAX 番号
workFax
 workFax string

顧客の勤務先 FAX 番号
email1
 email1 string

顧客の電子メール アドレス 1。 他のメール アドレスが存在しない場合、適用不可を表す「NA」または顧客による拒否を表す「CD」を入力できます
emailDesc1
 emailDesc1 string

電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。
email2
 email2 string

顧客の電子メール アドレス 2
emailDesc2
 emailDesc2 string

電子メール アドレス 2 の説明
email3
 email3 string

顧客の電子メール アドレス 3
emailDesc3
 emailDesc3 string

電子メール アドレス 3 の説明
email4
 email4 string

顧客の電子メール アドレス 4
emailDesc4
 emailDesc4 string

電子メール アドレス 4 の説明
email5
 email5 string

顧客の電子メール アドレス 5
emailDesc5
 emailDesc5 string

電子メール アドレス 5 の説明
email6
 email6 string

顧客の電子メール アドレス 6
emailDesc6
 emailDesc6 string

電子メール アドレス 6 の説明
preferredMethod
 preferredMethod string

顧客の優先連絡方法
blockPhoneFlag
 blockPhoneFlag boolean

電話広告をするかどうかを示す
blockEmailFlag
 blockEmailFlag boolean

電子メール広告をブロックするかどうかを示す
blockMailFlag
 blockMailFlag boolean

郵便広告をブロックするかどうかを示す
番地
 street string

番地などです。この要素には、番地や部屋番号も含まれます。
city
 city string

市町村などを指定できます。これは郵送先であり、居住地または事業の場所である必要はありません。
county
 county string

米国または英国の郡などの行政区域を処理します。 郵送先住所としては使用されません。 小区域は配送先住所では使用されません。
状態
 state string

州、県、郡 (アイルランド)、ランド (ドイツ)、県 (フランス) など。
postalCode
 postalCode string

郵便番号。 通常は国全体に対応しますが、都市専用の場合があります (たとえば、'Dublin 2, Ireland' という住所の '2')。
country
 country string

国の ISO 国コード

戻り値

本文​​
Customer

顧客を更新する

操作 ID:
updateCustomer

顧客を更新する

パラメーター

名前 キー 必須 型 説明
顧客 ID
 customerId True string

顧客 ID
サブスクリプション ID
 subscription_id True string

指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID。
クライアント ID
 client_id True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント ID。
クライアント シークレット
 client_secret True string

ソリューションを構築する開発者/ソリューション プロバイダーに対して一意である必要があるクライアント シークレット。
要求 ID
 Request-Id string

形式 - GUID。 指定した要求の戻りを示すために呼び出し元に返す必要がある関連付け ID
eTag
 If-Match True string

リソース更新要求を条件付きにします。 If-Match で表示されるチェックサム値は、リソースの現在の ETag 値と一致する必要があります。
最初
 first True string

顧客の名
ミドル
 middle string

顧客のミドル ネーム
最後
 last True string

顧客の姓
prefix
 prefix string

顧客の接頭辞
敬称
 suffix string

顧客の接尾辞
primaryPhone
 primaryPhone string

顧客の電話番号 1
homePhone
 homePhone string

顧客の自宅電話番号
mobilePhone
 mobilePhone string

顧客の携帯電話番号
ポケットベル
 pager string

顧客のポケットベル番号
pagerAccessCode
 pagerAccessCode string

顧客のアクセス コード番号
homeFax
 homeFax string

顧客の自宅 FAX 番号
workFax
 workFax string

顧客の勤務先 FAX 番号
email1
 email1 string

顧客の電子メール アドレス 1。 他のメール アドレスが存在しない場合、適用不可を表す「NA」または顧客による拒否を表す「CD」を入力できます
emailDesc1
 emailDesc1 string

電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。
email2
 email2 string

顧客の電子メール アドレス 2
emailDesc2
 emailDesc2 string

電子メール アドレス 2 の説明
email3
 email3 string

顧客の電子メール アドレス 3
emailDesc3
 emailDesc3 string

電子メール アドレス 3 の説明
email4
 email4 string

顧客の電子メール アドレス 4
emailDesc4
 emailDesc4 string

電子メール アドレス 4 の説明
email5
 email5 string

顧客の電子メール アドレス 5
emailDesc5
 emailDesc5 string

電子メール アドレス 5 の説明
email6
 email6 string

顧客の電子メール アドレス 6
emailDesc6
 emailDesc6 string

電子メール アドレス 6 の説明
preferredMethod
 preferredMethod string

顧客の優先連絡方法
blockPhoneFlag
 blockPhoneFlag boolean

電話広告をするかどうかを示す
blockEmailFlag
 blockEmailFlag boolean

電子メール広告をブロックするかどうかを示す
blockMailFlag
 blockMailFlag boolean

郵便広告をブロックするかどうかを示す
番地
 street string

番地などです。この要素には、番地や部屋番号も含まれます。
city
 city string

市町村などを指定できます。これは郵送先であり、居住地または事業の場所である必要はありません。
county
 county string

米国または英国の郡などの行政区域を処理します。 郵送先住所としては使用されません。 小区域は配送先住所では使用されません。
状態
 state string

州、県、郡 (アイルランド)、ランド (ドイツ)、県 (フランス) など。
postalCode
 postalCode string

郵便番号。 通常は国全体に対応しますが、都市専用の場合があります (たとえば、'Dublin 2, Ireland' という住所の '2')。
country
 country string

国の ISO 国コード

戻り値

本文​​
Customer

定義

顧客

名前 パス 型 説明
customerId
 customerId string

顧客レコードの識別子
名前
 name Name
contactMethods
 contactMethods ContactMethods
postalAddress
 postalAddress PostalAddress
preferredContact
 preferredContact string

優先する連絡方法
リンク
 links CustomerLinks

ContactMethods

名前 パス 型 説明
primaryPhone
 primaryPhone string

顧客の電話番号 1
homePhone
 homePhone string

顧客の自宅電話番号
mobilePhone
 mobilePhone string

顧客の携帯電話番号
ポケットベル
 pager string

顧客のポケットベル番号
pagerAccessCode
 pagerAccessCode string

顧客のアクセス コード番号
homeFax
 homeFax string

顧客の自宅 FAX 番号
workFax
 workFax string

顧客の勤務先 FAX 番号
email1
 email1 string

顧客の電子メール アドレス 1。 他のメール アドレスが存在しない場合、適用不可を表す「NA」または顧客による拒否を表す「CD」を入力できます
emailDesc1
 emailDesc1 string

電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。
email2
 email2 string

顧客の電子メール アドレス 2
emailDesc2
 emailDesc2 string

電子メール アドレス 2 の説明
email3
 email3 string

顧客の電子メール アドレス 3
emailDesc3
 emailDesc3 string

電子メール アドレス 3 の説明
email4
 email4 string

顧客の電子メール アドレス 4
emailDesc4
 emailDesc4 string

電子メール アドレス 4 の説明
email5
 email5 string

顧客の電子メール アドレス 5
emailDesc5
 emailDesc5 string

電子メール アドレス 5 の説明
email6
 email6 string

顧客の電子メール アドレス 6
emailDesc6
 emailDesc6 string

電子メール アドレス 6 の説明
preferredMethod
 preferredMethod string

顧客の優先連絡方法
blockPhoneFlag
 blockPhoneFlag boolean

電話広告をするかどうかを示す
blockEmailFlag
 blockEmailFlag boolean

電子メール広告をブロックするかどうかを示す
blockMailFlag
 blockMailFlag boolean

郵便広告をブロックするかどうかを示す

PostalAddress

名前 パス 型 説明
番地
 street string

番地などです。この要素には、番地や部屋番号も含まれます。
city
 city string

市町村などを指定できます。これは郵送先であり、居住地または事業の場所である必要はありません。
county
 county string

米国または英国の郡などの行政区域を処理します。 郵送先住所としては使用されません。 小区域は配送先住所では使用されません。
状態
 state string

州、県、郡 (アイルランド)、ランド (ドイツ)、県 (フランス) など。
postalCode
 postalCode string

郵便番号。 通常は国全体に対応しますが、都市専用の場合があります (たとえば、'Dublin 2, Ireland' という住所の '2')。
country
 country string

国の ISO 国コード
名前 パス 型 説明
リソースへのリンクの詳細
 self LinkDescriptionObject

CustomerCollection

名前 パス 型 説明
項目
 items array of Customer

件名

名前 パス 型 説明
最初
 first string

顧客の名
ミドル
 middle string

顧客のミドル ネーム
最後
 last string

顧客の姓
prefix
 prefix string

顧客の接頭辞
敬称
 suffix string

顧客の接尾辞
companyName
 companyName string

顧客が会社を表す場合は、会社名を検討してください

LinkDescriptionObject

名前 パス 型 説明
href
 href string

ターゲット URI
メソッド
 method string

リンクのターゲットに要求を作成するために使用する必要がある HTTP 動詞
タイトル
 title string

title プロパティはリンクのタイトルを示します。エンド クライアントの理解を促進するために役立つドキュメント ツールです