荷物追跡APIの使い方｜追跡番号から配送状況を取得する

荷物追跡APIは、ヤマト運輸・佐川急便・日本郵便などの配送状況を、ひとつのREST APIで取得できるサービスです。この記事では、その使い方を、APIキーの発行から配送状況の取得まで順番に解説します。

荷物追跡APIとは

荷物追跡APIは、追跡番号を送るだけで配送状況を返すAPIです。配送会社ごとに異なるレスポンス形式を、統一されたフォーマットに正規化して返すため、会社ごとの分岐処理は必要ありません。料金は月10,000件まで無料です。

1. APIキーを発行する

まず無料登録してアカウントを作成し、ダッシュボードからAPIキー（pk_）とシークレットキー（sk_）を発行します。すべてのリクエストでは、この2つをコロンでつないで Authorization ヘッダーに指定します。

2. 配送状況を取得する

荷物追跡APIのエンドポイント POST /v1/tracking/trace に、配送会社コードと追跡番号を送ります。ヤマト運輸なら courierCode は yamato です。

curl https://api.trackingapi.jp/v1/tracking/trace \
  -H "Authorization: Bearer pk_***:sk_***" \
  -H "Content-Type: application/json" \
  -d '{ "items": [{ "courierCode": "yamato", "trackingNumber": "追跡番号" }] }'

レスポンス

配送状況は deliveryStatus（コード）と deliveryStatusText（日本語）の両方で返ります。isDelivered で配達完了かどうかを判定できます。

{
  "isSuccess": true,
  "data": {
    "results": [{
      "success": true,
      "data": {
        "courierName": "ヤマト運輸",
        "deliveryStatus": "DELIVERED",
        "deliveryStatusText": "配達完了",
        "isDelivered": true
      }
    }]
  }
}

次のステップ

• ヤマト運輸の追跡を荷物追跡APIで取得する方法
• 荷物追跡APIのWebhookで配送状況の変化を受け取る
• 実際に試す：プレイグラウンドでブラウザからリクエストを送れます
• 詳細な仕様はドキュメントをご覧ください