Skip to main content
GET
Get tracking
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
これは Enterprise 専用の機能で、Return Helper Enterprise のお客様のみご利用いただけます。本サービスの料金については enterprise-solution@returnhelper.com までお問い合わせください。
Return Helper が発行した返品ラベルについて、配送ステータスとイベント履歴を返します。そのラベルの追跡番号を reference として渡してください。 追跡番号はラベル生成 webhook で届きます——ラベル作成時に自社側で保存しておき、最新のステータスが必要になったタイミングで本エンドポイントを呼び出してください。

照会できる対象

トラッキングの対象は、対応しているサービスタイプで作成された返品ラベルです。それ以外のサービスタイプの追跡番号や、本機能の提供開始前に作成されたラベルの追跡番号は、空の結果ではなく not found のエラーを返します。

対応しているサービスタイプ

  • DHL_GERMANY
  • RETURN_DHL_ECOMMERCE_DEU
  • RETURN_DHL_ECOMMERCE_INTL_DEU
  • ROYAL_MAIL
  • RETURN_POSTMEN_RM_BIR
  • RETURN_RM48_QRCODE_BIR_GBR
  • FEDEX
  • fedex_ground
  • RETURN_FEDEX_GROUND_WA
  • RETURN_FEDEX_GROUND_USCA
  • RETURN_FEDEX_GROUND_TX
  • UPS
  • RETURN_UPS_SV_HKG

レスポンスの読み方

タイムスタンプはすべて UTC の ISO 8601 形式です。

ステータス値

message はキャリアが提供する自由記述のテキストです。表示やログ出力には使えますが、解析したり分岐条件に使ったりしないでください。分岐には statusSlug を使い、認識できない値はエラーにせずデフォルト処理にフォールバックしてください。

エラー

reference が未指定または空の場合はバリデーションに失敗し、HTTP 200meta.status 400meta.errorCode VALIDATION_FAILED が返り、メッセージは meta.error.reference に格納されます。 それ以外の失敗はすべて HTTP 200meta.status 404meta.errorCode null で返り、meta.error.message に人間が読めるメッセージが入ります。
  • 追跡番号が見つからない、またはトラッキングサービスがその値を受け付けられない場合——どちらであるかはメッセージで示されます。
  • Tracking service is temporarily unavailable. —— トラッキングサービスに到達できませんでした。reference 自体は有効な可能性があるため、時間をおいて再試行してください。

承認

x-rr-apikey
string
header
必須

Your API key

x-rr-apitoken
string
header
必須

Your API token — keep this private

クエリパラメータ

reference
string
必須

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.

data
object