トレース API の概要
Transparent Supply Trace API を使用すると、許可ユーザーは、組織のサプライ・チェーン製品、ロケーション、イベント、およびトランザクションに関する情報を取得できます。 エンドツーエンドの製品のトレーサビリティーとは、許可されたユーザーが、サプライ・チェーンに沿った組織の製品インスタンスのパスを簡単に見つけて追跡できることを意味します。
トレース・エンドポイント
Trace API は、基本トレースとコンシューマー・トレースの 2 つのエンドポイントを提供します。 デフォルトでは、基本トレースが組み込まれます。コンシューマー・トレースは、組織で選択する必要がある値アドオンです。
基本トレース
基本トレース・エンドポイントは、単一の製品ロット、パレット、またはシリアル番号として、製品インスタンスを入力として使用します。 基本的なトレース結果には、入力製品の他の接続された製品インスタンス両方のイベントおよびトランザクション情報が含まれます。 これらの接続は、例えば、入力商品が他の商品と組み合わされたり、梱包されたりした場合に発生します。
基本トレース呼び出しによって返される JSON ID には、以下のものがあります。
- 製品 ID
- 製品インスタンス (ID) の入力
- 出力製品インスタンス (ID)
- サプライ・チェーン・イベント
基本トレースは、これらの資産の JSON ID のみを返します。 追加のトレース結果を得るには、アプリケーションは追加の呼び出しを行って、製品説明やロケーション・ファシリティーの詳細などの詳細を返す必要があります。
返される JSON は、入力ロット/パレットをルートとするツリー構造であり、ネストされた子として初期入力に関連する他の製品ロット/パレットが含まれます。 ツリー構造内の各ノードは、変換や集約などの関連イベントを介して、他の商品ロット/パレットに接続されます。
JSON 構造をトラバースする場合、サプライ・チェーンの方向は、EPC の性質によって推測できます。
- 出力ロット/パレットは、変換によるダウンストリーム関係です
- 入力ロット/パレットは、変換によるアップストリーム関係です
- 子ロット/パレットは、集約内のアップストリーム関係であり、分解内のダウンストリーム関係です。
- 親ロット/パレットは、集約内のダウンストリーム関係、および分解内のアップストリーム関係です
JSON ツリー構造内の各ノードは、次のような製品ロット/パレットのイベントについても記述します。
- 変換により、入力製品が新規製品に変更されます
- 集約または分解パック、または分離可能な製品のアンパック
- 観測により、サプライ・チェーンに沿った製品の場所が記録されます。
- コミッションは、サプライ・チェーン上の製品インスタンスを発信します。
- 廃止すると、サプライ・チェーンから製品インスタンスが削除されます
アウトバウンド swagger API は、基本データ (製品または機能の説明) から、トレース結果に含まれるような接続されたエレメントまでの出力を返すサービス・エンドポイントを示します。
コンシューマー・トレース
コンシューマー・トレース・エンドポイントは、1 つの製品インスタンス (単一の製品ロット、パレット、またはシリアル番号) も入力として使用します。 使いやすさを向上させるために、同じ基本トレース JSON ID と追加のコンテキスト情報を返します。
基本トレース JSON ID に加えて、コンシューマー・トレースは以下も返します。
- 製品詳細-ID および所有組織
- 施設の詳細-ID および所有組織
- 添付ファイルの詳細-イベント、製品、および施設に添付されたペイロード
- ビジネス・トランザクションの詳細-購入注文、通知のディスパッチ、および通知情報の受信
コンシューマー・トレースによって返されるデータを制限するには、API 呼び出しで以下の 1 つ以上のパラメーターを false に設定します (デフォルト値は true です)。
include_events
include_products
include_lots_and_serials
include_locations
include_trace
include_payloads