Get tracking
Tracking
Get tracking
GET
Get tracking
This is an Enterprise-only feature, enabled only for Return Helper Enterprise customers. To learn more about pricing for this service, contact enterprise-solution@returnhelper.com.
reference.
The tracking number arrives in the label generated webhook — cache it on your side as labels are created, then call this endpoint whenever you need the current status.
What can be looked up
Tracking covers return labels created with one of the supported service types. A tracking number from any other service type, or from a label created before this feature went live, returns a not-found error rather than an empty result.Supported service types
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
Reading the response
All timestamps are ISO 8601 in UTC.
Status values
message is free text from the carrier — display it or log it, but do not parse it or branch on it. Branch on statusSlug instead, and let an unrecognised value fall through to a default rather than failing.Errors
A missing or emptyreference fails validation: HTTP 200, meta.status 400, meta.errorCode VALIDATION_FAILED, with the message under meta.error.reference.
Every other failure comes back as HTTP 200 with meta.status 404, meta.errorCode null, and a human-readable meta.error.message:
- The tracking number is unknown, or the tracking service could not accept it — the message explains which.
Tracking service is temporarily unavailable.— the tracking service could not be reached. The reference may still be valid; retry later.
Related
- Webhooks → Label Result — where the tracking number is delivered.
- Error codes — the full response envelope and error contract.
Authorizations
Your API key
Your API token — keep this private
Query Parameters
Tracking number of a return label generated by Return Helper.
Response
Success — data carries the tracking detail. events is an empty list when the carrier has not reported anything yet.