Get tracking
Tracking
取得 Tracking 資訊
GET
Get tracking
此為 Enterprise 專屬 功能,僅對 Return Helper Enterprise 客戶開放。如需了解本服務的收費方式,請聯絡 enterprise-solution@returnhelper.com。
reference 傳入。
追蹤號碼會透過標籤產生 webhook 送達——請在標籤建立時於您端保存該號碼,之後即可隨時呼叫本端點查詢最新狀態。
可查詢的範圍
追蹤功能涵蓋以支援的服務類型所建立的退貨標籤。若追蹤號碼來自其他服務類型,或來自本功能上線前建立的標籤,會回傳查無資料的錯誤,而非空的結果。支援的服務類型
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.