API 経由のカタログ
カタログ API は、製品とサービスのカタログを作成できる NTT CPaaS 機能です。その後、これらのカタログをエンド ユーザーとの対話で使用できます。
認証ガイドに従って、NTT CPaaS との接続をセキュリティで保護します。
カタログ
カタログの場合、次のことができます。
1. カタログの作成: 次のいずれかの方法で新しいカタログを作成できます。
- 定義済みのフィールド セットを含むカタログを作成するには、[製品]、[記事]、または [ストア]** のカタログの種類を選択します。カタログ フィールドは自動的に作成されます。追加のカスタムフィールドを指定できます。
- カスタム フィールドのみを含むカタログを作成するには、空白 カタログの種類を選択します。
2. カタログの取得: 次のいずれかの方法でカタログを取得できます。
3. カタログの更新: カタログの名前と説明を更新します。
4. カタログの削除
カタログ フィールド
カタログ fields では、次のことができます。
1. フィールドの作成
2. カタログ フィールドの取得: カタログ フィールドは、次のいずれかの方法で取得できます。
- ID ベース: フィールド識別子を使用して、カタログ内の特定のフィールドを取得します。
- クエリベース: 指定した条件を満たす一連のフィールドをカタログで取得します。例: カタログ内の特定のサイズのすべてのフィールド。
3. [更新] フィールド
4. フィールドの削除
カタログ項目
カタログ items またはレコードでは、次のことができます。
1. アイテムの追加: カタログに 1 つ以上の新しいアイテムを作成します。
2. カタログ アイテムの取得: 次のいずれかの方法でカタログ アイテムを取得できます。
- ID ベース: アイテム識別子を使用して、カタログ内の特定のアイテムを取得します。
- クエリ ベース: 指定した条件を満たす一連のアイテムをカタログで取得します。例: カタログ内の特定のサイズのすべてのアイテム。
3. カタログ アイテムの更新: カタログ アイテムは、次のいずれかの方法で更新できます。
- ID ベース: アイテム識別子を使用して、カタログ内の特定のアイテムを更新します。
- クエリベース: 指定した条件に基づいて、カタログ内の一連のアイテムを更新します。例: セール終了後、ディスカウントを 30% から [なし] に一括更新します。
4. カタログ アイテムの削除: カタログ アイテムは、次のいずれかの方法で削除できます。
- ID ベース : アイテム識別子を使用して、カタログ内の特定のアイテムを削除します。
- クエリベース : カタログ内の指定した条件を満たす一連のアイテムを削除します。例: カタログ内の特定のサイズのすべてのアイテム。
5. アイテム数の取得 : カタログ内のアイテムの合計数を取得します。