配送会社

ヤマト運輸の追跡を荷物追跡APIで取得する方法

・読了 約6分

荷物追跡APIを使えば、ヤマト運輸(クロネコヤマト)の送り状番号から配送状況をプログラムで取得できます。手作業でヤマトの追跡ページを開く必要はありません。この記事では、ヤマト運輸の追跡を取得する方法を解説します。

ヤマト運輸の配送会社コード

荷物追跡APIでヤマト運輸を指定するには、courierCodeyamato を指定します。送り状番号(追跡番号)は12桁の数字です。

リクエスト

POST /v1/tracking/trace に送り状番号を送ります。

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

レスポンス

荷物追跡APIは、ヤマト運輸の配送履歴(荷物受付・発送済み・配達完了など)を、統一されたステータスコードに正規化して返します。progresses に配送履歴が時系列で入ります。

"data": {
  "courierName": "ヤマト運輸",
  "deliveryStatus": "DELIVERED",
  "deliveryStatusText": "配達完了",
  "isDelivered": true,
  "progresses": [
    { "status": "荷物受付", "deliveryStatus": "PICKED_UP" },
    { "status": "発送済み", "deliveryStatus": "IN_TRANSIT" },
    { "status": "配達完了", "deliveryStatus": "DELIVERED" }
  ]
}

ステータスの正規化

ヤマトの「荷物受付」「発送済み」「配達完了」といった表記は、荷物追跡APIが PICKED_UP / IN_TRANSIT / DELIVERED に正規化します。複数の配送会社を扱う場合も、同じコードで判定できます。

配達完了を自動で知る

配達完了を検知して自動で通知したい場合は、荷物追跡APIのWebhookを使うと、状況が変わったときだけ通知を受け取れます。繰り返し取得するより効率的です。

関連リンク

荷物追跡APIを無料で試す

月10,000件まで無料。追跡番号を送るだけで配送状況が返ります。