出荷の作成と管理

出荷とは、複数の輸送手段を組み合わせた物流の行程を表します。出荷は、追跡しているアセットのライフサイクルが複数のトラッカーデバイスに及ぶ場合に役立ちます。出荷はセグメントで構成されています。出荷に割り当てられているデバイスは、出荷の全行程のトレースとイベントを生成します。出荷のshipmentIdはtrackingId、Tracking APIと同様の方法で使用できます (該当する場合)。たとえば、出荷のトレースとイベントを検索し、エイリアスとメタデータを出荷に関連付けることができます。新しい出荷は、別々の物流行程ごとにインスタンス化します。ただし、出荷の行程が繰り返される場合は、出荷計画を定義できます。出荷セグメントには、trackingIdの代わりにサブ出荷を割り当てることができます。つまり、そのセグメントのtrackingIdにshipmentIdが含まれている場合、そのセグメントにサブ出荷が割り当てられています。サブ出荷には次の制限があります。

サブ出荷ではsubShipmentプロパティがtrueに設定されている必要があります。
サブ出荷を作成してからでないと、別の出荷 (親出荷) でサブ出荷として使用できません。
サブ出荷が親出荷で使用されている場合、そのサブ出荷は削除できません。
サブ出荷は1階層のみサポートされます。サブ出荷に他のサブ出荷を含めることはできません。
親セグメントの出発地は、最初のサブ出荷セグメントの出発地と同じにする必要があります。また、親セグメントの目的地は、最後のサブ出荷セグメントの目的地と同じにする必要があります。

出荷を作成するときは、autoStartプロパティをtrueに設定することを強くお勧めします。出荷のautoStartプロパティが有効になっている場合、HERE Tracking APIがテレメトリーpingを出発地点で受信してから出発地点の外で受信すると、出荷が開始されます。目的地点内でpingを受信すると、出荷が完了とマークされます。

また、出荷状態は外部位置情報イベントの影響を受ける場合があります。

出荷の到着予定時間 (ETA) の予測は、出荷が作成されたときに初めて計算されます (出発予定時間が提供されている場合)。出荷が開始されると、出荷に関連付けられたデバイスが新しいテレメトリーを取り込んで送信するたびにETAの予測が更新されます。

ETAの最新予測は出荷の詳細から入手できます。

出荷計画を作成するときに、出荷セグメントに事前定義された所要時間を割り当てることもできます。この情報を使用して、出荷計画から出荷がインスタンス化されるときに、出発予定時間 (ETD) と到着予定時間 (ETA) が計算されます。出荷は出荷エンドポイントを介して管理されます。