express-query-v2
宅配便追跡番号検索
宅配便の追跡番号検索APIサービスを提供します。開発者が配送状況を迅速に取得し、自社の業務システムへ簡単に組み込むことができます。
利用料金
5 コイン/回
クイックスタート
統一レスポンス形式のまま、バックエンドから直接呼び出せます。
https://openapi.toolkk.com/v1/express-query-v2cURL 例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/express-query-v2' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "expCode": "shunfeng",\n "expNo": "SF1234567890"\n}'Python 例
import os
import requests
url = "https://openapi.toolkk.com/v1/express-query-v2"
payload = {
"expCode": "shunfeng",
"expNo": "SF1234567890"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go 例
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/express-query-v2"
payload := []byte("{\n \"expCode\": \"shunfeng\",\n \"expNo\": \"SF1234567890\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java 例
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"expCode\": \"shunfeng\",\n \"expNo\": \"SF1234567890\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/express-query-v2"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP 例
<?php
$endpoint = 'https://openapi.toolkk.com/v1/express-query-v2';
$payload = "{\n \"expCode\": \"shunfeng\",\n \"expNo\": \"SF1234567890\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"status": "已签收",
"statusDesc": "快件已签收",
"traces": [
{
"time": "2024-01-01 10:00:00",
"desc": "已签收"
}
]
}
}例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 10000 ms
サーバー側から呼び出す際は、X-API-Key ヘッダーに API Key を設定します。
HTTP ステータスと業務フィールドの両方で成功判定するのがおすすめです。
高頻度利用ではレート制限と再試行戦略を併用してください。
リクエスト項目
サーバーからリクエストを送信し、X-API-Keyヘッダーにキーを設定してください。
リクエスト項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| expCode | string | 未指定 | 未指定 | shunfeng |
| expNo | string | 未指定 | 未指定 | SF1234567890 |
リクエスト例
{
"expCode": "shunfeng",
"expNo": "SF1234567890"
}- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 10000 ms
レスポンス項目
例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| code | string | 未指定 | 未指定 | SUCCESS |
| message | string | 未指定 | 未指定 | success |
| data | object | 未指定 | 未指定 | {...} |
| data.status | string | 未指定 | 未指定 | 已签收 |
| data.statusDesc | string | 未指定 | 未指定 | 快件已签收 |
| data.traces | array | 未指定 | 未指定 | [{"time":"2024-01-01 10:00:00","desc":"已签收"}] |
| data.traces[] | object | 未指定 | 未指定 | {...} |
レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"status": "已签收",
"statusDesc": "快件已签收",
"traces": [
{
"time": "2024-01-01 10:00:00",
"desc": "已签收"
}
]
}
}導入ドキュメント
機能、利用シーン、注意事項。
宅配便追跡番号検索APIの仕様
宅配便追跡番号検索APIは、開発者がシステム内で追跡番号の検索処理を迅速に完了できるよう支援します。構造化された結果を返すため、物流トラッキング、注文照会、顧客への通知などのシナリオに最適です。
適用シナリオ
- 宅配便追跡番号検索機能を、社内システム、SaaSプラットフォーム、自動化ワークフロー、または運用管理画面に組み込むことができます。
- 安定した呼び出し、標準化されたレスポンス、およびオーケストレーション可能なAPI機能を必要とするビジネスシナリオに適しています。
- 全体的な接続の安定性を向上させるため、リクエストのレート制限、失敗時の再試行、および結果のキャッシュ戦略と組み合わせることを推奨します。
導入の推奨事項
- 導入前に、リクエストパラメータの形式、認証方法、およびエラーコードの処理ロジックを確認してください。
- 高頻度で検索を行うシナリオでは、ログ追跡、タイムアウト制御、およびべき等性処理を適切に行うことを推奨します。
- 結果をリスク管理や自動意思決定に使用する場合は、APIのレスポンスのみに単一依存するのではなく、ビジネスルールと組み合わせた二次判断を行うことを推奨します。