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.