Get tracking
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/Tracking/GetTracking \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/Tracking/GetTracking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/Tracking/GetTracking")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/Tracking/GetTracking")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "b6e4a8b0-6f2e-4b7a-9c3d-8a1e2f3c4d5e",
"courierName": "USPS",
"trackingNumber": "TRACK123456789",
"statusSlug": "IN_TRANSIT",
"lastEventAt": "2026-07-29T08:00:00.000Z",
"noFurtherUpdates": true,
"events": [
{
"statusSlug": "IN_TRANSIT",
"message": "Arrived at facility",
"location": "Los Angeles, CA 90001, US",
"eventAt": "2026-07-29T08:00:00.000Z"
}
]
}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}Tracking
Tracking 情報を取得
GET
/
api
/
Tracking
/
GetTracking
Get tracking
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/Tracking/GetTracking \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/Tracking/GetTracking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.returnshelper.com/uat/user/api/Tracking/GetTracking"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/Tracking/GetTracking")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/Tracking/GetTracking")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "b6e4a8b0-6f2e-4b7a-9c3d-8a1e2f3c4d5e",
"courierName": "USPS",
"trackingNumber": "TRACK123456789",
"statusSlug": "IN_TRANSIT",
"lastEventAt": "2026-07-29T08:00:00.000Z",
"noFurtherUpdates": true,
"events": [
{
"statusSlug": "IN_TRANSIT",
"message": "Arrived at facility",
"location": "Los Angeles, CA 90001, US",
"eventAt": "2026-07-29T08:00:00.000Z"
}
]
}
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
これは Enterprise 専用の機能で、Return Helper Enterprise のお客様のみご利用いただけます。本サービスの料金については enterprise-solution@returnhelper.com までお問い合わせください。
reference として渡してください。
追跡番号はラベル生成 webhook で届きます——ラベル作成時に自社側で保存しておき、最新のステータスが必要になったタイミングで本エンドポイントを呼び出してください。
照会できる対象
トラッキングの対象は、対応しているサービスタイプで作成された返品ラベルです。それ以外のサービスタイプの追跡番号や、本機能の提供開始前に作成されたラベルの追跡番号は、空の結果ではなく not found のエラーを返します。対応しているサービスタイプ
DHL_GERMANYRETURN_DHL_ECOMMERCE_DEURETURN_DHL_ECOMMERCE_INTL_DEUROYAL_MAILRETURN_POSTMEN_RM_BIRRETURN_RM48_QRCODE_BIR_GBRFEDEXfedex_groundRETURN_FEDEX_GROUND_WARETURN_FEDEX_GROUND_USCARETURN_FEDEX_GROUND_TXUPSRETURN_UPS_SV_HKG
レスポンスの読み方
| フィールド | 説明 |
|---|---|
statusSlug | 貨物の現在のステータス——ステータス値を参照してください。events の各要素は、その時点で適用されていたステータスを保持します。 |
events | 追跡イベント。各イベントは statusSlug、message、location、eventAt を持ちます。message はその出来事をキャリア自身の表現で記した文言です。キャリアが場所を付与しないイベントでは location は null です。キャリアからの情報がまだない場合は空の配列になります。 |
lastEventAt | 直近のイベントの発生時刻。最初のイベントが届くまでは null です。 |
noFurtherUpdates | この貨物についてこれ以上イベントが見込まれない場合に true になります。ポーリングを停止する判断に使用してください。 |
courierName | 人間が読めるキャリア名。登録直後の追跡番号では null の場合があります。 |
id | トラッキングレコードの識別子。 |
ステータス値
statusSlug | 意味 |
|---|---|
PENDING | 追跡番号は登録済みで、キャリアからの報告はまだありません。 |
IN_TRANSIT | キャリアが荷物を輸送中です。 |
DELIVERED | キャリアが配達完了を報告しました。 |
EXCEPTION | この追跡番号はトラッキングに登録できませんでした。イベントは届きません。当該貨物の追跡が必要な場合は support@returnhelper.com までご連絡ください。 |
message はキャリアが提供する自由記述のテキストです。表示やログ出力には使えますが、解析したり分岐条件に使ったりしないでください。分岐には statusSlug を使い、認識できない値はエラーにせずデフォルト処理にフォールバックしてください。エラー
reference が未指定または空の場合はバリデーションに失敗し、HTTP 200、meta.status 400、meta.errorCode VALIDATION_FAILED が返り、メッセージは meta.error.reference に格納されます。
それ以外の失敗はすべて HTTP 200、meta.status 404、meta.errorCode null で返り、meta.error.message に人間が読めるメッセージが入ります。
- 追跡番号が見つからない、またはトラッキングサービスがその値を受け付けられない場合——どちらであるかはメッセージで示されます。
Tracking service is temporarily unavailable.—— トラッキングサービスに到達できませんでした。reference自体は有効な可能性があるため、時間をおいて再試行してください。
{
"correlationId": "0HNCJ2K1P9RQ4:00000003",
"meta": {
"status": 404,
"data": {},
"errorCode": null,
"error": {
"message": "Tracking service is temporarily unavailable."
}
}
}
関連
- Webhooks → ラベル結果 — 追跡番号が届く場所。
- エラーコード — レスポンスエンベロープとエラー契約の全体像。
承認
Your API key
Your API token — keep this private
クエリパラメータ
Tracking number of a return label generated by Return Helper.
レスポンス
Success — data carries the tracking detail. events is an empty list when the carrier has not reported anything yet.
Show child attributes
Show child attributes