V1 API
危険性
本項目の v1 API は Deprecated API です。 新たに開発する場合は、v2 APIの使用をお勧めします。 v1 APIの場合、2024-12-31まで提供される予定で、終了30日前にお知らせする予定です。
リンク型
インフォメーション
V2は新規Tracking Link文書を参照してください。
別途開発することなく、あなたのサイトにリンクを追加して、配送照会機能を追加することができます。
https://tracker.delivery/#/:carrier_id/:track_id
**例
<a href="https://tracker.delivery/#/kr.cjlogistics/1234567890" target="_blank">リンク</a>
API型
宅配業者リスト照会API
インフォメーション
V2は新規Tracking APIドキュメントを参照してください。
GET https://apis.tracker.delivery/carriers
**回答例
[
{
"id":"kr.cjlogistics",
"name":"CJ Logistics",
"tel":"+8215881255"
},
{
"id":"kr.coupangls",
"name":"クパン物流サービス"
},
{
"id":"kr.cupost",
"name":"CUコンビニ宅配",
"tel":"+8215771287"
},
{
"id":"kr.chunilps",
"name":"천일택배",
"tel":"+8218776606"
},
{
"id":"kr.cvsnet",
"name":"GS Postbox",
"tel":"+8215771287"
},
...
]。
配送照会API
インフォメーション
V2は新規Tracking APIドキュメントを参照してください。
GET https://apis.tracker.delivery/carriers/:carrier_id/tracks/:track_id
**回答例
{
"carrier":{
"id":"kr.cjlogistics",
"name":"CJ Logistics",
"tel":"+8215881255"
},
"from":{
"name":null,
"time":"2023-12-06T14:58:57+09:00"
},
"to":{
"name":null,
"time":"2024-04-25T17:19:20+09:00"
},
"progresses":[
{
"time":"2023-12-06T14:58:57+09:00",
"status":{
"id":"in_transit",
"text":"トランジット中"
},
"location":{
"name":"Yongsan1"
},
"description":"物流ターミナルに商品が移動中です。"
},
{
"time":"2024-04-24T15:26:13+09:00",
"status":{
"id":"at_pickup",
"text":"集荷処理"
},
"location":{
"name":"경기고양신삼송"
},
"description":"送るお客様から商品を引き取りました"
},
{
"time":"2024-04-24T17:15:37+09:00",
"status":{
"id":"in_transit",
"text":"SM 入庫"
},
"location":{
"name":"徳陽AMP"
},
"description":"配送地域に商品が移動中です。"
},
{
"time":"2024-04-25T06:28:42+09:00",
"status":{
"id":"in_transit",
"text":"トランジット中"
},
"location":{
"name":"大田HUB"
},
"description":"配送地域に商品が移動中です。"
},
{
"time":"2024-04-25T09:17:56+09:00",
"status":{
"id":"out_for_delivery",
"text":"配送出発"
},
"location":{
"name":"忠北ボウン"
},
"description":"お客様の商品を配送する予定です(17~19時)(配送担当:李李ガン 010-9473-1038)"
},
{
"time":"2024-04-25T17:19:20+09:00",
"status":{
"id":"delivered",
"text":"배송완료"
},
"location":{
"name":"충북보은"
},
"description":"お客様の商品が配送完了しました(担当者:李李ガン 010-9473-1038)"
}
],
"state":{
"id":"delivered",
"text":"配送完了"
}
}
認証
Access Tokenを使用する
下記のように Authorization
ヘッダーを注入して Access Token を渡して使う必要があります。
GET https://apis.tracker.delivery/carriers/:carrier_id/tracks/:track_id
認証: TRACKQL-API-KEY [YOUR_CLIENT_ID]:[YOUR_CLIENT_SECRET].
Access Tokenの生成方法はAuthentication文書を参照してください。
認証せずに使用する
危険性
Access Tokenなしで使用することはお勧めしません。 テスト目的でのみご使用ください。
Deprecated された V1 API の場合、下位互換性のために認証ヘッダを挿入しなくても使用可能です。
この場合、IP Addressなどに基づいて Rate Limit がかかります。
認証ヘッダがない場合、適用されるデフォルトのRate Limit割当量は徐々に減少する予定ですので、認証ヘッダを追加して使用してください。