追加の構成 API

これらの CPQ 構成 API を使用すると、既存の構成を取得または削除できます。これらはランタイム API を補完するもので、完全な構成の詳細を表示したり、不要になった構成を削除したりするのに役立ちます。これらを標準の作成、更新、再構成、および BOM API と一緒に使用して、エンドツーエンドの構成ワークフローをサポートします。

この記事は ランタイム APIの続編です。認証とセットアップの詳細については、その記事を参照してください。

完全を期すために、構成を取得して CPQ から構成を削除するためのこれらの API エンドポイントが含まれています。

構成を取得

CPQ 構成は、GET 要求を送信することで CPQ サーバーから取得できます。この要求は、応答で構成全体を返します。出力の製品データのみが必要な場合は、GET BOM API 呼び出しのいずれかを使用することを検討してください。

注:

これにより、フィールドの更新やルールの再実行のための構成が CPQ ルールエンジンにロードされることはありません。既存の構成を更新する必要がある場合は、再構成 API 呼び出しを使用します。

表 : 1. GET 要求

HTTP メソッド	GET
URL	https://<tenant>.<sector>.logik.io/api/<uuid>
パスパラメーター	<uuid>	32 文字の CPQ 構成 UUID	required
クエリパラメーター	適用外

サンプル URL:

https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

応答例:

{
"fields": [<ARRAY OF FIELD OBJECTS>],
"uuid": "08176434-9b1e-4fc8-b2c4-8aba2c35fda3", "revision": 0,
"relatedChanges": [
{
"key": "products",
"type": "PRODUCT"
}
],
"valid": true, "messages": [], "productChange": true,
"products": [<ARRAY OF PRODUCTS IN CONFIGURATION>],
"total": 30,
"layouts": [<ARRAY OF LAYOUTS>]
}

構成を削除

CPQ 構成は削除できますが、通常は必須ではありません。この API は CPQ から構成を削除し、今後構成、BOM の取得、または構成の更新には使用できなくなります。

注:

この API は、 CPQ サーバーからのみ構成を削除します。構成が別のアプリケーションで保持されている場合 (つまり、見積明細が Salesforce で作成され、注文が e コマースで行われている場合)、そのデータは変更されません。

表 : 2. DELETE 要求

HTTP メソッド	消去
URL	https://<tenant>.<sector>.logik.io/api/<uuid>
パスパラメーター	<uuid>	32 文字の CPQ 構成 UUID	required
クエリパラメーター	適用外

サンプル URL:

https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

応答例:

{}

サンプルユースケース

新しい顧客が Web サイトにアクセスし、製品を構成してチェックアウトします。

1. 新しい構成→開始 新しい構成の作成 API 呼び出し
2. 構成を更新します → 構成の更新 API 呼び出し
3. 最終的な構成を CPQ → に保存し、構成 API 呼び出しを保存します

顧客が戻ってきて、以前に購入した製品と同様の製品を注文したいと考えています。

1. 既存の CPQ 構成 ID を使用して再構成を実行します → API 呼び出しを再構成
2. CPQ →保存構成 API 呼び出しに保存し直す

複雑な製造品の注文が行われ、エンジニアリングチームはどのような部品が必要で、どのサブアセンブリを構築するかを知る必要があります。

[BOM API を取得 (Get BOM API)] 呼び出し→既存の構成の「製造」部品表を取得します。