トラッキングAPI
宅配業者リストを照会し、運送状情報を照会するAPIについて説明します。
ページネーションに関する詳細はPaginationを参照してください。
Query.carriers(宅配業者リスト照会)
基本
Query.carriersを使って宅配業者のリストを照会することができます。
以下は、使用可能な宅配便業者を10個取り込む例です。 ページネーションに関する内容はPagination文書を参照してください。
国指定
Query.carriersのcountryCodeに優先国を指定することで、宅配業者のソート順のヒント(優先度)を提供することができます。
現在countryCode指定は可能ですが、結果には反映されず、GAリリース以降から反映される予定です。
テキストで宅配業者を検索
Query.carriersのsearchTextを使用して、目的の宅配業者を検索することができます。
入力されたTextに基づいて、ユーザーが希望する宅配業者を推測して、可能性の高い宅配業者のリストを提供します。
運送会社の追加依頼
Delivery Trackerが提供しない運送会社の追加が必要な場合は、こちらを参照してください。
Query.track (運送状情報照会)
Query.trackを使用して、宅配業者IDと運送状番号で運送状情報を照会することができます。
変更を追跡するためにTrack APIを定期的にPollingする方法はお勧めしません。 変更の 追跡が必要な場合は、Tracking Webhook API を使用してください。
推奨タイムアウトは最大15秒です。
最後の情報だけを照会する
デリバリートラッカーを使用する多くのユーザーは、配送が完了したかどうかを判断するために最後のステータス照会を必要とします。 配信トラッカーでは、TrackInfo.lastEventを通じて最後のイベントのみを照会することができます。
全情報を見る
以下の例は、特定の運送状番号の最近のイベント10件を照会する例を示しています。 10個以上のイベントが必要な場合は、Paginationを通じてより多くのイベントを照会することができます。
他にもTrackInfoには送信者情報など、ドキュメントに記載されていない様々な情報が含まれており、詳細はTrackInfoを参照してください。