クイックスタート
5分でWhereParcel APIを始める
数分でWhereParcel APIを始めましょう。
1. APIキーを取得
登録後、ダッシュボードからAPIキーを取得してください。いつでも解約可能で、解約後も請求期間の終了までご利用いただけます。
2. 最初のリクエストを送信
curl -X POST https://api.whereparcel.com/v2/track \
-H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"trackingItems": [
{
"carrier": "jp.post",
"trackingNumber": "1234567890123"
}
]
}'
3. レスポンスを解析
{
"success": true,
"data": [
{
"carrier": "jp.post",
"trackingNumber": "1234567890123",
"status": "success",
"data": {
"deliveryStatus": "delivered",
"events": [
{
"timestamp": "2026-01-15T05:30:00.000Z",
"status": "delivered",
"location": "東京都渋谷区",
"description": "配達完了",
"rawStatus": "配達完了",
"rawDescription": "配達完了"
}
],
"lastUpdated": "2026-01-15T06:00:00.000Z"
},
"billable": true,
"cached": false
}
],
"summary": { "total": 1, "success": 1, "failed": 0, "usageIncremented": 1 }
}
data は追跡番号ごとに結果が1件ずつ入る配列です。まず各項目の status(success または error)を確認し、次に data.deliveryStatus を読んでください。値は常に次の9つのいずれかです: pending、in_transit、out_for_delivery、delivered、failed、returned、cancelled、lost、unknown。配送業者の原文は rawStatus と rawDescription にそのまま残ります。時刻は UTC です。キャッシュから返った結果は billable: false になります。
次のステップ
- APIプレイグラウンド — コードなしでブラウザから直接APIをテスト
- 認証 - API認証について学ぶ
- APIリファレンス - すべてのエンドポイントを探索
- 配送業者 - サポートされている配送業者を表示