ガイドAPIリファレンス
ガイド

セグメントごとのジャーニーの編成

1つのセグメントは、物流の行程の一部を表します。個々のセグメントは、ある場所から別の場所にまたがっているか、またはそのセグメントが滞留セグメントの場合は同じ場所にあります。

出荷のセグメントは、連続する一連の場所で形成する必要があります。つまり、セグメントの出発地は前のセグメントの目的地と一致する必要があります。

trackingIdとは、出荷の指定されたセグメントに割り当てられた登録済みデバイスを指します。ただし、出荷の各セグメントには異なるトラッキングデバイスを割り当てることができるため、trackingIdはセグメントごとに変わる場合があります。これは、特定の運送業者や海上追跡システムとの連携など、出荷が間接的に追跡される場合に一般的です。

デバイスの登録方法については、このガイドの「利用開始」セクションを参照してください。

セグメントにtrackingIdが割り当てられ、そのセグメントの場所にジオフェンスが設定されている場合、セグメントの状態遷移は自動的に更新されます。それ以外の場合は、update segment detailsエンドポイントを使用して、セグメントの状態を手動で更新できます。

自動状態遷移は、ロケーションジオフェンスが重なりあっていない場合、および出荷が指定された順序どおりにすべてのロケーションを通過する場合にのみ機能します。

自動状態遷移が使用されている場合、デバイスが出発地点から離れるとセグメントの移動が自動的に開始され、デバイスが目的地点に入ると完了します。滞留セグメントは出発地点に入ると開始され、その目的地を出ると完了します。

自動状態遷移が使用されており、出荷の最初のセグメントが滞留セグメントである場合、デバイスが滞留セグメントの出発地点に入ったときに出荷と最初のセグメントが開始されます。それに対して、最後のセグメントが滞留セグメントである場合、デバイスが最終目的地点を出ると出荷と最終セグメントが完了します。