次の方法で共有


HiveCPQ Product Configurator

HiveCPQ は、営業チームが複雑な製品の正確な見積もりを作成できるようにする包括的な Configure Price Quote (CPQ) ソリューションです。 HiveCPQ をシームレスに統合し、コネクタを使用してワークフローを自動化し、データを同期し、業務を最適化することで、営業プロセスを合理化します。 HiveCPQ の強力なコネクタにより、効率を最大化し、優れた営業エクスペリエンスを提供します。

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

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 HiveCPQ のサポート
[URL] https://hivecpq.com/en/integrations
メール support@hivecpq.com
Connector Metadata
発行者 NimbleOps NV
Web サイト https://hivecpq.com/
プライバシー ポリシー https://hivecpq.com/en/privacy-policy
カテゴリー 生産性、販売と CRM

HiveCPQ コネクタを使用すると、公開 API スイートに簡単にアクセスできます。 これにより、HiveCPQ 環境内のマスターデータを管理できるようになります。 アカウントと連絡先の統合を支援すると同時に、営業と見積もりの​​プロセスを完全に自動化する機能も提供します。

前提条件

次が必要となります:

  • HiveCPQ のアクティブな顧客であること
  • HiveCPQ 環境にアクセスできる

資格情報の入手方法

ユーザー名とパスワードの形で、API 認証情報を要求するリクエストを support@hivecpq.com に行う必要があります。

コネクタの使用を開始する

このコネクタを独自のワークフローで使用するには、名前「HiveCPQ Product Configurator」で検索してください。 このコネクタはアクションのみを提供し、トリガは含まれていないため、ワークフロー構築者が独自のトリガ メカニズムを決定する必要があります。

「製造元を取得する」アクションは、ワークフローに必要な最も基本的なアクションです。 接続している製造会社の ID が提供されます。この ID は、他のすべての利用可能なアクションで必要になります。

コネクタの使用を開始する方法に関する追加情報は、こちら のオンライン ドキュメントを読むことで得られます。 当社の文書へのアクセスは、既知のお客様にのみ提供されるパスワードで保護されています。support@hivecpq.com にアクセスをリクエストしてください

既知の問題と制限事項

値のリストを渡すことを許可するクエリ パラメーターには、基礎となるサービスによって尊重される最初の値のみが含まれます。 これは、powerautomate が複数値パラメーターを送信するために使用できるサポートされている形式と、基礎となるサービスが受け入れる形式との間に競合があるためです。

一般的なエラーと解決策

  • 400 Bad Request:
    • サービスが受信したペイロードに問題があることを示します。コネクタで使用されている入力に無効な値がないか再確認することをお勧めします
  • 401 Not Authorized:
    • サービスへの認証に問題があることを示します。コネクタの接続を更新することをお勧めします
  • 403 Forbidden:
    • 特定のリソースにアクセスしたり、特定のアクションを実行するには、アクセス レベルが十分でないことを示します: コネクターのユーザー アカウントの昇格権限を support@hivecpq.com にリクエストすることをお勧めします
  • 404 Not Found:
    • 要求されたリソースが存在しないことを示します。リソースが存在する場合は、基になるサービスの内部を確認することをお勧めします
  • 500 サーバー エラー:
    • 基礎となるサービスが回復不可能なエラーに遭遇したことを示します: 問題を調査するため、サポートへのお問い合わせが推奨されます

よくあるご質問

指定された資格情報を入力した後、HiveCPQ への接続はどのくらいの期間有効ですか?

資格情報は無期限に有効です。 パスワードの更新をリクエストすることが可能です。 接続自体は、非アクティブ期間の有効期限に基づいて機能します。 接続がワークフロー実行で 2 カ月以上使用されなかった場合、接続は期限切れになり、資格情報を再入力する必要があります。

調整制限

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

アクション

Search projects

製造元のプロジェクトを検索します。

Send invitation email

HiveCPQ 電子メール システムを使用して招待メールを送信します。

webhook のトリガーを削除する

webhook の特定のトリガーを削除します。

Webhook のヘッダーを削除する

特定の Webhook のヘッダーを削除します。

webhook の取得

製造元の特定の webhook を取得します。

Webhook の検索

製造元用に構成された Webhook を検索します。

Webhook の追加

メーカーに対する新しい webhook を追加します。

Webhook を削除します

製造元の特定の webhook を削除します。

Webhook トリガーの取得

webhook の特定のトリガーを取得します。

Webhook トリガーの更新

webhook の特定のトリガーを更新します。

Webhook トリガーの検索

特定の Webhook のトリガーを検索します。

Webhook トリガーの追加

特定の webhook に新しいトリガーを追加します。

Webhook ヘッダーの検索

特定の Webhook のヘッダーを検索します。

Webhook ヘッダーの追加

特定の webhook に新しいヘッダーを追加します。

イベントの検索

製造元のプラットフォーム イベントを検索します。

イベントの購読

製造元のイベントを購読します。 既存のサブスクリプションは上書きまたは削除されます。

ウェブフック を更新する

製造元の webhook を更新します。

エベントのサブスクリプションの検索

購読しているイベント サブスクリプションを検索します。

カスタム オブジェクト キャッシュのリセット

コンフィギュレーターは、カスタム オブジェクトを処理する際にキャッシュを使用する場合があります。 この エンドポイント を呼び出すと、これらのキャッシュがリセットされます。

カスタム オブジェクト タイプを検索する

製造元のカスタム オブジェクト タイプを検索します。

カスタム オブジェクトの取得

特定のタイプの新しいカスタム オブジェクトを取得します。

カスタム オブジェクトの追加

特定のタイプの新しいカスタム オブジェクトを追加します。 このタイプが存在しない場合は作成されます。

カスタム オブジェクトを削除する

特定のタイプの新しいカスタム オブジェクトを削除します。

カスタム オブジェクトを更新する

特定の種類の特定のカスタム オブジェクトを更新します。

カスタム オブジェクトを検索する

特定のタイプのカスタム オブジェクトを取得します。

コンテナのバージョンを検索する

製造元のコンテナ バージョンを検索します。

コンポーネント ヒントの削除

マスター データからコンポーネント ヒントを削除します。

コンポーネント ヒントの取得

マスターデータ内の特定のコンポーネント ヒントを取得します。

コンポーネント ヒントの更新

マスターデータ内の特定のコンポーネント ヒントを更新します。

コンポーネント ヒント画像の削除

マスター データからコンポーネント ヒント画像を削除します。

コンポーネント ヒント画像の取得

マスターデータからの特定のコンポーネント ヒントを取得します。

コンポーネント ヒント画像の更新

マスターデータ内の特定のコンポーネント ヒント画像を更新します。

コンポーネントのプロパティ値の設定

マスター データ内のコンポーネントに単一のプロパティ値を設定します。

コンポーネントのプロパティ値の設定

マスター データ内のコンポーネントに複数のプロパティ値を設定します。 既存の値は上書き、または削除されます。

コンポーネントのプロパティ値を検索する

マスター データのコンポーネントのプロパティ値を検索します。

コンポーネントの一括削除

マスター データ内の複数のコンポーネントを削除します。

コンポーネントの価格を一括で更新/挿入します

マスターデータで複数のコンポーネント価格を作成または更新します。

コンポーネントの削除

マスター データからコンポーネントを削除します。

コンポーネントの取得

マスターデータ内の特定のコンポーネントを取得します。

コンポーネントの更新

マスターデータ内の特定のコンポーネントを更新します。

コンポーネントの検索

製造元の苦情を検索する

コンポーネントの検索

マスターデータ内のコンポーネントを検索します。

コンポーネントの機能をリンク解除する

マスター データの特定のコンポーネントから機能のリンクを解除します。

コンポーネントの添付の削除

マスター データのコンポーネントから添付ファイルを削除します。

コンポーネントの添付ファイルの検索

マスター データのコンポーネントの添付を検索します。

コンポーネントの添付ファイルを追加する

マスター データのコンポーネントに新しい添付を追加します。

コンポーネントを追加します

マスター データにコンポーネントを追加します。

コンポーネント価格の削除

マスター データのコンポーネントから価格を削除します。

コンポーネント価格の検索

マスター データのコンポーネントの価格を検索します。

コンポーネント価格の追加

マスター データのコンポーネントに新しい価格を追加します。

スタンドアロン構成の追加

V2 コンフィギュレーターの構成チェックを起動してスタンドアロン構成を作成する

セグメントに構成を追加する

特定のプロジェクト セグメントに V1 構成を追加します。

ディストリビューター アカウントの削除

ディストリビューターのアドレス帳から特定の取引先企業を削除します。 取引先企業は、どのプロジェクトでも使用されておらず、取引先担当者がいない場合にのみ削除できます。

ディストリビューター アカウントの更新

ディストリビューターのアドレス帳から特定の取引先企業を更新します。

ディストリビューター アカウントの追加

ディストリビューターのアドレス帳にアカウントを追加します。

ディストリビューターの担当者を更新する

ディストリビューターのアドレス帳から特定の取引先担当者を更新します。

ディストリビューター取引先企業の検索

ディストリビューターのアドレス帳に取引先企業を追加します。

ディストリビューター取引先担当者の検索

ディストリビューターのアドレス帳に取引先担当者を追加します。

プロジェクの再計算

プロジェクトの非同期再計算を開始します。

プロジェクト セグメント 項目の削除

プロジェクトから特定のプロジェクト セグメント項目を削除します。

プロジェクト セグメント 項目の更新

製造元の特定のプロジェクト セグメント項目を更新します。

プロジェクト セグメントのアーカイブ

製造元の特定のプロジェクト セグメントをアーカイブします。

プロジェクト セグメントのアーカイブ解除

製造元の特定のプロジェクト セグメントのアーカイブを解除します。

プロジェクト セグメントのキャンセル オーダー プロセス

注文プロセスをキャンセルし、プロジェクト セグメントをステップ 2 に戻します。

プロジェクト セグメントの検索

製造元のプロジェクト セグメントを検索します。

プロジェクト セグメントの設定を変更する

プロジェクト セグメントの設定を変更します。 設定は、セグメント コンフィギュレーターが構成されている場合にのみ使用できます。

プロジェクト セグメントをステップ 1 に移動する

特定のプロジェクト セグメントをステップ 1 に移動します。 これで受注プロセスが開始されます。

プロジェクト セグメントをステップ 2 に移動する

特定のプロジェクト セグメントをステップ 2 に移動します。 これにより、プロジェクト セグメントの注文が作成されます。

プロジェクト セグメントをステップ 3 に移動する

特定のプロジェクト セグメントをステップ 3 に移動します。

プロジェクト セグメントをステップ 4 に移動する

特定のプロジェクト セグメントをステップ 4 に移動します。

プロジェクト セグメントを更新する

製造元の特定のプロジェクト セグメントを更新します。

プロジェクト セグメント項目の取得

製造元の特定のプロジェクト セグメント項目を取得します。

プロジェクト セグメント項目の検索

特定の製造元のプロジェクト セグメント項目を検索します。

プロジェクト セグメント項目を別のプロジェクトにコピーする

プロジェクト セグメント項目を別のプロジェクトにコピーします。 アイテムに構成がアタッチされている場合、自動的に最新バージョンにアップグレードされます。

プロジェクトに構成を追加する

プロジェクトに新規 V2 構成を追加します。

プロジェクトに製品を追加する

製造元のプロジェクトに 1 つ以上の製品を追加します。

プロジェクトのコピー

プロジェクトのすべてのデータを新しいプロジェクトにコピーします。

プロジェクトのセグメントを取得する

製造元の特定のプロジェクト セグメントを取得します。

プロジェクトのドキュメントを生成する

特定のプロジェクトの PDF ドキュメントを生成します。 テンプレート ID は、ドキュメント タイプが QUOTE で、既定のテンプレートが設定されている場合にのみオプションです。

プロジェクトの追加

企業の新規プロジェクトを追加する。

プロジェクトを取得する

製造元の特定のプロジェクトを取得します。

プロジェクトを更新する

製造元の特定のプロジェクトを更新します。

プロパティの削除

マスター データから特定のプロパティを削除します。

プロパティの更新

マスターデータ内の特定のプロパティを更新します。

プロパティの検索

マスター データ内のプロパティを検索します。

メール トークンの情報を取得する

HiveCPQ 内から現在プラグインを使用しているユーザーに関する情報を取得します。

ユニットの削除

マスター データから特定のユニットを削除します。

ユニットの取得

マスター データから特定のユニットを取得します。

ユニットの更新

マスター データ内の特定のユニットを更新します。

ユーザー アカウントの取得

特定の製造元に接続されている特定のユーザー アカウントを取得します。

ロールの検索

製造元が自社の連絡先と代理店の連絡先に定義した役割を検索します。

代理店の連絡先を削除する

ディストリビューターのアドレス帳から特定の取引先担当者を削除します。

代理店の連絡先を追加する

ディストリビューターのアドレス帳に新しい取引先担当者を追加する。

会社の既定の住所を削除する

会社の特定のの住所を削除します。

会社の既定の住所を取得する

会社の特定のの住所を取得します。

会社の既定の住所を更新する

会社の特定のの住所を更新します。

会社の既定の住所を検索する

会社の既定の請求書および配送先住所を検索します。

会社の検索

製造元に関連する企業を検索します。

会社をアーカイブする

会社とそのすべての取引先担当者をアーカイブします。

会社をアーカイブ解除する

取引先担当者のアーカイブを解除せずに、会社のアーカイブを解除します。

会社を取得する

製造元にリンクされた特定の企業を取得します。

会社を更新する

製造元の企業の苦情を更新します。

価格カタログの削除

特定の価格カタログを削除します。

価格カタログの取得

製造元の特定の価格カタログを取得します。

価格カタログの更新

製造元の特定の価格カタログを更新します。

価格カタログの検索

製造元の価格カタログを検索します。

価格カタログの追加

メーカーに対す価格カタログを追加します。

出力文書テンプレートの検索

製造元の出力ドキュメントのテンプレートを検索します。

出荷条件の検索

製造元の出荷条件を検索します。

実行中のプロジェクトの価格を更新する

受注プロセスのステップ 2 に達していないすべてのプロジェクトの価格をマスターデータで更新します。

招待の検索

製造元の招待を検索します。

招待状の追加

取引先担当者を会社に参加させるための招待を追加します。

支払い条件の検索

製造元の支払い条件を検索します。

新しいプロパティを追加する

マスター データに新規プロパティを追加します。

新しい会社を追加する

メーカーに対する新しい会社を追加します。

新しい単位の追加

マスター データに新しい単位を追加します。

新しい既定のアドレスを追加する

新しい既定のアドレスを会社に追加します。

新しい機能グループを追加する

マスター データに新しい機能グループを追加します。

検索のアクセス許可

製造元のアクセス許可を検索します。

検索ユニット

マスター データ内の検索ユニットを検索します。

検索機能

マスター データ内の特定の機能グループ内の機能を検索します。

構成からファイルを取得する

構成内のファイル ノードに添付されたファイルを取得します。

構成のレンダーのスクリーンショット

構成のスクリーンショットのレンダー

構成の更新

構成内のノードの値を更新します。

構成を取得する

製造元の特定の構成を取得します。

機能の機能グループを変更する

マスター データの特定の機能の機能グループを変更します。

機能をコンポーネントにリンクする

1 つの機能をマスター データのコンポーネントにリンクします。

機能をコンポーネントにリンクする

1 つ以上の機能をマスター データのコンポーネントにリンクします。 既存のリンクは上書きまたは削除されます。

機能を削除する

マスター データの特定の機能グループから機能を削除します。

機能を更新します

マスター データの特定の機能グループに含まれる機能を更新します。

機能グループから機能を取得する

マスター データの特定の機能グループに含まれる機能を取得します。

機能グループに機能を追加する

マスターデータの特定の機能グループに新しい機能を追加します。

機能グループの順序を変更する

機能グループの並び順を変更することで、商品ストアでの表示方法を変更できます。 すべての既存グループはリクエストの一部である必要があります。

機能グループを削除する

マスター データから特定の機能グループを削除します。

機能グループを取得する

マスター データ内の特定の機能グループを取得します。

機能グループを更新する

マスター データ内の特定の機能グループを更新します。

機能グループを検索

マスター データ内の機能グループを検索します。

機能グループ内の機能を並べ替える

特定の機能グループの機能を並べ替え、商品ストアでの表示方法を変更します。 グループ内のすべての既存の機能はリクエストの一部である必要があります。

税条件の検索

製造元の税条件を検索します。

統合システム リンクの削除

特定の統合システム リンクを削除します。

統合システム リンクの更新

製造元の特定の統合システム リンクを更新します。

統合システムリンクの検索

製造元の統合システムリンクを検索します。 統合システム リンクには、Hive エンティティと外部システム エンティティ間のリンクが保存されます。

統合システムリンクの追加

リソースの新しい統合システム リンクを追加します。

苦情から添付ファイルを削除する

苦情から添付ファイルを削除する

苦情のコメントを追加する

特定の苦情に新しいコメントを追加します。

苦情の削除

製造元の特定の苦情を削除します。

苦情の取得

製造元の特定の苦情を取得します。

苦情の更新

製造元の特定の苦情を更新します。

苦情の添付ファイルの取得

特定の苦情の添付ファイルを入手します。

苦情の添付ファイルを追加する

特定の苦情に新しい添付ファイルを追加します。

苦情の追加

メーカーに対する新しい苦情を追加します。

苦情コメントの検索

特定の苦情のコメントを検索します。

苦情コメントを置き換える

特定の苦情のすべてのコメントを置き換えます。

苦情添付ファイルの検索

特定の苦情の添付ファイルを検索します。

製造元の取引先担当者を検索する

製造元や企業に関連する取引先担当者を検索します。

製造元を取得する

接続しているすべての製造元を取得します。

製造元取引先担当者の取得

製造元またはその会社の具体的な取引先担当者を取得します。

製造元取引先担当者の追加

製造元またはその会社の会社に新しい取引先担当者を追加します。

製造元担当者を更新する

製造元またはその会社の具体的な取引先担当者を更新します。

連絡先をアーカイブする

特定の取引先担当者をアーカイブし、その招待を削除します。

Search projects

製造元のプロジェクトを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

最終更新日
updatedSince date-time

指定された時間より前に最終更新されたすべての結果を取得します。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

Send invitation email

HiveCPQ 電子メール システムを使用して招待メールを送信します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

招待 ID
inviteId True string

アクセスする招待の ID です。

invitationText
invitationText True string

招待メールに表示されるテキストです。

toEmail
toEmail True email

招待を送信するメールアドレスです。

戻り値

返答
string

webhook のトリガーを削除する

webhook の特定のトリガーを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Webhook のトリガー ID
webhookTriggerId True string

アクセスする webhook トリガー の ID です。

Webhook のヘッダーを削除する

特定の Webhook のヘッダーを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Webhook ヘッダーの ID
headerId True string

アクセスする webhook ヘッダー の ID です。

webhook の取得

製造元の特定の webhook を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

戻り値

Webhook の検索

製造元用に構成された Webhook を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

Webhook の追加

メーカーに対する新しい webhook を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

code
code True string

webhook の一意のコードです。

url
url True string

Webhook のコールバック URL です。

description
description string

webhook に関する追加情報です。

eventSubscriptions
eventSubscriptions string

Webhook がサブスクライブできるイベントです。

Webhook を削除します

製造元の特定の webhook を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Webhook トリガーの取得

webhook の特定のトリガーを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Webhook のトリガー ID
webhookTriggerId True string

アクセスする webhook トリガー の ID です。

戻り値

Webhook トリガーの更新

webhook の特定のトリガーを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Webhook のトリガー ID
webhookTriggerId True string

アクセスする webhook トリガー の ID です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

confirmationRequired
confirmationRequired boolean

ユーザーが Webhook トリガーをアクティブ化するときの確認モーダルを有効または無効にします。

openInSameTab
openInSameTab boolean

OPEN_URL タイプを使用する際に、同じブラウザー タブで URL を開くことができるようにします。

location
location True string

HiveCPQ の UI 内の Webhook トリガーの場所です。

タイプ
type True string

Webhook トリガーの種類です。

permissionIds
permissionIds array of string

トリガーにアクセスできる権限 ID のコレクションです。

Webhook トリガーの検索

特定の Webhook のトリガーを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

Webhook トリガーの追加

特定の webhook に新しいトリガーを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

code
code True string

トリガーの一意のコードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

confirmationRequired
confirmationRequired boolean

ユーザーが Webhook トリガーをアクティブ化するときの確認モーダルを有効または無効にします。

openInSameTab
openInSameTab boolean

OPEN_URL タイプを使用する際に、同じブラウザー タブで URL を開くことができるようにします。

location
location True string

HiveCPQ の UI 内の Webhook トリガーの場所です。

タイプ
type True string

Webhook トリガーの種類です。

permissionIds
permissionIds array of string

トリガーにアクセスできる権限 ID のコレクションです。

Webhook ヘッダーの検索

特定の Webhook のヘッダーを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

戻り値

Webhook ヘッダーの追加

特定の webhook に新しいヘッダーを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

key
key True string

Webhook がコールバック中に追加する HTTP ヘッダー キーです。

価値
value True string

Webhook がコールバック中に追加するキーの HTTP ヘッダー値です。

イベントの検索

製造元のプラットフォーム イベントを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

イベント タイプ
eventType string

イベントの種類でフィルターします。

イベントの種類グループ
eventGroup string

イベントの種類でグループをフィルターします。

その後に起こったイベント
dateOccurredAfter date-time

指定した日時以降に発生したイベントをフィルターします。

イベント タイプ
targetIntegrationName string

Hive と統合する外部システムに関連するイベントをフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

イベントの購読

製造元のイベントを購読します。 既存のサブスクリプションは上書きまたは削除されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

body
body string

Webhook がサブスクライブできるイベントです。

ウェブフック を更新する

製造元の webhook を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

url
url True string

Webhook のコールバック URL です。

description
description string

webhook に関する追加情報です。

エベントのサブスクリプションの検索

購読しているイベント サブスクリプションを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Webhook ID
webhookId True string

アクセスする webhook の ID です。

戻り値

カスタム オブジェクト キャッシュのリセット

コンフィギュレーターは、カスタム オブジェクトを処理する際にキャッシュを使用する場合があります。 この エンドポイント を呼び出すと、これらのキャッシュがリセットされます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプを検索する

製造元のカスタム オブジェクト タイプを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

カスタム オブジェクトの取得

特定のタイプの新しいカスタム オブジェクトを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプ
customObjectType True string

アクセスするカスタム オブジェクト タイプの名前です。

カスタム オブジェクト ID
customObjectKey True string

アクセスするカスタム オブジェクトの ID です。

戻り値

カスタム オブジェクトの追加

特定のタイプの新しいカスタム オブジェクトを追加します。 このタイプが存在しない場合は作成されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプ
customObjectType True string

アクセスするカスタム オブジェクト タイプの名前です。

key
key True string

単一のカスタム オブジェクト内の値を識別するために使用される一意のキーです。

価値
value

キーとして保存される値のテキスト表現です。

dataType
dataType string

カスタム オブジェクト値に使用できるデータ型です。

カスタム オブジェクトを削除する

特定のタイプの新しいカスタム オブジェクトを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプ
customObjectType True string

アクセスするカスタム オブジェクト タイプの名前です。

カスタム オブジェクト ID
customObjectKey True string

アクセスするカスタム オブジェクトの ID です。

カスタム オブジェクトを更新する

特定の種類の特定のカスタム オブジェクトを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプ
customObjectType True string

アクセスするカスタム オブジェクト タイプの名前です。

カスタム オブジェクト ID
customObjectKey True string

アクセスするカスタム オブジェクトの ID です。

key
key True string

単一のカスタム オブジェクト内の値を識別するために使用される一意のキーです。

価値
value

キーとして保存される値のテキスト表現です。

dataType
dataType string

カスタム オブジェクト値に使用できるデータ型です。

カスタム オブジェクトを検索する

特定のタイプのカスタム オブジェクトを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

カスタム オブジェクト タイプ
customObjectType True string

アクセスするカスタム オブジェクト タイプの名前です。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンテナのバージョンを検索する

製造元のコンテナ バージョンを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

ID ごと
idsIn array

項目の ID でフィルターします。

コンテナー バージョンの状態
status string

コンテナのバージョンの状態でフィルター処理します。

コンテナー バージョンの種類
type string

コンテナのバージョンの種類でフィルター処理します。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンポーネント ヒントの削除

マスター データからコンポーネント ヒントを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

コンポーネント ヒントの取得

マスターデータ内の特定のコンポーネント ヒントを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

戻り値

コンポーネント ヒントの更新

マスターデータ内の特定のコンポーネント ヒントを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

enabled
enabled boolean

ヒントの表示を有効または無効にします。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

戻り値

コンポーネント ヒント画像の削除

マスター データからコンポーネント ヒント画像を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

コンポーネント ヒント画像の取得

マスターデータからの特定のコンポーネント ヒントを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

コンポーネント ヒント画像の更新

マスターデータ内の特定のコンポーネント ヒント画像を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

File
file True file

アップロードするファイル。

コンポーネントのプロパティ値の設定

マスター データ内のコンポーネントに単一のプロパティ値を設定します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

code
code True string

新しい値を設定する必要があるプロパティ コードです。

価値
value string

プロパティが配列型でない場合のプロパティの新しい値です。

arrayValues
arrayValues array of string

プロパティが配列型の場合、その値の新しいコレクションです。

コンポーネントのプロパティ値の設定

マスター データ内のコンポーネントに複数のプロパティ値を設定します。 既存の値は上書き、または削除されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

code
code True string

新しい値を設定する必要があるプロパティ コードです。

価値
value string

プロパティが配列型でない場合のプロパティの新しい値です。

arrayValues
arrayValues array of string

プロパティが配列型の場合、その値の新しいコレクションです。

コンポーネントのプロパティ値を検索する

マスター データのコンポーネントのプロパティ値を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンポーネントの一括削除

マスター データ内の複数のコンポーネントを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

idsNotIn
idsNotIn array of string

削除すべきではないコンポーネント ID のリストです。 idsIn と併用することはできません。

idsIn
idsIn array of string

削除すべきではないコンポーネント ID のリストです。 idsNotIn と併用することはできません。

コンポーネントの価格を一括で更新/挿入します

マスターデータで複数のコンポーネント価格を作成または更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

itemId
itemId string

このアイテムのカスタム識別子。 これはコンポーネント価格 ID ではありません。

componentCode
componentCode string

価格を追加するコンポーネントのコード。

unitCode
unitCode string

価格に使用するユニットのコード。

priceCatalogName
priceCatalogName string

価格が所属する価格カタログの名前です。

costPrice
costPrice float

コンポーネントの原価価格です。

listPrice
listPrice float

コンポーネントの価格一覧です。

purchasePrice
purchasePrice float

コンポーネントの購入価格です。

subDistributorPurchasePrice
subDistributorPurchasePrice float

コンポーネントのサブ ディストリビューターの購入価格です。

通過
currency string

ISO 4217 形式の通貨です。

戻り値

コンポーネントの削除

マスター データからコンポーネントを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

コンポーネントの取得

マスターデータ内の特定のコンポーネントを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

戻り値

コンポーネントの更新

マスターデータ内の特定のコンポーネントを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

articleCode
articleCode True string

一意の商品コードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

eanCode
eanCode string

ヨーロッパの商品番号です。

gtinCode
gtinCode string

グローバル貿易品目番号です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

productGroup
productGroup string

コンポーネントが属するグループです。

機能
features array of string

機能コードのコレクションです。

code
code True string

新しい値を設定する必要があるプロパティ コードです。

価値
value string

プロパティが配列型でない場合のプロパティの新しい値です。

arrayValues
arrayValues array of string

プロパティが配列型の場合、その値の新しいコレクションです。

コンポーネントの検索

製造元の苦情を検索する

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

苦情の状態
status string

苦情の状態でフィルターします。

苦情の種類
type string

苦情の種類でフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンポーネントの検索

マスターデータ内のコンポーネントを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

価格カタログ ID
priceCatalogId string

コンポーネントの価格に使用される価格カタログでフィルターします。

機能 ID
featureIds array

コンポーネントにリンクされた機能をフィルターします。

記事コード
articleCode string

コンポーネントの商品コードでフィルターします。

EAN コード
eanCode string

コンポーネントの EAN コードでフィルターします。

GTIN コード
gtinCode string

コンポーネントの GTIN コードでフィルターします。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンポーネントの機能をリンク解除する

マスター データの特定のコンポーネントから機能のリンクを解除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

コンポーネントの添付の削除

マスター データのコンポーネントから添付ファイルを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

Attachment ID
attachmentId True string

アクセスする添付の ID です。

コンポーネントの添付ファイルの検索

マスター データのコンポーネントの添付を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

画像である
isImage boolean

ファイルが画像かどうかをフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

コンポーネントの添付ファイルを追加する

マスター データのコンポーネントに新しい添付を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

File
file True file

アップロードするファイル。

画像である
isImage boolean

アップロードされたファイルが画像ファイルであるか情報ファイルであるかを示します。

コンポーネントを追加します

マスター データにコンポーネントを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

articleCode
articleCode True string

一意の商品コードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

eanCode
eanCode string

ヨーロッパの商品番号です。

gtinCode
gtinCode string

グローバル貿易品目番号です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

productGroup
productGroup string

コンポーネントが属するグループです。

機能
features array of string

機能コードのコレクションです。

code
code True string

新しい値を設定する必要があるプロパティ コードです。

価値
value string

プロパティが配列型でない場合のプロパティの新しい値です。

arrayValues
arrayValues array of string

プロパティが配列型の場合、その値の新しいコレクションです。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

コンポーネント価格の削除

マスター データのコンポーネントから価格を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

コンポーネント価格の ID
componentPriceId True string

アクセスするコンポーネントの価格です。

コンポーネント価格の検索

マスター データのコンポーネントの価格を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

戻り値

コンポーネント価格の追加

マスター データのコンポーネントに新しい価格を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

costPrice
costPrice float

コンポーネントの原価価格です。

listPrice
listPrice True float

コンポーネントの価格一覧です。

purchasePrice
purchasePrice float

コンポーネントの購入価格です。

subDistributorPurchasePrice
subDistributorPurchasePrice float

コンポーネントのサブ ディストリビューターの購入価格です。

priceCatalogId
priceCatalogId True string

この価格が属する価格カタログ ID です。

通貨
currency True string

ISO 4217 形式の通貨です。

unitId
unitId True string

価格に使用するユニットの ID です。

スタンドアロン構成の追加

V2 コンフィギュレーターの構成チェックを起動してスタンドアロン構成を作成する

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

configuratorId
configuratorId True string

V2 コンフィギュレーターの ID

versionId
versionId string

コンフィギュレーション内のマスターデ ータが属するコンテナ バージョンの ID です。

uniqueLabel
uniqueLabel string

ノードの一意識別子です。

価値
value string

ノード値のテキスト表現です。

quantity
quantity integer

ノード価格の合計の計算に使用される、このノードが表すアイテムの数量です。

オプション
optional boolean

ノードをオプションとしてマークします。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

セグメントに構成を追加する

特定のプロジェクト セグメントに V1 構成を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

configuratorId
configuratorId True string

V1 コンフィギュレーターの ID です。

initialValues
initialValues object

構成を初期化するために使用される入力値です。

quantity
quantity integer

品目の数量。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

ディストリビューター アカウントの削除

ディストリビューターのアドレス帳から特定の取引先企業を削除します。 取引先企業は、どのプロジェクトでも使用されておらず、取引先担当者がいない場合にのみ削除できます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

Account ID
accountId True string

アクセスする取引先企業の ID です。

ディストリビューター アカウントの更新

ディストリビューターのアドレス帳から特定の取引先企業を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

Account ID
accountId True string

アクセスする取引先企業の ID です。

名称
name string

会社名。

description
description string

会社に関する追加情報です。

vatNumber
vatNumber string

会社の VAT 番号です。

電話番号
phone string

会社の電話番号です。

メールアドレス
email string

会社のメール アドレスです。

websiteUrl
websiteUrl string

会社のウェブサイトの URL です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

ディストリビューター アカウントの追加

ディストリビューターのアドレス帳にアカウントを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

名称
name string

会社名。

description
description string

会社に関する追加情報です。

vatNumber
vatNumber string

会社の VAT 番号です。

電話番号
phone string

会社の電話番号です。

メールアドレス
email string

会社のメール アドレスです。

websiteUrl
websiteUrl string

会社のウェブサイトの URL です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

ディストリビューターの担当者を更新する

ディストリビューターのアドレス帳から特定の取引先担当者を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

Contact ID
contactId True string

アクセスする取引先担当者の ID です。

firstName
firstName True string

取引先担当者の名前です。

lastName
lastName True string

取引先担当者の苗字です。

メールアドレス
email True string

取引先担当者の電子メール アドレスです。

salutation
salutation string

取引先担当者の敬称です。

function
function string

取引先企業の役職。

電話番号
phone string

取引先担当者の電話番号。

携帯電話
mobile string

取引先担当者の携帯電話番号

preferredLanguageIso
preferredLanguageIso string

ISO 639-1 形式の取引先担当者の既定の言語です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

vatNumber
vatNumber string

取引先担当者の VAT 番号です。

vatCondition
vatCondition string

この取引先担当者の既定の VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

この取引先担当者の既定の出荷条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

この取引先担当者の既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

ディストリビューター取引先企業の検索

ディストリビューターのアドレス帳に取引先企業を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

ディストリビューター取引先担当者の検索

ディストリビューターのアドレス帳に取引先担当者を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

Account ID
accountId string

取引先担当者が接続されている取引先企業でフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

プロジェクの再計算

プロジェクトの非同期再計算を開始します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

プロジェクト セグメント 項目の削除

プロジェクトから特定のプロジェクト セグメント項目を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント 項目 ID
projectSegmentItemId True string

アクセスするセグメント項目の ID です。

プロジェクト セグメント 項目の更新

製造元の特定のプロジェクト セグメント項目を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント 項目 ID
projectSegmentItemId True string

アクセスするセグメント項目の ID です。

名称
name string

構成の名前です。

quantity
quantity True integer

品目の数量。

externalSerialNumbers
externalSerialNumbers array of string

外部システムの構成識別に使用できるオプションの識別子です。

プロジェクト セグメントのアーカイブ

製造元の特定のプロジェクト セグメントをアーカイブします。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

プロジェクト セグメントのアーカイブ解除

製造元の特定のプロジェクト セグメントのアーカイブを解除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

プロジェクト セグメントのキャンセル オーダー プロセス

注文プロセスをキャンセルし、プロジェクト セグメントをステップ 2 に戻します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

プロジェクト セグメントの検索

製造元のプロジェクト セグメントを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

企業 ID
companyBId string

プロジェクト セグメントが作成されたディストリビューターの会社でフィルターします。

Step
step string

プロジェクト セグメントの受注フローのステップでフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

プロジェクト セグメントの設定を変更する

プロジェクト セグメントの設定を変更します。 設定は、セグメント コンフィギュレーターが構成されている場合にのみ使用できます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

入力
inputs object

セグメント コンフィギュレータの入力として使用されるキーと値のマップです。

プロジェクト セグメントをステップ 1 に移動する

特定のプロジェクト セグメントをステップ 1 に移動します。 これで受注プロセスが開始されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

customerPoRef
customerPoRef True string

発注書の参照です。

orderRemark
orderRemark True string

注文に関するコメントです。

shippingDateRequested
shippingDateRequested True date-time

要求された日付 (ISO-8601 形式) です。

vatCondition
vatCondition string

VAT の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

出荷の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

支払いの状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

戻り値

返答
string

プロジェクト セグメントをステップ 2 に移動する

特定のプロジェクト セグメントをステップ 2 に移動します。 これにより、プロジェクト セグメントの注文が作成されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

customerPoRef
customerPoRef True string

発注書の参照です。

orderRemark
orderRemark True string

注文に関するコメントです。

shippingDateRequested
shippingDateRequested True date-time

要求された日付 (ISO-8601 形式) です。

vatCondition
vatCondition string

VAT の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

出荷の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

支払いの状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

戻り値

返答
string

プロジェクト セグメントをステップ 3 に移動する

特定のプロジェクト セグメントをステップ 3 に移動します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

orderRemarkSupplier
orderRemarkSupplier True string

受注の製造元のコメントです。

supplierSoRef
supplierSoRef True string

受注の参照です。

shippingDateConfirmed
shippingDateConfirmed date-time

ISO-8601 形式の確定日付です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

戻り値

返答
string

プロジェクト セグメントをステップ 4 に移動する

特定のプロジェクト セグメントをステップ 4 に移動します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

orderRemarkSupplier
orderRemarkSupplier True string

受注の製造元のコメントです。

supplierSoRef
supplierSoRef True string

受注の参照です。

shippingDateConfirmed
shippingDateConfirmed True date-time

ISO-8601 形式の確定日付です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

戻り値

返答
string

プロジェクト セグメントを更新する

製造元の特定のプロジェクト セグメントを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

orderRemark
orderRemark string

注文に関するコメントです。

orderRemarkFromManufacturer
orderRemarkFromManufacturer string

受注の製造元のコメントです。

shippingDateRequested
shippingDateRequested date-time

要求された日付 (ISO-8601 形式) です。

shippingDateConfirmed
shippingDateConfirmed date-time

ISO-8601 形式の確定日付です。

customerPoRef
customerPoRef string

発注書の参照です。

manufacturerSoRef
manufacturerSoRef string

受注の参照です。

manufacturerReference
manufacturerReference string

製造元の参照です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

vatCondition
vatCondition string

VAT の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

出荷の状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

支払いの状態コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

orderSenderContactId
orderSenderContactId string

送信者の取引先担当者 ID

orderReceiverContactId
orderReceiverContactId string

受信者の取引先担当者 ID

companyASalesManagerId
companyASalesManagerId string

製造元営業マネージャーの取引先担当者 ID です。

companyBSalesManagerId
companyBSalesManagerId string

ディストリビューター営業マネージャーの取引先担当者 ID です。

ステータス
status string

セグメントの状態。 プロジェクトがまだ注文プロセスのステップ 0 にある場合、デフォルトは RUNNING になります。

nextFollowUpDate
nextFollowUpDate date-time

次の フォローアップ の日付。

estimatedSalesDate
estimatedSalesDate date-time

推定販売日。

フリーテキストメモ
freeTextNote string

セグメントに関するフリーメモ。

saleProbability
saleProbability integer

販売確率

ステータス
status string

注文の外部の状態です。

statusUrl
statusUrl string

ユーザーが外部の注文状態を確認したり、注文に関する出荷情報を表示したりするために使用できる URL です。

statusText
statusText string

出荷情報に表示するカスタム テキストです。

orderGroup
orderGroup string

受注グループです。

戻り値

返答
string

プロジェクト セグメント項目の取得

製造元の特定のプロジェクト セグメント項目を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント 項目 ID
projectSegmentItemId True string

アクセスするセグメント項目の ID です。

戻り値

プロジェクト セグメント項目の検索

特定の製造元のプロジェクト セグメント項目を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

最終更新日
updatedSince date-time

指定された時間より前に最終更新されたすべての結果を取得します。

プロジェクト セグメント ID
projectSegmentId string

項目のプロジェクト セグメントをフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

プロジェクト セグメント項目を別のプロジェクトにコピーする

プロジェクト セグメント項目を別のプロジェクトにコピーします。 アイテムに構成がアタッチされている場合、自動的に最新バージョンにアップグレードされます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント 項目 ID
projectSegmentItemId True string

アクセスするセグメント項目の ID です。

projectId
projectId True string

ターゲット プロジェクトの ID です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

プロジェクトに構成を追加する

プロジェクトに新規 V2 構成を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

quantity
quantity integer

追加されるこの構成の数量です。

configuratorId
configuratorId True string

V2 コンフィギュレーターの ID です。

名称
name string

構成の名前です。

uniqueLabel
uniqueLabel string

ノードの一意識別子です。

価値
value string

ノード値のテキスト表現です。

quantity
quantity integer

ノード価格の合計の計算に使用される、このノードが表すアイテムの数量です。

オプション
optional boolean

ノードをオプションとしてマークします。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

プロジェクトに製品を追加する

製造元のプロジェクトに 1 つ以上の製品を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

articleCode
articleCode True string

追加する商品の商品コードです。

quantity
quantity True integer

追加されるこの製品の数量です。

serialNumber
serialNumber string

外部システムで製品を識別するためのシリアル番号です。

serialMatched
serialMatched boolean

製品履歴を利用する場合は、製品のシリアル番号を照合してください。

mainCategoryName
mainCategoryName string

商品を探すメイン カテゴリーのコードです。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

戻り値

名前 パス 説明
array of string

作成されたすべてのプロジェクト セグメント アイテムの ID のリストです。

プロジェクトのコピー

プロジェクトのすべてのデータを新しいプロジェクトにコピーします。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

projectName
projectName True string

新しいプロジェクトの名前です。

distributorId
distributorId string

新プロジェクトのディストリビューターです。 提供されない場合は、オリジナル プロジェクトのディストリビューターを使用します。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

プロジェクトのセグメントを取得する

製造元の特定のプロジェクト セグメントを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プロジェクト セグメント ID
projectSegmentId True string

アクセスするセグメントの ID です。

戻り値

プロジェクトのドキュメントを生成する

特定のプロジェクトの PDF ドキュメントを生成します。 テンプレート ID は、ドキュメント タイプが QUOTE で、既定のテンプレートが設定されている場合にのみオプションです。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

タイプ
type string

出力文書テンプレートの種類です。

outputDocumentTemplateId
outputDocumentTemplateId string

出力文書テンプレートの ID です。

language
language True string

ドキュメントを生成する際に使用するISO 639-1 言語コード。

プロジェクトの追加

企業の新規プロジェクトを追加する。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

companyId
companyId True string

プロジェクトが属するディストリビューターの ID です。

名称
name string

プロジェクトの名前です。

sellToCustomerReference
sellToCustomerReference string

最終顧客向けのリファレンスです。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

taxCondition
taxCondition string

プロジェクトの VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

プロジェクトの出荷条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

プロジェクトの支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

プロジェクトを取得する

製造元の特定のプロジェクトを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

戻り値

プロジェクトを更新する

製造元の特定のプロジェクトを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

会社 ID
projectId True string

アクセスするプロジェクトの ID です。

名称
name string

プロジェクトの名前です。

sellToCustomerReference
sellToCustomerReference string

最終顧客向けのリファレンスです。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

accountId
accountId string

アドレス帳内のアカウントの ID です。

contactId
contactId string

指定されたアカウントの取引先担当者の ID です。

taxCondition
taxCondition string

プロジェクトの VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

プロジェクトの出荷条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

プロジェクトの支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

プロパティの削除

マスター データから特定のプロパティを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

プロパティ ID
propertyId True string

アクセスするプロパティの ID です。

プロパティの更新

マスターデータ内の特定のプロパティを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

プロパティ ID
propertyId True string

アクセスするプロパティの ID です。

情報
info string

プロパティに関する一般的な情報です。

プロパティの検索

マスター データ内のプロパティを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

メール トークンの情報を取得する

HiveCPQ 内から現在プラグインを使用しているユーザーに関する情報を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

プラグインのトークン ID
pluginTokenId True string

ユーザー データを取得する Hive プラグインによって生成されたプラグイン トークンです。

戻り値

ユニットの削除

マスター データから特定のユニットを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ユニット ID
unitId True string

アクセスするユニットの ID です。

ユニットの取得

マスター データから特定のユニットを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ユニット ID
unitId True string

アクセスするユニットの ID です。

戻り値

ユニットの更新

マスター データ内の特定のユニットを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ユニット ID
unitId True string

アクセスするユニットの ID です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

戻り値

返答
string

ユーザー アカウントの取得

特定の製造元に接続されている特定のユーザー アカウントを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ユーザー アカウント ID
userAccountId True string

アクセスするユーザー アカウントの ID です。

戻り値

ロールの検索

製造元が自社の連絡先と代理店の連絡先に定義した役割を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

既定の製造元のロールのみ
defaultRoleForManufacturerCompany boolean

ロールをフィルターして、製造会社のユーザーの既定として使用するロールに絞り込みます。

既定のディストリビューターのロールのみ
defaultRoleForDistributorCompanies boolean

ロールをフィルターして、ディストリビューター企業のユーザーの既定として使用するロールに絞り込みます。

Role Name
name string

ロールの名前でフィルター処理します。

企業 ID
companyId string

項目の企業でフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

代理店の連絡先を削除する

ディストリビューターのアドレス帳から特定の取引先担当者を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

Contact ID
contactId True string

アクセスする取引先担当者の ID です。

代理店の連絡先を追加する

ディストリビューターのアドレス帳に新しい取引先担当者を追加する。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ディストリビューター ID
distributorId True string

アクセスするディストリビューターの ID です。

firstName
firstName True string

取引先担当者の名前です。

lastName
lastName True string

取引先担当者の苗字です。

メールアドレス
email True string

取引先担当者の電子メール アドレスです。

salutation
salutation string

取引先担当者の敬称です。

function
function string

取引先企業の役職。

電話番号
phone string

取引先担当者の電話番号。

携帯電話
mobile string

取引先担当者の携帯電話番号

preferredLanguageIso
preferredLanguageIso string

ISO 639-1 形式の取引先担当者の既定の言語です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

vatNumber
vatNumber string

取引先担当者の VAT 番号です。

vatCondition
vatCondition string

この取引先担当者の既定の VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

この取引先担当者の既定の出荷条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

この取引先担当者の既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

accountId
accountId string

ディストリビューターのアドレス帳に新しい取引先担当者を追加します。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

会社の既定の住所を削除する

会社の特定のの住所を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

既定の住所 ID
defaultAddressId True string

アクセスする既定のアドレスの ID です。

会社の既定の住所を取得する

会社の特定のの住所を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

既定の住所 ID
defaultAddressId True string

アクセスする既定のアドレスの ID です。

戻り値

会社の既定の住所を更新する

会社の特定のの住所を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

既定の住所 ID
defaultAddressId True string

アクセスする既定のアドレスの ID です。

companyName
companyName True string

既定の配送会社または請求書の会社名です。

タイプ
type True string

既定の住所タイプです。

addressLine1
addressLine1 True string

住所 1。

addressLine2
addressLine2 string

住所 2。

city True string

市区町村。

郵便番号
postalCode True string

郵便番号。

countryIso
countryIso True string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

contactPerson
contactPerson True string

既定の配送会社または取引先担当者の会社名です。

contactPhone
contactPhone True string

既定の配送会社または取引先担当者の電話番号です。

メールアドレス
email True email

既定の配送会社または取引先担当者のメールアドレスです。

vatNumber
vatNumber string

既定の請求会社に使用される VAT 番号です。

canChangeAddress
canChangeAddress boolean

ディストリビューターが既定の配送先住所と請求書送付先住所を変更できるようにします。

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

注文プロセス中に、ディストリビューターが既定の配送先住所と請求書送付先住所を変更できるようにします。

会社の既定の住所を検索する

会社の既定の請求書および配送先住所を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

戻り値

会社の検索

製造元に関連する企業を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

Company Name
name string

会社の名前でフィルター処理します。

アーカイブ状態
includeArchived boolean

会社のアーカイブ状態でフィルター処理します。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

会社をアーカイブする

会社とそのすべての取引先担当者をアーカイブします。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

会社をアーカイブ解除する

取引先担当者のアーカイブを解除せずに、会社のアーカイブを解除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

会社を取得する

製造元にリンクされた特定の企業を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

戻り値

会社を更新する

製造元の企業の苦情を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

名称
name True string

会社の名前。

description
description string

会社に関する追加情報です。

vatNumber
vatNumber string

会社の VAT 番号です。

メールアドレス
email email

会社のメール アドレスです。

電話番号
telephone string

会社の電話番号です。

websiteUrl
websiteUrl string

会社のウェブサイトの URL です。

preferredLanguage
preferredLanguage string

ISO 639-1 形式の会社の既定の言語です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

externalSystemId1
externalSystemId1 string

外部システムで会社を識別するために使用される ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

externalSystemId2
externalSystemId2 string

外部システムで会社を識別するために使用される ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

salesRepresentativeContactId
salesRepresentativeContactId string

営業担当者として機能する取引先担当者の ID です。

techSupportManagerContactId
techSupportManagerContactId string

テクニカル サポートマネージャーとして機能する取引先担当者の ID です。

orderProcessingManagerContactId
orderProcessingManagerContactId string

注文処理マネージャーとして機能する取引先担当者の ID です。

shippingManagerContactId
shippingManagerContactId string

出荷サポートマネージャーとして機能する取引先担当者の ID です。

vatConditionCode
vatConditionCode string

この会社のプロジェクトで使用する既定の VAT 条件コード。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryConditionCode
deliveryConditionCode string

この会社のプロジェクトで使用する既定の配送条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentConditionCode
paymentConditionCode string

この会社のプロジェクトで使用する既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

baseDiscount
baseDiscount float

この会社のプロジェクトで構成に使用する既定の割引です。

orderCurrency
orderCurrency string

会社の既定の注文通貨です。

料金
fee float

この会社のプロジェクトが料金基準値に達しない場合に適用される料金です。

しきい値
threshold float

手数料が適用される最も低い価格です。

enabled
enabled boolean

この会社に製品ストアへのアクセスを許可する

storeDiscountPercentage
storeDiscountPercentage float

この会社のプロジェクトで、商品ストアのアイテムに適用される割引率です。

defaultVatConditionCode
defaultVatConditionCode string

この会社のプロジェクトで使用する既定の VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

defaultPaymentConditionCode
defaultPaymentConditionCode string

この会社のプロジェクトで使用する既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

salesPricingStrategy
salesPricingStrategy string

この会社のプロジェクトで使用する既定の価格戦略です。

orderEmails
orderEmails array of email

サブ ディストリビューターに注文メールを送信する際に使用する電子メール アドレスです。

価格カタログの削除

特定の価格カタログを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

価格カタログ ID
priceCatalogId True string

アクセスするカタログの ID です。

価格カタログの取得

製造元の特定の価格カタログを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

価格カタログ ID
priceCatalogId True string

アクセスするカタログの ID です。

戻り値

価格カタログの更新

製造元の特定の価格カタログを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

価格カタログ ID
priceCatalogId True string

アクセスするカタログの ID です。

名称
name True string

価格カタログの一意の名前です。

defaultPriceCatalog
defaultPriceCatalog boolean

価格カタログを既定として設定

価格カタログの検索

製造元の価格カタログを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

価格カタログ名称
name string

価格カタログの名前でフィルター処理します。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

価格カタログの追加

メーカーに対す価格カタログを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

名称
name True string

価格カタログの一意の名前です。

defaultPriceCatalog
defaultPriceCatalog boolean

価格カタログを既定として設定

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

出力文書テンプレートの検索

製造元の出力ドキュメントのテンプレートを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

出荷条件の検索

製造元の出荷条件を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

戻り値

実行中のプロジェクトの価格を更新する

受注プロセスのステップ 2 に達していないすべてのプロジェクトの価格をマスターデータで更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

updateProductStorePrices
updateProductStorePrices boolean

製品ストア内のアイテムの価格を更新します。

projectRecalculationRequired
projectRecalculationRequired boolean

更新後にプロジェクトを再計算する必要があります。

updateConfiguratorPrices
updateConfiguratorPrices boolean

構成の価格を更新します。

招待の検索

製造元の招待を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

取引先担当者統合システムの ID
integratedContactSystemId string

招待を送信する取引先担当者の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

Contact ID
contactId string

招待の送信先の取引先担当者をフィルターします。

取引先担当者の状態
status string

招待の状態でフィルターします。

戻り値

招待状の追加

取引先担当者を会社に参加させるための招待を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

contactId
contactId string

取引先企業 ID です。

integratedSystemName
integratedSystemName string

取引先担当者がわかっている外部システムの名前です。 これは、integratedSystemId と一緒に使用する必要があります。

integratedSystemId
integratedSystemId string

外部システムでの取引先担当者の ID です。 これは、integratedSystemName と一緒に使用する必要があります。

contactId
contactId string

取引先企業 ID です。

integratedSystemName
integratedSystemName string

取引先担当者がわかっている外部システムの名前です。 これは、integratedSystemId と一緒に使用する必要があります。

integratedSystemId
integratedSystemId string

外部システムでの取引先担当者の ID です。 これは、integratedSystemName と一緒に使用する必要があります。

enableSSO
enableSSO boolean

この取引先担当者のシングル サインオンを有効化します。

支払い条件の検索

製造元の支払い条件を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

戻り値

新しいプロパティを追加する

マスター データに新規プロパティを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

code
code True string

プロパティの一意のコードです。

タイプ
type True string

プロパティの種類

arrayType
arrayType string

配列プロパティの型です。

情報
info string

プロパティに関する一般的な情報です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

新しい会社を追加する

メーカーに対する新しい会社を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

名称
name True string

会社の名前。

description
description string

会社に関する追加情報です。

vatNumber
vatNumber string

会社の VAT 番号です。

メールアドレス
email email

会社のメール アドレスです。

電話番号
telephone string

会社の電話番号です。

websiteUrl
websiteUrl string

会社のウェブサイトの URL です。

preferredLanguage
preferredLanguage string

ISO 639-1 形式の会社の既定の言語です。

addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

externalSystemId1
externalSystemId1 string

外部システムで会社を識別するために使用される ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

externalSystemId2
externalSystemId2 string

外部システムで会社を識別するために使用される ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

salesRepresentativeContactId
salesRepresentativeContactId string

営業担当者として機能する取引先担当者の ID です。

techSupportManagerContactId
techSupportManagerContactId string

テクニカル サポートマネージャーとして機能する取引先担当者の ID です。

orderProcessingManagerContactId
orderProcessingManagerContactId string

注文処理マネージャーとして機能する取引先担当者の ID です。

shippingManagerContactId
shippingManagerContactId string

出荷サポートマネージャーとして機能する取引先担当者の ID です。

vatConditionCode
vatConditionCode string

この会社のプロジェクトで使用する既定の VAT 条件コード。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryConditionCode
deliveryConditionCode string

この会社のプロジェクトで使用する既定の配送条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentConditionCode
paymentConditionCode string

この会社のプロジェクトで使用する既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

baseDiscount
baseDiscount float

この会社のプロジェクトで構成に使用する既定の割引です。

orderCurrency
orderCurrency string

会社の既定の注文通貨です。

料金
fee float

この会社のプロジェクトが料金基準値に達しない場合に適用される料金です。

しきい値
threshold float

手数料が適用される最も低い価格です。

enabled
enabled boolean

この会社に製品ストアへのアクセスを許可する

storeDiscountPercentage
storeDiscountPercentage float

この会社のプロジェクトで、商品ストアのアイテムに適用される割引率です。

defaultVatConditionCode
defaultVatConditionCode string

この会社のプロジェクトで使用する既定の VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

defaultPaymentConditionCode
defaultPaymentConditionCode string

この会社のプロジェクトで使用する既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

salesPricingStrategy
salesPricingStrategy string

この会社のプロジェクトで使用する既定の価格戦略です。

distributorId
distributorId True string

このサブ ディストリビューターがリンクされるディストリビューター会社の ID です。

orderEmails
orderEmails array of email

注文メールを受信するすべてのサブ ディストリビューターの電子メールです。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

新しい単位の追加

マスター データに新しい単位を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

code
code True string

出荷単位を表す一意のコードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

新しい既定のアドレスを追加する

新しい既定のアドレスを会社に追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

企業 ID
companyId True string

アクセスする会社の ID です。

companyName
companyName True string

既定の配送会社または請求書の会社名です。

タイプ
type True string

既定の住所タイプです。

addressLine1
addressLine1 True string

住所 1。

addressLine2
addressLine2 string

住所 2。

city True string

市区町村。

郵便番号
postalCode True string

郵便番号。

countryIso
countryIso True string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

contactPerson
contactPerson True string

既定の配送会社または取引先担当者の会社名です。

contactPhone
contactPhone True string

既定の配送会社または取引先担当者の電話番号です。

メールアドレス
email True email

既定の配送会社または取引先担当者のメールアドレスです。

vatNumber
vatNumber string

既定の請求会社に使用される VAT 番号です。

canChangeAddress
canChangeAddress boolean

ディストリビューターが既定の配送先住所と請求書送付先住所を変更できるようにします。

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

注文プロセス中に、ディストリビューターが既定の配送先住所と請求書送付先住所を変更できるようにします。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

新しい機能グループを追加する

マスター データに新しい機能グループを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

code
code True string

機能グループの一意のコードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

検索のアクセス許可

製造元のアクセス許可を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

アクセス許可コード
code string

アクセス許可のコードでフィルターします。

Role ID
roleId string

アクセス許可が接続されているロールでフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

検索ユニット

マスター データ内の検索ユニットを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

ユニットのコード
code string

ユニットのコードでフィルターします。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

検索機能

マスター データ内の特定の機能グループ内の機能を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

構成からファイルを取得する

構成内のファイル ノードに添付されたファイルを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

構成 ID
configurationId True string

アクセスする構成の ID です。

ファイル ノードの一意のラベル
uniqueLabel True string

ファイル ノードの一意のラベルです。

構成のレンダーのスクリーンショット

構成のスクリーンショットのレンダー

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

構成 ID
configurationId True string

アクセスする構成の ID です。

構成の更新

構成内のノードの値を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

構成 ID
configurationId True string

アクセスする構成の ID です。

uniqueLabel
uniqueLabel string

ノードの一意識別子です。

価値
value string

ノード値のテキスト表現です。

quantity
quantity integer

ノード価格の合計の計算に使用される、このノードが表すアイテムの数量です。

オプション
optional boolean

ノードをオプションとしてマークします。

構成を取得する

製造元の特定の構成を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

構成 ID
configurationId True string

アクセスする構成の ID です。

独自のラベル
uniqueLabel array

構成ノードの一意のラベルでフィルターします。

オプションのノードを含める
includeOptionalNodes boolean

オプションの構成ノードをフィルターするか含めます。

戻り値

機能の機能グループを変更する

マスター データの特定の機能の機能グループを変更します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

newFeatureGroupId
newFeatureGroupId True string

新しい機能グループの ID です。

機能をコンポーネントにリンクする

1 つの機能をマスター データのコンポーネントにリンクします。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

機能をコンポーネントにリンクする

1 つ以上の機能をマスター データのコンポーネントにリンクします。 既存のリンクは上書きまたは削除されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

コンポーネント ID
componentId True string

アクセスするコンポーネントの ID です。

featureCodes
featureCodes True array of string

機能コードのコレクションです。

機能を削除する

マスター データの特定の機能グループから機能を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

機能を更新します

マスター データの特定の機能グループに含まれる機能を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

serialSearchFunction
serialSearchFunction string

商品ストアの可視性を決定する JavaScript 関数です。

機能グループから機能を取得する

マスター データの特定の機能グループに含まれる機能を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

機能 ID
featureId True string

アクセスしたい機能の ID です。

戻り値

機能グループに機能を追加する

マスターデータの特定の機能グループに新しい機能を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

code
code True string

機能の一意のコードです。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

serialSearchFunction
serialSearchFunction string

商品ストアの可視性を決定する JavaScript 関数です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

機能グループの順序を変更する

機能グループの並び順を変更することで、商品ストアでの表示方法を変更できます。 すべての既存グループはリクエストの一部である必要があります。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

featureGroupIds
featureGroupIds True array of string

必要なシーケンスに含まれるすべての機能グループ ID のコレクションです。

機能グループを削除する

マスター データから特定の機能グループを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

機能グループを取得する

マスター データ内の特定の機能グループを取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

戻り値

機能グループを更新する

マスター データ内の特定の機能グループを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

languageCode
languageCode True string

言語コードです (ISO 639-1 形式)。

翻訳
translation True string

翻訳済みのテキスト。

戻り値

返答
string

機能グループを検索

マスター データ内の機能グループを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

機能グループ内の機能を並べ替える

特定の機能グループの機能を並べ替え、商品ストアでの表示方法を変更します。 グループ内のすべての既存の機能はリクエストの一部である必要があります。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

コンテナー名
name True string

アクセスするコンテナの名前です。

コンテナー バージョン
version True string

アクセスするバージョンの番号 (例: 1.0.0) です。 「top」を指定すると、利用可能な最新バージョンにアクセスします。

機能グループ ID
featureGroupId True string

アクセスしたい機能グループの ID です。

featureIds
featureIds True array of string

指定された機能グループ内のすべての機能 ID を目的の順序でまとめたコレクションです。

税条件の検索

製造元の税条件を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Language
language string

翻訳されたフィールドを返す ISO 639-1 言語コードを指定します。 指定しなかった場合には、ユーザーの言語が使用されます。

戻り値

統合システム リンクの削除

特定の統合システム リンクを削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

統合システムリンクの ID
integratedSystemLinkId True string

マスター データから特定のプロパティを削除します。

統合システム リンクの更新

製造元の特定の統合システム リンクを更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

統合システムリンクの ID
integratedSystemLinkId True string

マスター データから特定のプロパティを削除します。

integratedSystemName
integratedSystemName True string

外部システムの名前です。

integratedSystemId
integratedSystemId True string

統合リソースの ID です。

戻り値

返答
string

統合システムリンクの検索

製造元の統合システムリンクを検索します。 統合システム リンクには、Hive エンティティと外部システム エンティティ間のリンクが保存されます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

統合されたシステムの ID
integratedSystemIdsIn True array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

統合されたシステムの名称
integratedSystemName True string

項目の統合システム名でフィルターします。

リソースの種類
resourceType True string

統合システム リンクのリソース タイプでフィルター処理します。

戻り値

統合システムリンクの追加

リソースの新しい統合システム リンクを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

integratedSystemName
integratedSystemName True string

外部システムの名前です。

integratedSystemId
integratedSystemId True string

統合リソースの ID です。

resourceType
resourceType True string

統合システムリンクを作成できるリソースのタイプです。

hiveId
hiveId True string

HiveCPQ リソースの ID です。

戻り値

名前 パス 説明
integratedSystemName
integratedSystemName string

integratedSystemName

integratedSystemId
integratedSystemId string

integratedSystemId

resourceType
resourceType enumSystemLinkResourceType

統合システムリンクを作成できるリソースのタイプです。

hiveId
hiveId string

hiveId

苦情から添付ファイルを削除する

苦情から添付ファイルを削除する

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

Attachment ID
attachmentId True string

アクセスする添付の ID です。

苦情のコメントを追加する

特定の苦情に新しいコメントを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

コメント
comment True string

ユーザーのコメントです。

createdByContactId
createdByContactId string

コメントを作成した連絡先の ID です。

createdAt
createdAt string

オブジェクト作成のタイムスタンプです。

updatedByContactId
updatedByContactId string

コメントを更新した連絡先の ID です。

updatedAt
updatedAt string

最終更新のタイムスタンプです。

苦情の削除

製造元の特定の苦情を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

苦情の取得

製造元の特定の苦情を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

戻り値

苦情の更新

製造元の特定の苦情を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

肩書き
title True string

苦情のタイトルです。

description
description True string

苦情の説明です。

companyId
companyId True string

苦情を申し立てた会社の ID です。

ステータス
status True string

苦情の状態です。

タイプ
type True string

苦情の種類です。

articleNumber
articleNumber string

記事の識別子です。

quantity
quantity integer

記事の量です。

orderReference
orderReference True string

注文の参照です。

claimNumber
claimNumber string

このクレームの番号または識別子です。

createdByContactId
createdByContactId string

苦情を作成した連絡先の ID です。

createdAt
createdAt string

オブジェクト作成のタイムスタンプです。

updatedByContactId
updatedByContactId string

苦情を更新した連絡先の ID です。

updatedAt
updatedAt string

最終更新のタイムスタンプです。

苦情の添付ファイルの取得

特定の苦情の添付ファイルを入手します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

Attachment ID
attachmentId True string

アクセスする添付の ID です。

苦情の添付ファイルを追加する

特定の苦情に新しい添付ファイルを追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

File
file True file

アップロードするファイル。

苦情の追加

メーカーに対する新しい苦情を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

肩書き
title True string

苦情のタイトルです。

description
description True string

苦情の説明です。

companyId
companyId True string

苦情を申し立てた会社の ID です。

articleNumber
articleNumber string

記事の識別子です。

quantity
quantity integer

記事の量です。

タイプ
type True string

苦情の種類です。

ステータス
status string

苦情の状態です。

orderReference
orderReference True string

注文の参照です。

claimNumber
claimNumber True string

このクレームの番号または識別子です。

createdByContactId
createdByContactId string

苦情を作成した連絡先の ID です。

createdAt
createdAt string

オブジェクト作成のタイムスタンプです。

updatedByContactId
updatedByContactId string

苦情を更新した連絡先の ID です。

updatedAt
updatedAt string

最終更新のタイムスタンプです。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

苦情コメントの検索

特定の苦情のコメントを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

戻り値

苦情コメントを置き換える

特定の苦情のすべてのコメントを置き換えます。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

コメント
comment True string

ユーザーのコメントです。

createdByContactId
createdByContactId string

コメントを作成した連絡先の ID です。

createdAt
createdAt string

オブジェクト作成のタイムスタンプです。

updatedByContactId
updatedByContactId string

コメントを更新した連絡先の ID です。

updatedAt
updatedAt string

最終更新のタイムスタンプです。

苦情添付ファイルの検索

特定の苦情の添付ファイルを検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

申し立て ID
complaintId True string

アクセスする苦情の ID です。

戻り値

製造元の取引先担当者を検索する

製造元や企業に関連する取引先担当者を検索します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

ID ごと
idsIn array

項目の ID でフィルターします。

統合されたシステムの名称
integratedSystemName string

項目の統合システム名でフィルターします。

統合されたシステムの ID
integratedSystemIdsIn array

項目の統合システム ID でフィルターします。 このフィルターは、統合システム名称のフィルターと一緒に使用する必要があります。

企業 ID
companyId string

項目の企業でフィルターします。

ぺージ番号
page integer

コレクションのページを表示します。

ページ サイズ
pageSize integer

返されるページのサイズを制御します。

戻り値

製造元を取得する

接続しているすべての製造元を取得します。

戻り値

製造元取引先担当者の取得

製造元またはその会社の具体的な取引先担当者を取得します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Contact ID
contactId True string

アクセスする取引先担当者の ID です。

戻り値

製造元取引先担当者の追加

製造元またはその会社の会社に新しい取引先担当者を追加します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

companyId
companyId True string

レストランでは、フル イングリッシュ ブレックファストと新鮮な紅茶またはコーヒーをお楽しみいただけます。

roleIds
roleIds True array of string

取引先担当者に割り当てる必要があるすべてのロールの ID です。

firstName
firstName string
lastName
lastName string
メールアドレス
email email
電話番号
phone string
携帯電話
mobile string
preferredLanguage
preferredLanguage string

ISO 639-1 形式の取引先担当者の既定の言語です。

functionTitle
functionTitle string
addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

salutation
salutation string
externalSystemId
externalSystemId string

外部システムで取引先担当者を識別できる ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

avatarUrl
avatarUrl string

アバターとして使用される画像への公的にアクセス可能な URL です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

統合リソースの ID です。

製造元担当者を更新する

製造元またはその会社の具体的な取引先担当者を更新します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Contact ID
contactId True string

アクセスする取引先担当者の ID です。

roleIds
roleIds True array of string

取引先担当者に付与する必要があるすべてのロールの ID です。

firstName
firstName string
lastName
lastName string
メールアドレス
email email
電話番号
phone string
携帯電話
mobile string
preferredLanguage
preferredLanguage string

ISO 639-1 形式の取引先担当者の既定の言語です。

functionTitle
functionTitle string
addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

salutation
salutation string
externalSystemId
externalSystemId string

外部システムで取引先担当者を識別するために使用する ID です。 通常は、代わりにシステム リンクを使用することをお勧めします。

avatarUrl
avatarUrl string

アバターとして使用される画像への公的にアクセス可能な URL です。

連絡先をアーカイブする

特定の取引先担当者をアーカイブし、その招待を削除します。

パラメーター

名前 キー 必須 説明
製造元 ID
manufacturerId True string

接続先の製造元の ID です。

Contact ID
contactId True string

アクセスする取引先担当者の ID です。

定義

createdAt

オブジェクト作成のタイムスタンプです。

オブジェクト作成のタイムスタンプです。

updatedAt

最終更新のタイムスタンプです。

最終更新のタイムスタンプです。

linkId

リンクされたリソースの一意の ID です。

リンクされたリソースの一意の ID です。

linkName

リンク先のリソースの翻訳の名称です。

リンク先のリソースの翻訳の名称です。

linkHref

リソースの URL です。

リソースの URL です。

外部リンクにより、インテグレーターは外部システムのリソースを HiveCPQ のリソースにリンクできます。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

integratedSystemName
integratedSystemName string

外部システムの名前です。

integratedSystemId
integratedSystemId string

外部システムで表現されるリソースの ID です。

createdAt
createdAt createdAt

オブジェクト作成のタイムスタンプです。

updatedAt
updatedAt updatedAt

最終更新のタイムスタンプです。

このリソースに接続されているすべての統合システム リンクです。

名前 パス 説明
アイテム
externalLink

外部リンクにより、インテグレーターは外部システムのリソースを HiveCPQ のリソースにリンクできます。

このリソースにリンクされているすべてのロールです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

ユニットへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

code
code string

ユニットの一意のコードです。

href
href linkHref

リソースの URL です。

価格カタログへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

href
href linkHref

リソースの URL です。

名称
name string

カタログの一意の名前です。

カテゴリへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

コンポーネントへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

code
code string

コンポーネントの商品コードです。

href
href linkHref

リソースの URL です。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

取引先担当者へのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

href
href linkHref

リソースの URL です。

fullName
fullName string

取引先企業の件名。

ユーザー アカウントへのリンク。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

href
href linkHref

リソースの URL です。

fullName
fullName string

取引先企業の件名。

会社へのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

プロジェクトへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

プロジェクト セグメントへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

href
href linkHref

リソースの URL です。

orderStatus
orderStatus string

注文フローのステップです。

複数のプロジェクト セグメントへのリンクです。

名前 パス 説明
アイテム
projectSegmentLink

プロジェクト セグメントへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

名称
name string

プロジェクト セグメント項目の名前です。

articleCode
articleCode string

製品ストア記事のコード。

ConfiguratorCode
ConfiguratorCode string

設定可能な項目構成のコード。

タイプ
type enumProjectSegmentItemType

プロジェクト セグメント項目の種類です。

発送スケジュールへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

タイプ
type string
週間
week number
year
year number
href
href linkHref

リソースの URL です。

コンフィギュレーターへのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

名称
name linkName

リンク先のリソースの翻訳の名称です。

href
href linkHref

リソースの URL です。

構成へのリンクです。

名前 パス 説明
id
id linkId

リンクされたリソースの一意の ID です。

href
href linkHref

リソースの URL です。

address

標準的なアドレス形式です。

名前 パス 説明
addressLine1
addressLine1 string

住所 1。

addressLine2
addressLine2 string

住所 2。

city string

市区町村。

郵便番号
postalCode string

郵便番号。

countryIso
countryIso string

ISO 3166-2 形式の国番号です。

stateIso
stateIso string

ISO 3166-2 形式の市外局番です。

companyContact

名前 パス 説明
メールアドレス
email string

取引先担当者のメール アドレスです。

companyName
companyName string

会社の名前。

contactPhone
contactPhone string

取引先担当者の電話番号です。

contactName
contactName string

取引先担当者の名前です。

companyVatNumber
companyVatNumber string

会社の VAT 番号です。

address
address address

標準的なアドレス形式です。

customObjectKeyValuePair

これは、カスタム オブジェクトでデータの保存や受け渡しに使用されるキー値のペアを表します。

名前 パス 説明
key
key string

単一のカスタム オブジェクト内の値を識別するために使用される一意のキーです。

価値
value

キーとして保存される値のテキスト表現です。

dataType
dataType enumCustomObjectValueDataType

カスタム オブジェクト値に使用できるデータ型です。

enumBulkResponseStatus

一括アイテムの状態です。

一括アイテムの状態です。

enumCompanyType

会社の種類です。

会社の種類です。

enumConfigurationNodeStatus

ノードの状態です。

ノードの状態です。

enumConfigurationNodeDatatype

ノードの値のデータ種類です。

ノードの値のデータ種類です。

enumProjectSegmentOrderStatus

受注フローにおける注文の状態です。

受注フローにおける注文の状態です。

enumProjectSegmentStatus

セグメントの状態。 プロジェクトがまだ注文プロセスのステップ 0 にある場合、デフォルトは RUNNING になります。

セグメントの状態。 プロジェクトがまだ注文プロセスのステップ 0 にある場合、デフォルトは RUNNING になります。

enumProjectSegmentItemType

プロジェクト セグメント項目の種類です。

プロジェクト セグメント項目の種類です。

enumComponentPropertyType

プロパティの種類

プロパティの種類

enumComponentPropertyArrayType

配列プロパティの型です。

配列プロパティの型です。

enumConfigurationStatus

構成の状態です。

構成の状態です。

enumCustomObjectValueDataType

カスタム オブジェクト値に使用できるデータ型です。

カスタム オブジェクト値に使用できるデータ型です。

enumOutputDocumentTemplateType

出力文書テンプレートの種類です。

出力文書テンプレートの種類です。

enumSystemLinkResourceType

統合システムリンクを作成できるリソースのタイプです。

統合システムリンクを作成できるリソースのタイプです。

enumWebhookEventSubscription

Webhook がサブスクライブできるイベントです。

Webhook がサブスクライブできるイベントです。

enumEventGroup

イベントのイベント グループです。

イベントのイベント グループです。

enumWebhookTriggerLocation

HiveCPQ の UI 内の Webhook トリガーの場所です。

HiveCPQ の UI 内の Webhook トリガーの場所です。

enumWebhookTriggerType

Webhook トリガーの種類です。

Webhook トリガーの種類です。

enumComplaintStatus

苦情の状態です。

苦情の状態です。

enumComplaintType

苦情の種類です。

苦情の種類です。

enumContainerVersionStatus

バージョンの状態

バージョンの状態

enumContainerVersionType

バージョンの種類です。

バージョンの種類です。

enumDefaultAddressType

既定の住所タイプです。

既定の住所タイプです。

enumInviteStatus

招待状の状態です。

招待状の状態です。

distributorAccountInfo

ディストリビューター アカウントに関する一般情報です。

名前 パス 説明
名称
name string

会社名。

description
description string

会社に関する追加情報です。

vatNumber
vatNumber string

会社の VAT 番号です。

電話番号
phone string

会社の電話番号です。

メールアドレス
email string

会社のメール アドレスです。

websiteUrl
websiteUrl string

会社のウェブサイトの URL です。

distributorContactInfo

取引先担当者に関する全般情報です。

名前 パス 説明
firstName
firstName string

取引先担当者の名前です。

lastName
lastName string

取引先担当者の苗字です。

メールアドレス
email string

取引先担当者の電子メール アドレスです。

salutation
salutation string

取引先担当者の敬称です。

function
function string

取引先企業の役職。

電話番号
phone string

取引先担当者の電話番号。

携帯電話
mobile string

取引先担当者の携帯電話番号

preferredLanguageIso
preferredLanguageIso string

ISO 639-1 形式の取引先担当者の既定の言語です。

distributorContactSalesConditions

取引先担当者の営業条件です。

名前 パス 説明
vatNumber
vatNumber string

取引先担当者の VAT 番号です。

vatCondition
vatCondition string

この取引先担当者の既定の VAT 条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

deliveryCondition
deliveryCondition string

この取引先担当者の既定の出荷条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

paymentCondition
paymentCondition string

この取引先担当者の既定の支払い条件コードです。 使用可能なコードは、HiveCPQ 環境内で定義されます。

responseTranslations

トランザクションの一覧です。

名前 パス 説明
languageCode
languageCode string

言語コードです (ISO 639-1 形式)。

翻訳
translation string

翻訳済みのテキスト。

responsePrice

価格情報です。

名前 パス 説明
listPrice
listPrice string

価格表です。

割引
discount string

割引。

purchasePrice
purchasePrice string

購入価格です。

salesPrice
salesPrice string

販売価格。

通過
currency string

ISO 4217 形式の通貨です。

responseGetVersions

名前 パス 説明
アイテム
items array of object

コンテナ バージョンの一覧です。

id
items.id string

コンテナ バージョンの ID です。

version
items.version string

バージョン番号です。

ステータス
items.status enumContainerVersionStatus

バージョンの状態

タイプ
items.type enumContainerVersionType

バージョンの種類です。

メモ
items.notes string

バージョンに関する追加情報です。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetDefaultAddress

名前 パス 説明
id
id string

既定の住所の ID です。

companyName
companyName string

既定のアドレスの会社名です。

タイプ
type enumDefaultAddressType

既定の住所タイプです。

address
address address

標準的なアドレス形式です。

メールアドレス
email string

既定のアドレスでのメールです。

contactPerson
contactPerson string

既定のアドレスの連絡先です。

contactPhone
contactPhone string

既定のアドレスの電話番号です。

vatNumber
vatNumber string

既定のアドレスの VAT 番号です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

canChangeAddress
canChangeAddress boolean

ディストリビューターが既定の配送先住所と請求書送付先住所を変更できますか。

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

ディストリビューターは、注文プロセスで、配送先住所や請求書送付先住所を独自に設定できますか。

responseGetDefaultAddresses

名前 パス 説明
アイテム
items array of responseGetDefaultAddress

既定のアドレスのリストです。

total
total responseTotalCount

結果の合計数です。

responseGetCompany

名前 パス 説明
id
id string

会社の ID です。

タイプ
type enumCompanyType

会社の種類です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

名称
info.name string

会社の名前。

description
info.description string

会社に関する追加情報です。

vatNumber
info.vatNumber string

会社の VAT 番号です。

メールアドレス
info.email string

会社のメール アドレスです。

電話番号
info.telephone string

会社の電話番号です。

websiteUrl
info.websiteUrl string

会社のウェブサイトの URL です。

preferredLanguage
info.preferredLanguage string

ISO 639-1 形式による会社の言語です。

address
info.address address

標準的なアドレス形式です。

externalSystemId1
info.externalSystemId1 string

外部システムで会社を識別するために使用される ID です。

externalSystemId2
info.externalSystemId2 string

外部システムで会社を識別するために使用される ID です。

ディストリビューター
subDistributorSettings.distributor companyLink

会社へのリンクです。

orderEmails
subDistributorSettings.orderEmails array of string

注文メールを受信するすべてのサブ ディストリビューターの電子メールです。

archived
archived boolean

archived

responseGetCompanies

名前 パス 説明
アイテム
items array of responseGetCompany

会社の一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetInvites

名前 パス 説明
アイテム
items array of object

招待状の一覧です。

id
items.id string

招待状の ID です。

ステータス
items.status enumInviteStatus

招待状の状態です。

toEmail
items.toEmail string

招待を送信するメールアドレスです。

createdAt
items.createdAt createdAt

オブジェクト作成のタイムスタンプです。

claimedAt
items.claimedAt string

招待が要求された日付 (ISO-8601 形式) です。

inviteUrl
items.inviteUrl string

招待を受け取ることができる URL です。

fromContact
items.fromContact contactLink

取引先担当者へのリンクです。

toContact
items.toContact contactLink

取引先担当者へのリンクです。

total
total responseTotalCount

結果の合計数です。

responseGetContact

名前 パス 説明
id
id string

取引先担当者の ID です。

firstName
firstName string

取引先担当者の名です。

lastName
lastName string

取引先担当者の苗字です。

メールアドレス
email string

取引先担当者の電子メール アドレスです。

電話番号
phone string

取引先担当者の電話番号。

携帯電話
mobile string

取引先担当者の携帯電話番号です。

preferredLanguage
preferredLanguage string

ISO 639-1 形式による会社の言語です。

functionTitle
functionTitle string

連絡先の役職。

address
address address

標準的なアドレス形式です。

salutation
salutation string

取引先担当者の敬称です。

externalSystemId
externalSystemId string

外部システムで取引先担当者を識別するために使用する ID

avatarUrl
avatarUrl string

取引先担当者のアバターへの URL です。

会社名
company companyLink

会社へのリンクです。

archived
archived boolean

取引先担当者のアーカイブ状態です。

roles
roles roleLinks

このリソースにリンクされているすべてのロールです。

userAccount
userAccount userAccountLink

ユーザー アカウントへのリンク。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

responseGetContacts

名前 パス 説明
アイテム
items array of responseGetContact

取引先担当者のリストです。

total
total responseTotalCount

結果の合計数です。

responseGetComponentProperties

名前 パス 説明
アイテム
items array of object

プロパティ値のリストです。

code
items.code string

プロパティ コードです。

価値
items.value string

プロパティの値です。

arrayValues
items.arrayValues array of string

配列プロパティの値です。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetComponentAttachments

名前 パス 説明
アイテム
items array of object

コンポーネントの添付ファイルの一覧です。

id
items.id string

添付ファイルの ID です。

fileUrl
items.fileUrl string

パブリックにアクセスできる添付ファイルの URL です。

fileName
items.fileName string

添付ファイルのファイル名です。

total
total responseTotalCount

結果の合計数です。

responseGetComponentPrices

名前 パス 説明
アイテム
items array of object

コンポーネントの価格の一覧です。

id
items.id string

コンポーネント価格の ID です。

priceCatalog
items.priceCatalog priceCatalogLink

価格カタログへのリンクです。

unit
items.unit unitLink

ユニットへのリンクです。

costPrice
items.costPrice float

原価価格。

listPrice
items.listPrice float

価格表です。

purchasePrice
items.purchasePrice float

購入価格です。

subDistributorPurchasePrice
items.subDistributorPurchasePrice float

サブ ディストリビューターの購入価格です。

通過
items.currency string

ISO 4217 形式の通貨です。

total
total responseTotalCount

結果の合計数です。

responsePostBulkUpsertComponentPrices

名前 パス 説明
results
results array of object

受注アイテムの一覧。

itemId
results.itemId string

このアイテムのカスタム識別子。

ステータス
results.status enumBulkResponseStatus

一括アイテムの状態です。

message
results.message string

アイテムの処理に失敗した場合の追加情報を含むメッセージ。

successCount
successCount integer

正常にとる扱われた品目の数量。

responseGetComponentTooltip

名前 パス 説明
id
id string

コンポーネント ヒントの ID です。

enabled
enabled boolean

ヒントの表示を有効または無効にします。

titles
titles responseTranslations

トランザクションの一覧です。

details
details responseTranslations

トランザクションの一覧です。

responsePutComponentTooltip

名前 パス 説明
id
id string

ヒントの ID。

responseGetComponent

名前 パス 説明
id
id string

コンポーネントの ID です。

articleCode
articleCode string

コンポーネントの一意の商品コードです。

eanCode
eanCode string

コンポーネントの欧州製品番号です。

gtinCode
gtinCode string

コンポーネントの国際取引商品番号です。

scriptPrice
scriptPrice string

オプションの価格設定スクリプトです。

unitCode
unitCode unitLink

ユニットへのリンクです。

productGroup
productGroup string

コンポーネントのグループです。

showOnlyForSerialNumber
showOnlyForSerialNumber boolean

当該のコンポーネントがシリアル番号検索を通じてのみ製品ストアにアクセスできるかどうかを示します。

minimumQuantity
minimumQuantity integer

このコンポーネントをプロジェクトに追加する際に使用する必要がある最小数量です。

名称
name responseTranslations

トランザクションの一覧です。

description
description responseTranslations

トランザクションの一覧です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

監査
audit responseAudit

監査の情報です。

priceCatalogs
priceCatalogs array of object

コンポーネントに連動する価格です。

通過
priceCatalogs.currency string

ISO 4217 形式の通貨です。

unitCode
priceCatalogs.unitCode string

ユニットの一意のコードです。

costPrice
priceCatalogs.costPrice float

原価価格。

listPrice
priceCatalogs.listPrice float

価格表です。

purchasePrice
priceCatalogs.purchasePrice float

購入価格です。

subDistributorPurchasePrice
priceCatalogs.subDistributorPurchasePrice float

サブ ディストリビューターの購入価格です。

価格 (非推奨)
priceCatalogs.price float

価格表です。 (非推奨、代わりに listPrice を使ってください)

id
priceCatalogs.id string

価格カタログの ID です。

href
priceCatalogs.href linkHref

リソースの URL です。

名称
priceCatalogs.name string

価格カタログの一意の名前です。

categories
categories array of categoryLink

コンポーネントにリンクされているカテゴリのリストです。

explodedViews
explodedViews array of object

コンポーネントにリンクされた分解ビューのリストです。

category
explodedViews.category categoryLink

カテゴリへのリンクです。

explodedViewArea
explodedViews.explodedViewArea string

分解図エリアです。

configurator
configurable.configurator configuratorLink

コンフィギュレーターへのリンクです。

parameters
configurable.parameters array of object

コンポーネントが構成可能製品として構成されている場合の、コンポーネントに関する情報です。

key
configurable.parameters.key string

コンフィギュレータ入力値の識別子です。

価値
configurable.parameters.value string

コンフィギュレーターの入力値です。

機能
features array of featureLink

コンポーネントにリンクされている機能のリストです。

responseGetComponents

名前 パス 説明
アイテム
items array of object

コンポーネントの一覧です。

id
items.id string

コンポーネントの ID です。

名称
items.name string

コンポーネントの翻訳された名称です。

description
items.description string

コンポーネントの翻訳された説明です。

articleCode
items.articleCode string

コンポーネントの一意の商品コードです。

eanCode
items.eanCode string

コンポーネントの欧州製品番号です。

gtinCode
items.gtinCode string

コンポーネントの国際取引商品番号です。

unitCode
items.unitCode unitLink

ユニットへのリンクです。

productGroup
items.productGroup string

コンポーネントのグループです。

showOnlyForSerialNumber
items.showOnlyForSerialNumber boolean

当該のコンポーネントがシリアル番号検索を通じてのみ製品ストアにアクセスできるかどうかを示します。

minimumQuantity
items.minimumQuantity integer

このコンポーネントをプロジェクトに追加する際に使用する必要がある最小数量です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

監査
items.audit responseAudit

監査の情報です。

構成可能
items.configurable boolean

コンフィギュレーターがリンクされているかどうかを示します。

total
total responseTotalCount

結果の合計数です。

responseGetProperties

名前 パス 説明
アイテム
items array of object

プロパティのリストです。

id
items.id string

プロパティの ID。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

code
items.code string

プロパティの一意のコードです。

タイプ
items.type enumComponentPropertyType

プロパティの種類

arrayType
items.arrayType enumComponentPropertyArrayType

配列プロパティの型です。

情報
items.info string

プロパティに関する追加情報です。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetFeature

名前 パス 説明
id
id string

機能の ID です。

code
code string

機能の一意のコードです。

説明
descriptions responseTranslations

トランザクションの一覧です。

監査
audit responseAudit

監査の情報です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

serialSearchFunction
serialSearchFunction string

商品ストアのコンポーネントの可視性を決定する JavaScript 関数です。

responseGetFeatures

名前 パス 説明
アイテム
items array of object

機能の一覧です。

id
items.id string

機能の ID です。

code
items.code string

機能の一意のコードです。

description
items.description string

機能の翻訳された説明です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

serialSearchFunction
items.serialSearchFunction string

商品ストアのコンポーネントの可視性を決定する JavaScript 関数です。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetFeatureGroup

名前 パス 説明
id
id string

機能グループの ID です。

code
code string

機能グループの一意のコードです。

説明
descriptions responseTranslations

トランザクションの一覧です。

監査
audit responseAudit

監査の情報です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

responseGetFeatureGroups

名前 パス 説明
アイテム
items array of object

機能グループの一覧です。

id
items.id string

機能グループの ID です。

code
items.code string

機能グループの一意のコードです。

description
items.description string

機能グループの翻訳された説明です。

監査
items.audit responseAudit

監査の情報です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

total
total responseTotalCount

結果の合計数です。

responseGetUnit

名前 パス 説明
id
id string

ユニットの ID です。

code
code string

ユニットの一意のコードです。

名前
names responseTranslations

トランザクションの一覧です。

監査
audit responseAudit

監査の情報です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

responseGetUnits

名前 パス 説明
アイテム
items array of object

ユニットの一覧です。

id
items.id string

ユニットの ID です。

code
items.code string

ユニットの一意のコードです。

名称
items.name string

ユニットの翻訳された名称です。

監査
items.audit responseAudit

監査の情報です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

total
total responseTotalCount

結果の合計数です。

responseGetCustomObjectTypes

名前 パス 説明
アイテム
items array of object

カルタム オブジェクト タイプのリストです。

タイプ
items.type string

カスタム オブジェクト タイプの名前です。

href
items.href string

この種類への URL です。

total
total responseTotalCount

結果の合計数です。

responseGetCustomObject

名前 パス 説明
key
key string

顧客オブジェクトの ID です。

href
href string

カスタム オブジェクトを取得する URL です。

keyValues
keyValues array of customObjectKeyValuePair

カスタム オブジェクトのキーと値のリストです。

responseGetCustomObjects

名前 パス 説明
アイテム
items array of responseGetCustomObject

カスタム オブジェクトの一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetProject

名前 パス 説明
id
id string

プロジェクトの ID です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

projectSegments
projectSegments projectSegmentLinks

複数のプロジェクト セグメントへのリンクです。

名称
name string

プロジェクトの名前です。

sellToCustomerReference
sellToCustomerReference string

顧客の参照です。

会社名
sellTo.company companyLink

会社へのリンクです。

連絡先
sellTo.contact contactLink

取引先担当者へのリンクです。

会社名
invoice.company companyLink

会社へのリンクです。

連絡先
invoice.contact contactLink

取引先担当者へのリンクです。

会社名
delivery.company companyLink

会社へのリンクです。

連絡先
delivery.contact contactLink

取引先担当者へのリンクです。

会社名
installation.company companyLink

会社へのリンクです。

連絡先
installation.contact contactLink

取引先担当者へのリンクです。

vatCondition
salesConditions.vatCondition string

プロジェクトの VAT 条件コードです。

vatPercentage
salesConditions.vatPercentage string

プロジェクトの VAT 割合です。

deliveryCondition
salesConditions.deliveryCondition string

プロジェクトの出荷条件コードです。

paymentCondition
salesConditions.paymentCondition string

プロジェクトの支払い条件コードです。

監査
audit responseAudit

監査の情報です。

responseGetProjects

名前 パス 説明
アイテム
items array of responseGetProject

プロジェクトの一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetProjectSegment

名前 パス 説明
id
id string

プロジェクト セグメントの ID です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

projectSegmentItems
projectSegmentItems array of projectSegmentItemLink

projectSegmentItems

プロジェクト
project projectLink

プロジェクトへのリンクです。

orderStatus
order.orderStatus enumProjectSegmentOrderStatus

受注フローにおける注文の状態です。

moveToStep1At
order.moveToStep1At string

プロジェクトが最後にステップ 1 に移動されたときのタイムスタンプです。

moveToStep2At
order.moveToStep2At string

プロジェクトが最後にステップ 2 に移動されたときのタイムスタンプです。

moveToStep3At
order.moveToStep3At string

プロジェクトが最後にステップ 3 に移動されたときのタイムスタンプです。

moveToStep4At
order.moveToStep4At string

プロジェクトが最後にステップ 4 に移動されたときのタイムスタンプです。

orderRemark
order.orderRemark string

注文に関するコメントです。

orderRemarkFromManufacturer
order.orderRemarkFromManufacturer string

受注の製造元のコメントです。

shippingDateRequested
order.shippingDateRequested string

要求された日付 (ISO-8601 形式) です。

shippingDateConfirmed
order.shippingDateConfirmed string

ISO-8601 形式の確定日付です。

customerPoRef
order.customerPoRef string

顧客の発注参照番号です。

manufacturerSoRef
order.manufacturerSoRef string

製造元の受注番号です。

manufacturerReference
order.manufacturerReference string

製造元の参照です。

delivery
order.delivery companyContact
請求書
order.invoice companyContact
sellTo
order.sellTo companyContact
インストール
order.installation companyContact
vatCondition
order.salesCondition.vatCondition string

受注の VAT 条件コードです。

vatPercentage
order.salesCondition.vatPercentage string

受注の VAT パーセンテージです。

deliveryCondition
order.salesCondition.deliveryCondition string

受注の出荷条件コードです。

paymentCondition
order.salesCondition.paymentCondition string

受注の支払い条件コードです。

orderSenderContact
order.orderSenderContact contactLink

取引先担当者へのリンクです。

orderReceiverContact
order.orderReceiverContact contactLink

取引先担当者へのリンクです。

price
price responsePrice

価格情報です。

companyAId
companyRelation.companyAId string

製造元 ID です。

companyBId
companyRelation.companyBId string

ディストリビューターの ID です。

companyASalesManager
companyASalesManager contactLink

取引先担当者へのリンクです。

companyBSalesManager
companyBSalesManager contactLink

取引先担当者へのリンクです。

ステータス
status enumProjectSegmentStatus

セグメントの状態。 プロジェクトがまだ注文プロセスのステップ 0 にある場合、デフォルトは RUNNING になります。

nextFollowUpDate
nextFollowUpDate string

ISO-8601 形式の次の フォローアップ 日付。

estimatedSalesDate
estimatedSalesDate string

ISO-8601 形式の推定販売日。

フリーテキストメモ
freeTextNote string

セグメントに関するメモ。

saleProbability
saleProbability integer

販売確率。

ステータス
externalOrderStatus.status string

注文の外部の状態です。

statusUrl
externalOrderStatus.statusUrl string

ユーザーが外部の注文状態を確認したり、注文に関する出荷情報を表示したりするために使用できる URL です。

statusText
externalOrderStatus.statusText string

出荷情報に表示されるカスタム テキストです。

orderGroup
orderGroup string

受注グループです。

configurationStatus
configurationStatus enumConfigurationStatus

構成の状態です。

構成
configuration configurationLink

構成へのリンクです。

subDistributor
subDistributor companyLink

会社へのリンクです。

responseGetProjectSegments

名前 パス 説明
アイテム
items array of responseGetProjectSegment

セグメントの一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetProjectSegmentItem

名前 パス 説明
id
id string

プロジェクト セグメント項目の ID です。

名称
name string

プロジェクト セグメント項目の名前です。

タイプ
type enumProjectSegmentItemType

プロジェクト セグメント項目の種類です。

configurationStatus
configurationStatus enumConfigurationStatus

構成の状態です。

quantity
quantity integer

合計価格の計算に使用される商品の数量です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

price
price responsePrice

価格情報です。

externalSerialNumbers
externalSerialNumbers array of string

外部システム内のアイテムの識別子です。

コンポーネント
component componentLink

コンポーネントへのリンクです。

productGroup
productGroup string

品目のグループ。

プロジェクト
project projectLink

プロジェクトへのリンクです。

orderSerialNumberMatched
orderSerialNumberMatched boolean

注文したシリアル番号は合っていますか?

projectSegment
projectSegment projectSegmentLink

プロジェクト セグメントへのリンクです。

監査
audit responseAudit

監査の情報です。

shippingSchedule
shippingSchedule shippingScheduleLink

発送スケジュールへのリンクです。

構成
configuration configurationLink

構成へのリンクです。

responseGetProjectSegmentItems

名前 パス 説明
アイテム
items array of responseGetProjectSegmentItem

プロジェクト セグメント 項目のリストです。

total
total responseTotalCount

結果の合計数です。

名前 パス 説明
アイテム
items array of object

セグメント システムのリンクのリストです。

id
items.id string

統合システムリンクの ID です。

integratedSystemName
items.integratedSystemName string

外部システムの名前です。

integratedSystemId
items.integratedSystemId string

外部システムでのリソースの ID です。

hiveId
items.hiveId string

HiveCPQ リソースの ID です。

createdAt
items.createdAt createdAt

オブジェクト作成のタイムスタンプです。

updatedAt
items.updatedAt updatedAt

最終更新のタイムスタンプです。

total
total responseTotalCount

結果の合計数です。

responseGetDistributorAccounts

名前 パス 説明
アイテム
items array of object

ディストリビューターのアカウントのリストです。

id
items.id string

ディストリビューター アカウントの ID です。

情報
items.info distributorAccountInfo

ディストリビューター アカウントに関する一般情報です。

address
items.address address

標準的なアドレス形式です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetDistributorContacts

名前 パス 説明
アイテム
items array of object

ディストリビューター連絡先のリストです。

id
items.id string

ディストリビューターの取引先担当者の ID です。

情報
items.info distributorContactInfo

取引先担当者に関する全般情報です。

address
items.address address

標準的なアドレス形式です。

salesConditions
items.salesConditions distributorContactSalesConditions

取引先担当者の営業条件です。

externalLinks
items.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetWebhookHeaders

名前 パス 説明
アイテム
items array of object

Webhook ヘッダーのリストです。

id
items.id string

webhook ヘッダーの ID です。

key
items.key string

Webhook コールバック時に HTTP ヘッダーで使用されるキーです。

価値
items.value string

Webhook コールバックの間、HTTP ヘッダーのキーに使用される値です。

total
total responseTotalCount

結果の合計数です。

responseGetWebhookEventSubscriptions

名前 パス 説明
eventSubscriptions
eventSubscriptions array of enumWebhookEventSubscription

Webhook がサブスクライブしているプラットフォームイベントのリストです。

responseGetWebhookTrigger

名前 パス 説明
id
id string

トリガーの ID です。

code
code string

トリガーの一意のコードです。

名前
names responseTranslations

トランザクションの一覧です。

確認
confirmations responseTranslations

トランザクションの一覧です。

confirmationRequired
confirmationRequired boolean

Webhook トリガーがアクティブ化されたときに確認モーダルが表示されるかどうかを示します。

openInSameTab
openInSameTab boolean

OPEN_URL タイプの Webhook トリガーが URL を同じブラウザー タブで開くか、または別のブラウザー タブで開くかを示します。

location
location enumWebhookTriggerLocation

HiveCPQ の UI 内の Webhook トリガーの場所です。

タイプ
type enumWebhookTriggerType

Webhook トリガーの種類です。

permissions
permissions array of object

トリガーにアクセスできる権限のリストです。

id
permissions.id string

アクセス許可の ID です。

code
permissions.code string

アクセス許可を表す一意のコードです。

監査
audit responseAudit

監査の情報です。

responseGetWebhookTriggers

名前 パス 説明
アイテム
items array of object

Webhook トリガーのリストです。

id
items.id string

トリガーの ID です。

code
items.code string

トリガーの一意のコードです。

名称
items.name string

トリガーの翻訳された名称です。

確認する
items.confirmation string

翻訳されたトリガーの確認テキストです。

confirmationRequired
items.confirmationRequired boolean

Webhook トリガーがアクティブ化されたときに確認モーダルが表示されるかどうかを示します。

location
items.location enumWebhookTriggerLocation

HiveCPQ の UI 内の Webhook トリガーの場所です。

タイプ
items.type enumWebhookTriggerType

Webhook トリガーの種類です。

openInSameTab
items.openInSameTab boolean

OPEN_URL タイプの Webhook トリガーが URL を同じブラウザー タブで開くか、または別のブラウザー タブで開くかを示します。

permissions
items.permissions array of object

トリガーにアクセスできる権限のリストです。

id
items.permissions.id string

アクセス許可の ID です。

code
items.permissions.code string

アクセス許可を表す一意のコードです。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetWebhook

名前 パス 説明
id
id string

webhook の ID です。

code
code string

Webhook を表す一意のコードです。

url
url string

Webhook のコールバック URL。

description
description string

webhook に関する追加情報です。

監査
audit responseAudit

監査の情報です。

responseGetWebhooks

名前 パス 説明
アイテム
items array of responseGetWebhook

webhook の一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetPriceCatalog

名前 パス 説明
id
id string

価格カタログの ID です。

名称
name string

価格カタログの一意の名前です。

defaultPriceCatalog
defaultPriceCatalog boolean

デフォルトの価格カタログかどうかを示します。

監査
audit responseAudit

監査の情報です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

responseGetPriceCatalogs

名前 パス 説明
アイテム
items array of responseGetPriceCatalog

価格カタログの一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetComplaintComments

名前 パス 説明
アイテム
items array of object

苦情コメントの一覧です。

id
items.id string

苦情コメントの一意の ID です。

コメント
items.comment string

苦情コメントの内容です。

監査
items.audit responseAudit

監査の情報です。

total
total responseTotalCount

結果の合計数です。

responseGetComplaintAttachments

名前 パス 説明
アイテム
items array of object

苦情の添付ファイルの一覧です。

id
items.id string

苦情の添付ファイルの ID です。

fileName
items.fileName string

苦情添付ファイルの名前です。

contentType
items.contentType string

苦情添付ファイルのコンテンツの種類です。

total
total responseTotalCount

結果の合計数です。

responseGetComplaint

名前 パス 説明
id
id string

苦情の ID です。

肩書き
title string

苦情のタイトルです。

description
description string

苦情に関する追加情報です。

ステータス
status enumComplaintStatus

苦情の状態です。

タイプ
type enumComplaintType

苦情の種類です。

会社名
company companyLink

会社へのリンクです。

orderReference
orderReference string

苦情の注文照会

claimNumber
claimNumber string

苦情のクレーム番号です。

記事
articles array of object

苦情に関する文章です。

articleNumber
articles.articleNumber string

記事の識別子です。

quantity
articles.quantity integer

記事の量です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

監査
audit responseAudit

監査の情報です。

responseGetComplaints

名前 パス 説明
アイテム
items array of responseGetComplaint

苦情の一覧です。

total
total responseTotalCount

結果の合計数です。

responseGetUserAccount

名前 パス 説明
id
id string

ユーザーのアカウント ID です。

contacts
contacts array of contactLink

ユーザー アカウントに接続されている取引先担当者のリストです。

lastActiveAt
lastActiveAt string

ISO-8601 形式のユーザー アカウントの最終ログイン タイムスタンプです。

responseGetRoles

名前 パス 説明
アイテム
items array of object

ロールの一覧です。

id
items.id string

ロールを表す ID です。

名称
items.name string

ロールの一意の名前です。

description
items.description string

ロールに関する追加情報です。

roleType
items.roleType string

ロールの種類

可視性
items.visibility string

ロールの表示方法です。

defaultRoleForManufacturerCompany
items.defaultRoleForManufacturerCompany boolean

ロールは新しい製造元ユーザーの既定のロールとして構成されていますか?

defaultRoleForDistributorCompanies
items.defaultRoleForDistributorCompanies boolean

ロールは新しいディストリビューター ユーザーの既定のロールとして構成されていますか?

companyId
items.companyId string

ロールを所有する会社の ID です。

total
total responseTotalCount

結果の合計数です。

responseGetPermissions

名前 パス 説明
アイテム
items array of object

アクセス許可の一覧です。

id
items.id string

アクセス許可の ID です。

code
items.code string

アクセス許可を表す一意のコードです。

total
total responseTotalCount

結果の合計数です。

responseGetSalesConditions

名前 パス 説明
アイテム
items array of object

営業条件の一覧です。

code
items.code string

一意の条件コードです。

名称
items.name string

条件の翻訳された名称です。

total
total responseTotalCount

結果の合計数です。

responseGetOutputDocumentTemplates

名前 パス 説明
アイテム
items array of object

出力ドキュメント テンプレートの一覧です。

id
items.id string

テンプレートの ID です。

名称
items.name string

テンプレートの名前です。

languageCodes
items.languageCodes array of string

ISO 639-1 形式のこのテンプレートで使用可能な言語コードです。

監査
items.audit responseAudit

監査の情報です。

タイプ
items.type enumOutputDocumentTemplateType

出力文書テンプレートの種類です。

total
total responseTotalCount

結果の合計数です。

responseGetEvents

名前 パス 説明
アイテム
items array of object

プラットフォーム イベントの一覧です。

eventId
items.eventId string

イベントの ID です。

eventType
items.eventType enumWebhookEventSubscription

Webhook がサブスクライブできるイベントです。

eventGroup
items.eventGroup enumEventGroup

イベントのイベント グループです。

translationLabel
items.translationLabel string

イベントの翻訳ラベルです。

データ
items.data object

イベントの日付

userAccountId
items.userAccountId string

イベントを開始したユーザー アカウントの ID です。

translationParams
items.translationParams string

イベント ラベルの変換に使用するパラメーターです。

occurrenceTimestamp
items.occurrenceTimestamp string

イベントが発生した時のタイムスタンプです。

removalTimestamp
items.removalTimestamp string

イベントが削除される際のタイムスタンプです。

distributorIds
items.distributorIds array of string

ディストリビューターの ID です。

total
total responseTotalCount

結果の合計数です。

responseGetPluginToken

名前 パス 説明
contacts
contacts array of object

取引先担当者のリストです。

contactId
contacts.contactId string

取引先企業 ID です。

メールアドレス
contacts.email string

取引先担当者のメールです。

companyId
contacts.companyId string

取引先担当者が所属する会社の ID です。

companyName
contacts.companyName string

取引先担当者が所属する会社の名称です。

externalLinks
contacts.externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

userAccount
contacts.userAccount userAccountLink

ユーザー アカウントへのリンク。

responseGetManufacturers

名前 パス 説明
アイテム
items array of object

製造元の一覧をです。

id
items.id string

製造元の ID です。

名称
items.name string

製造元の名前です。

total
total responseTotalCount

結果の合計数です。

responseGetConfiguration

名前 パス 説明
id
id string

構成 ID

configurator
configurator configuratorLink

コンフィギュレーターへのリンクです。

nodes
nodes array of object

構成ノードのコレクションです。

uniqueLabel
nodes.uniqueLabel string

ノードの一意識別子です。

componentCode
nodes.componentCode string

ノードにリンクされているコンポーネントの記事コードです。

datatype
nodes.datatype enumConfigurationNodeDatatype

ノードの値のデータ種類です。

タイプ
nodes.type string

ノード タイプ。

ステータス
nodes.status enumConfigurationNodeStatus

ノードの状態です。

価値
nodes.value string

ノード値のテキスト表現です。

unit
nodes.unit string

ノードのユニット コードです。

quantity
nodes.quantity number

ノード価格の合計の計算に使用される、このノードが表すアイテムの数量です。

listPrice
nodes.price.listPrice float

ノードの価格表です。

purchasePrice
nodes.price.purchasePrice float

ノードの購入価格です。

オプション
nodes.optional boolean

ノードは構成上で任意ですか?

purchasePrice
price.purchasePrice float

構成の購入価格です。

listPrice
price.listPrice float

構成の価格リストです。

通過
price.currency string

ISO 4217 形式での構成の通貨です。

numberOfDecimals
price.numberOfDecimals integer

価格の小数点以下の精度です。

externalLinks
externalLinks externalLinks

このリソースに接続されているすべての統合システム リンクです。

responseAudit

監査の情報です。

名前 パス 説明
createdBy
createdBy contactLink

取引先担当者へのリンクです。

createdAt
createdAt createdAt

オブジェクト作成のタイムスタンプです。

updatedBy
updatedBy contactLink

取引先担当者へのリンクです。

updatedAt
updatedAt updatedAt

最終更新のタイムスタンプです。

responseTotalCount

結果の合計数です。

結果の合計数です。

string

これは基本的なデータ型 '文字列' です。