Get tracking
Tracking
Tracking 情報を取得
GET
Get tracking
これは 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
レスポンスの読み方
タイムスタンプはすべて UTC の ISO 8601 形式です。
ステータス値
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自体は有効な可能性があるため、時間をおいて再試行してください。
関連
- 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.