Elead Sales Opportunities (プレビュー)

  • リファレンス

Elead Sales Opportunities API は、Elead CRM で既存の営業案件情報を検索して取得します。 営業案件情報には、営業チーム、ソース、関心のある車両、および車両取引情報に関連する詳細が含まれます。この API には、営業案件に関連する情報を管理するための次の機能が含まれています。

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

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 は、営業案件および営業案件に関連する電子メールを管理するディーラーおよびベンダー パートナーを対象にしています。

機能と特徴

この API には、営業案件に関連する情報を管理するための次の機能が含まれています。

  • すべてのソースで以前に送信された営業案件を検索して取得する
  • 顧客 ID、日付範囲、または日付と時刻で潜在顧客を照会する
  • Elead Id で営業案件を取得する
  • 既存の顧客レコードに新しい営業案件を作成する
  • 営業案件にコメントを追加する
  • 関心のある車両および車両取引記録を追加、編集、削除する
  • チームの主要な営業担当者を再割り当てする
  • チームのプライマリ BDC エージェントを再割り当てする
  • ディーラーまたはベンダー パートナーに代わって電子メールを送信する
  • 営業案件営業チームに営業担当者を追加する
  • 営業案件営業チームから営業担当者を削除する
  • 営業案件のサブ状態を更新する
  • 営業案件の営業ステップを追加、削除、取得する

前提条件

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

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

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

https://apidocs.fortellis.io/specs/3c6d6b40-7215-4a81-a087-4f956bb36ec9

調整制限

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

アクション

メールを送信し、対応する活動を作成する

メールを送信し、対応する活動を作成します
営業案件から下取りを削除する

指定された営業案件から下取りを削除します
営業案件から営業担当者を削除する

指定された営業案件から営業担当者を削除します
営業案件から車両の希望条件を削除する

指定された営業案件から車両の希望条件を削除します
営業案件にコメントを追加する

指定された営業案件にコメントを追加します
営業案件に下取りを追加する

指定された営業案件に下取りを追加します
営業案件に営業担当者を追加する

指定された営業案件に営業担当者を追加します
営業案件に車両の希望条件を追加する

指定された営業案件に車両の希望条件を追加します
指定された営業案件にプライマリ BDC エージェントを再割り当てする

指定された営業案件にプライマリ BDC エージェントを再割り当てします
指定された営業案件に主要な営業担当者を再割り当てする

指定された営業案件に主要な営業担当者を再割り当てします
指定された日時以降の営業案件を照会する

指定された日時 (過去 7 日以内) の営業案件を取得します
新しい営業案件の作成

新しい営業案件を作成します
日付範囲で営業案件を照会する

日付範囲で営業案件を取得します

メールを送信し、対応する活動を作成する

操作 ID:
Opportunities_SendEmail

メールを送信し、対応する活動を作成します

パラメーター

名前 キー 必須 型 説明
クライアント 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
opportunityId
 opportunityId True uuid

営業案件を表す一意識別子
送信元
 from True string

送信者の電子メール アドレス
recipients
 recipients True array of string

受信者メール アドレスのコレクション
carbonCopies
 carbonCopies array of string

カーボン コピー (CC) メール アドレスのコレクション
subject
 subject True string

電子メールの件名
body
 body True string

電子メールの本文
isHtml
 isHtml True boolean

本文は HTML 形式か?

戻り値

本文​​
SendEmailResponse

営業案件から下取りを削除する

操作 ID:
Opportunities_DeleteTradeIn

指定された営業案件から下取りを削除します

パラメーター

名前 キー 必須 型 説明
TradeIn Id
 tradeInId 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:
Opportunities_RemoveSalesperson

指定された営業案件から営業担当者を削除します

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunityId 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
salespersonId
 salespersonId True uuid

営業担当者を表す一意識別子
positionCode
 positionCode True string

指定された営業案件におけるこの営業担当者のポジション コード

営業案件から車両の希望条件を削除する

操作 ID:
Opportunities_DeleteVehicleSought

指定された営業案件から車両の希望条件を削除します

パラメーター

名前 キー 必須 型 説明
車両の希望条件 ID
 vehicleSoughtId 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:
Opportunities_AddComment

指定された営業案件にコメントを追加します

パラメーター

名前 キー 必須 型 説明
クライアント 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
opportunityId
 opportunityId True uuid

営業案件を表す一意識別子
コメント
 comment True string

指定された営業案件に追加されるコメント

営業案件に下取りを追加する

操作 ID:
Opportunities_AddTradeIn

指定された営業案件に下取りを追加します

パラメーター

名前 キー 必須 型 説明
クライアント 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
opportunityId
 opportunityId True uuid

営業案件を表す一意識別子
年
 year integer

この車両が下取りされた年
メーカー
 make string

この下取り車両のメーカー
モデル
 model string

この下取り車両のモデル
トリム
 trim string

この下取り車両のトリム
VIN
 vin string

この下取り車両の VIN
estimatedMileage
 estimatedMileage integer

この車両の推定走行距離
interiorColor
 interiorColor string

この下取り車両の内装色
exteriorColor
 exteriorColor string

この下取り車両の外装色

戻り値

本文​​
OpportunityVehicleTradeIn

営業案件に営業担当者を追加する

操作 ID:
Opportunities_AddSalesperson

指定された営業案件に営業担当者を追加します

パラメーター

名前 キー 必須 型 説明
営業案件 ID
 opportunityId 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
 id True uuid

この営業担当者を表す一意識別子
isPrimary
 isPrimary True boolean

指定された営業案件の主要な営業担当者かどうかを示す true/false
isPositionPrimary
 isPositionPrimary True boolean

指定された営業案件におけるこのポジションが主要な営業担当者かどうかを示す true/false
positionCode
 positionCode True string

指定された営業案件におけるこの営業担当者のポジション コード

戻り値

本文​​
Salesperson

営業案件に車両の希望条件を追加する

操作 ID:
Opportunities_AddVehicleSought

指定された営業案件に車両の希望条件を追加します

パラメーター

名前 キー 必須 型 説明
クライアント 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
opportunityId
 opportunityId True uuid

一意の営業案件識別子
isNew
 isNew True boolean

車両の希望条件が新車かどうかを示す true/false
yearFrom
 yearFrom integer

この車両の希望条件における年範囲の開始
yearTo
 yearTo integer

この車両の希望条件における年範囲の終了
メーカー
 make string

車両のメーカーの希望条件
モデル
 model string

車両のモデルの希望条件
トリム
 trim string

車両のトリムの希望条件
VIN
 vin string

車両の VIN の希望条件
priceFrom
 priceFrom double

希望車両の最低価格帯
priceTo
 priceTo double

希望車両の最高価格帯
maxMileage
 maxMileage integer

希望車両の最大走行距離
stockNumber
 stockNumber string

希望車両の在庫番号
isPrimary
 isPrimary True boolean

指定された営業案件の主要な車両の希望条件かどうかを示す true/false

戻り値

本文​​
OpportunityVehicleSought

指定された営業案件にプライマリ BDC エージェントを再割り当てする

操作 ID:
Opportunities_ReassignPrimaryBDCAgent

指定された営業案件にプライマリ BDC エージェントを再割り当てします

パラメーター

名前 キー 必須 型 説明
クライアント 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
プライマリ BDC エージェント要求の再割り当て
 reassignPrimaryBDCAgentRequest

プライマリ BDC エージェント要求本文の再割り当て

指定された営業案件に主要な営業担当者を再割り当てする

操作 ID:
Opportunities_ReassignPrimarySalesPerson

指定された営業案件に主要な営業担当者を再割り当てします

パラメーター

名前 キー 必須 型 説明
クライアント 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
主要な営業担当者要求の再割り当て
 reassignPrimarySalesPersonRequest

主要な営業担当者要求を再割り当てします

指定された日時以降の営業案件を照会する

操作 ID:
Opportunities_SearchDelta

指定された日時 (過去 7 日以内) の営業案件を取得します

パラメーター

名前 キー 必須 型 説明
ページ
 page integer

形式 - int32。
ページ サイズ
 pageSize integer

形式 - int32。
開始日
 dateFrom string

形式 - 日時 (RFC3339 の日時形式)。
クライアント 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

戻り値

本文​​
SearchDeltaOpportunitiesResponse

新しい営業案件の作成

操作 ID:
Opportunities_CreateOpportunity

新しい営業案件を作成します

パラメーター

名前 キー 必須 型 説明
クライアント 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
customerId
 customerId True uuid

顧客を表す一意識別子
dateIn
 dateIn date-time

営業案件が発生した日時
ソース
 source True string

この営業案件のソース名
subSource
 subSource string

この営業案件のサブ ソース名
状態
 status string

この営業案件の現在の状態
subStatus
 subStatus string

この営業案件のサブ状態
upType
 upType True string

この営業案件のアップ タイプ
comments
 comments string
isNew
 isNew True boolean

車両の希望条件が新車かどうかを示す true/false
yearFrom
 yearFrom integer

この車両の希望条件における年範囲の開始
yearTo
 yearTo integer

この車両の希望条件における年範囲の終了
メーカー
 make string

車両のメーカーの希望条件
モデル
 model string

車両のモデルの希望条件
トリム
 trim string

車両のトリムの希望条件
VIN
 vin string

車両の VIN の希望条件
priceFrom
 priceFrom double

希望車両の最低価格帯
priceTo
 priceTo double

希望車両の最高価格帯
maxMileage
 maxMileage integer

希望車両の最大走行距離
stockNumber
 stockNumber string

希望車両の在庫番号
isPrimary
 isPrimary True boolean

指定された営業案件の主要な車両の希望条件かどうかを示す true/false
年
 year integer

この車両が下取りされた年
メーカー
 make string

この下取り車両のメーカー
モデル
 model string

この下取り車両のモデル
トリム
 trim string

この下取り車両のトリム
VIN
 vin string

この下取り車両の VIN
estimatedMileage
 estimatedMileage integer

この車両の推定走行距離
interiorColor
 interiorColor string

この下取り車両の内装色
exteriorColor
 exteriorColor string

この下取り車両の外装色
名前
 name True string

営業ステップの名前
ID
 id True uuid

この営業担当者を表す一意識別子
isPrimary
 isPrimary True boolean

指定された営業案件の主要な営業担当者かどうかを示す true/false
isPositionPrimary
 isPositionPrimary True boolean

指定された営業案件におけるこのポジションが主要な営業担当者かどうかを示す true/false
positionCode
 positionCode True string

指定された営業案件におけるこの営業担当者のポジション コード

戻り値

本文​​
CreateOpportunityResponse

日付範囲で営業案件を照会する

操作 ID:
Opportunities_Search

日付範囲で営業案件を取得します

パラメーター

名前 キー 必須 型 説明
ページ
 page integer

形式 - int32。
ページ サイズ
 pageSize integer

形式 - int32。
開始日
 dateFrom string

形式 - 日時 (RFC3339 の日時形式)。
終了日
 dateTo string

形式 - 日時 (RFC3339 の日時形式)。
クライアント 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

戻り値

本文​​
SearchOpportunitiesResponse

定義

LinkDescriptionObject

名前 パス 型 説明
href
 href string

ターゲット URI
rel
 rel string

リンクの関連付けの種類
メソッド
 method string

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

オブジェクトを説明するタイトル

SearchOpportunitiesResponse

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

営業案件のコレクション
totalItems
 totalItems integer

特定のクエリの営業案件の合計数
totalPages
 totalPages integer

特定のクエリのページの合計数
pageNumber
 pageNumber integer

ページに別れたこの結果セットの現在のページ番号
pageSize
 pageSize integer

ページに別れたこの結果セットのページ サイズ
リンク
 links array of LinkDescriptionObject

HATEOAS リンクのコレクション

SearchDeltaOpportunitiesResponse

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

営業案件のコレクション
totalItems
 totalItems integer

特定のクエリの営業案件の合計数
totalPages
 totalPages integer

特定のクエリのページの合計数
pageNumber
 pageNumber integer

ページに別れたこの結果セットの現在のページ番号
pageSize
 pageSize integer

ページに別れたこの結果セットのページ サイズ
リンク
 links array of LinkDescriptionObject

HATEOAS リンクのコレクション

営業案件​​

名前 パス 型 説明
ID
 id uuid

この営業案件を表す一意識別子
顧客
 customer OpportunityCustomer
dateIn
 dateIn date-time

営業案件が発生した日時
ソース
 source string

この営業案件のソース名
subSource
 subSource string

この営業案件のサブ ソース名
状態
 status string

この営業案件の現在の状態
subStatus
 subStatus string

この営業案件のサブ状態
upType
 upType string

この営業案件のアップ タイプ
soughtVehicles
 soughtVehicles array of OpportunityVehicleSought

この営業案件における車両の希望条件のコレクション
tradeIns
 tradeIns array of OpportunityVehicleTradeIn

この営業案件における車両の下取りのコレクション
salesTeam
 salesTeam array of OpportunitySalesperson

この営業案件の営業チーム メンバーとポジションのコレクション
リンク
 links array of LinkDescriptionObject

この営業案件の HATEOAS リンクのコレクション

OpportunityCustomer

名前 パス 型 説明
ID
 id uuid

この顧客を表す一意識別子
リンク
 links array of LinkDescriptionObject

この顧客の HATEOAS リンクのコレクション

OpportunityVehicleSought

名前 パス 型 説明
ID
 id uuid

車両の希望条件を表す一意識別子
isNew
 isNew boolean

車両の希望条件が新車かどうかを示す true/false
yearFrom
 yearFrom integer

この車両の希望条件における年範囲の開始
yearTo
 yearTo integer

この車両の希望条件における年範囲の終了
メーカー
 make string

車両のメーカーの希望条件
モデル
 model string

車両のモデルの希望条件
トリム
 trim string

車両のトリムの希望条件
VIN
 vin string

車両の VIN の希望条件
priceFrom
 priceFrom double

希望車両の最低価格帯
priceTo
 priceTo double

希望車両の最高価格帯
maxMileage
 maxMileage integer

希望車両の最大走行距離
stockNumber
 stockNumber string

希望車両の在庫番号
isPrimary
 isPrimary boolean

指定された営業案件の主要な車両の希望条件かどうかを示す true/false

OpportunityVehicleTradeIn

名前 パス 型 説明
ID
 id uuid

車両の下取りを表す一意識別子
年
 year integer

この車両が下取りされた年
メーカー
 make string

この下取り車両のメーカー
モデル
 model string

この下取り車両のモデル
トリム
 trim string

この下取り車両のトリム
VIN
 vin string

この下取り車両の VIN
estimatedMileage
 estimatedMileage integer

この車両の推定走行距離
interiorColor
 interiorColor string

この下取り車両の内装色
exteriorColor
 exteriorColor string

この下取り車両の外装色

OpportunitySalesperson

名前 パス 型 説明
ID
 id uuid

この営業担当者を表す一意識別子
firstName
 firstName string

この営業担当者の名
lastName
 lastName string

この営業担当者の姓
isPrimary
 isPrimary boolean

指定された営業案件の主要な営業担当者かどうかを示す true/false
isPositionPrimary
 isPositionPrimary boolean

指定された営業案件におけるこのポジションが主要な営業担当者かどうかを示す true/false
positionName
 positionName string

指定された営業案件におけるこの営業担当者のポジション名
positionCode
 positionCode string

指定された営業案件におけるこの営業担当者のポジション コード
リンク
 links array of LinkDescriptionObject

この営業担当者の HATEOAS リンクのコレクション

営業担当者

名前 パス 型 説明
ID
 id uuid

この営業担当者を表す一意識別子
isPrimary
 isPrimary boolean

指定された営業案件の主要な営業担当者かどうかを示す true/false
isPositionPrimary
 isPositionPrimary boolean

指定された営業案件におけるこのポジションが主要な営業担当者かどうかを示す true/false
positionCode
 positionCode string

指定された営業案件におけるこの営業担当者のポジション コード

SendEmailResponse

名前 パス 型 説明
activityId
 activityId uuid

活動を表す一意識別子

CreateOpportunityResponse

名前 パス 型 説明
営業案件
 opportunity Opportunity
isDuplicate
 isDuplicate boolean

指定された営業案件が重複していると判断されたかどうかを示す true/false
opportunityActivityId
 opportunityActivityId uuid

指定された営業案件の活動を表す一意識別子