Advanced Integrated Visibility追跡番号サブスクリプションは、Advanced Integrated Visibilityサブスクリプション利用者が追跡番号ベースのWebhookプロジェクトを管理し、APIエンドポイントを使用して新規追跡番号の追加、ジョブ詳細の編集や閲覧などのプロジェクト関連操作を実行するよう設計されています。

注：

• Advanced Integrated Visibilityプロジェクトに対する管理者またはコントリビューターのアクセス権が必要です。
• Advanced Integrated Visibilityおよびその機能の詳細については、Advanced Integrated Visibilityのドキュメントページをご覧ください。

Advanced Integrated Visibility追跡番号サブスクリプションのメリットは次のとおりです。

• APIエンドポイントを使用して、Advanced Integrated Visibilityプロジェクトの追跡番号を簡単に更新および管理できます。
• このAPIを使用すると、各追跡番号を1つずつ関連付ける代わりに、1つのAPIトランザクションで複数の追跡番号をプロジェクトに関連付けることができます。
• APIリクエストを連続して送信し、これらのリクエストの成功／失敗のログ詳細を表示することができます。

Advanced Integrated Visibilityプロジェクトを管理するには、以下のエンドポイントを使用してください。

このAPIは、上記のスクリーンショットに示すプロジェクトの概要からしかアクセスできません。

このエンドポイントを使用して、1つまたは複数の追跡番号を特定のAdvanced Integrated Visibilityプロジェクトに関連付ける非同期ジョブをトリガーします。

このリクエストに必要な入力情報は：

• アクション –リクエストを送信する際に実行するアクションを指定します。例：ADD
• 追跡番号の詳細 –追跡番号を指定します。

1つのリクエストで関連付けることができる追跡番号は、最大1000件までです。このリクエストが正常に完了すると、ジョブID、現在のジョブステータス、およびジョブの作成と完了のタイムスタンプが返送されます。このジョブIDは、後で非同期ジョブのステータスを確認するために使用できます。

このエンドポイントを使用して、非同期ジョブ（キューにある1つ以上の連続したリクエスト）のステータス、または送信されたすべてのジョブのステータスを取得します。

このリクエストに必要な入力情報は：

• ジョブID –ステータスを取得するジョブIDを指定します。

注：このエンドポイントではジョブIDはオプションの入力です。ジョブIDを指定しない場合、送信されたすべてのジョブのステータスが返されます。

このリクエストが正常に完了すると、ジョブID、現在のジョブステータス、およびジョブの作成と完了のタイムスタンプが返送されます。応答には、ジョブの現在のステータスが表示されます。さらに、応答には、ユーザーが確認してトラブルシューティングを行うための成功メッセージ、エラー、または警告も含まれます。

• ジョブステータスが「COMPLETED」と表示されている場合は、すべての追跡番号が検証され、正常に処理されたことを意味します。
  • 「COMPLETED」ステータスは、ステータスは、追跡番号が検証され、正常に処理されたことを意味します。これは、すべての追跡番号が Advanced Integrated Visibilityプロジェクトに正常に追加されたことを意味するものではありません。
  • 複数の追跡番号を関連付けようとして、そのうちのいくつかしか関連付けられず、残りは関連付けに失敗した場合でも、ジョブステータスは「COMPLETED」に更新されます。関連付けリクエストの各追跡番号のステータスを確認するには、バッチレポートをダウンロードする必要があります。

注：

• ジョブステータスが「FAILED」と表示されている場合は、さまざまな理由／ハードエラーによりリクエストが処理できなかったことを意味し、ユーザーは再試行する必要があります。

ステータスとその説明は次のとおりです。

このエンドポイントを使用して、「COMPLETED」ステータスの非同期ジョブのJSON レポートをダウンロードします。

本リクエストに関連して求められる提供情報とは、以下のものです。

• ジョブID –スステータスを取得する対象のジョブIDを指定してください。

注：

• ジョブIDは、このエンドポイントの必須入力項目です。
• 一度にダウンロードできる非同期ジョブのレポートは1件のみです。
• ジョブが「COMPLETED」状態でない場合、レポートをダウンロードしようとするとエラーメッセージが表示されます。

このリクエストの成功応答では、ジョブのレポートがJSON形式で提供されます。

• 1 回のリクエストで、Advanced Integrated Visibilityプロジェクトに関連付けることができる配送追跡番号は、最大1,000 件までです。
• 特定のAdvanced Integrated Visibilityプロジェクトに関連付けることができる追跡番号の数に制限はありません。
• 関連付けられた追跡番号は、特定のAdvanced Integrated Visibilityプロジェクトから40日後に関連付けが解除されます。
• 作成されたジョブIDのステータスおよび詳細は、特定のAdvanced Integrated Visibilityプロジェクトに対して90日後に利用できなくなります。
• 荷受人の住所、荷受人の署名などのセキュリティで保護された追跡情報は、Advanced Integrated Visibility追跡番号サブスクリプションでは利用できません。