はじめに
Advanced Integrated Visibilityアカウント・ナンバーサブスクリプションは、Advanced Integrated Visibilityサブスクリプション利用者がアカウント・ナンバーベースのAdvanced Integrated Visibilityプロジェクトを管理し、APIエンドポイントを使用して詳細の編集や表示などのプロジェクト関連操作を遂行するよう設計されています。
注:
- このAPIが有効化されているAPIプロジェクトに対して、管理者アクセス権限が必要です。
- Advanced Integrated Visibilityとその機能に関する詳細情報は、Advanced Integrated Visibilityのドキュメントページをご覧ください。
Advanced Integrated Visibilityアカウント・ナンバーサブスクリプションの利点
Advanced Integrated Visibilityアカウント・ナンバーサブスクリプションの利点:
- APIエンドポイントを使用して、Advanced Integrated Visibilityプロジェクトを簡単に更新および管理できます。
- このAPIを使用すると、各アカウントを個別に選択する代わりに、単一のAPIトランザクションで複数のアカウントをプロジェクトに関連付けることができます。
Advanced Integrated Visibilityアカウント・ナンバーサブスクリプションの仕組み
Advanced Integrated Visibilityプロジェクトを管理するには、以下のエンドポイントを使用してください。
Advanced Integrated Visibilityプロジェクトの更新
このエンドポイントを使用して、組織内のAdvanced Integrated Visibilityプロジェクトの詳細を更新します。
このリクエストに必要な入力情報は:
- requestType:更新リクエストの種類を指定します。
- ADD_ACCOUNTS:組織が既に全アカウント向けのAdvanced Integrated Visibilityプロジェクトに関連付けられている場合、既存プロジェクトに新規アカウントを追加するにはこのオプションを使用してください。
- DELETE_ACCOUNTS:このオプションを使用して、プロジェクトからアカウントを削除できます。
- UPDATE_ALL:このオプションを使用して、プロジェクトを定期的に更新できます。
注:これはオプションの要素であり、ユーザーが指定しない場合、デフォルトでUPDATE_ALLが選択されます。 - category:プロジェクトで更新する機能のカテゴリを指定します。例:RETRY_POLICY、PROOF_OF_DELIVERYなど
- subCategories:選択した機能カテゴリの個々の機能を指定します。例:BASIC_HRS、PPOD、SPOD、SHIP、TRANなど
このリクエストに問題がなければ、サブスクリプションID、プロジェクトが貴社内のすべてのアカウントに対して更新されたかどうかを示すインジケーター、および更新されたプロジェクトのタイムスタンプを返します。
プロジェクトの詳細を取得する
このエンドポイントを使用して、指定されたAdvanced Integrated Visibilityプロジェクトの詳細をページネーション形式で取得してください。
このリクエストに必要な入力情報は:
- authorization:認可トークンを指定します。
- subscriptionId:詳細を取得するAdvanced Integrated VisibilityプロジェクトのサブスクリプションIDを指定します。
このリクエストに問題がなければ、指定されたWebhookプロジェクトの詳細がページ分割された形式で生成され、失敗した場合にはアラートまたはエラーの詳細が返されます。
ビジネス規則
- 特定のリクエストにおいて、Advanced Integrated Visibilityプロジェクトに関連付けられる出荷アカウント・ナンバーは最大30,000件までです。
Response