Skip to main content

Automatic Tracking

  • For the first time, tracking results will be returned within a few seconds after the logistics tracking number is successfully registered (due to network, carrier service and other issues, there may be a delay of more than 5 minutes);
  • Subsequently, tracking will be performed once every 1-2 hours according to the main logistics status, and once every 6 hours for abnormal or delivered packages;
  • The tracking time is the start time, and tracking will end if there is no event update for 30 consecutive days;
  • After the system synchronizes the package status to successfully signed, it will track for another 15 days. If there is no event update during this period, tracking will end;
  • Logistics tracking numbers that have end ped tracking can restart tracking once;
  • Logistics tracking numbers that have end ped tracking will be retained in the current account for 90 days, after which they will be deleted from the current account;

Deduction Instructions

  • Deduction will only be performed after the logistics tracking number is successfully registered;
  • One logistics tracking number corresponds to one order, and no further deductions will be made during automatic tracking;
  • Logistics tracking numbers with the same number but different carriers can be registered normally, and will be deducted as one order after successful registration;
  • If you delete the logistics tracking number and successfully register again, the order quantity will be deducted again;

endpoint

  • /shipment/tracking

method

  • POST

request parameters

fieldtyperequireddescription
tracking_numberstringtrueLogistics tracking number
subscribebooltrueSubscribe type
callback_urlstringfalseCallback URL for tracking
additional_fieldsobjectfalseAdditional fields for tracking

the additional_fields object containe file you can visit additional_fields

  • explain -- about subscribe if you want to subscribe to tracking update, you should set subscribe to true.and you will receive a callback_url when there is a tracking update.
  • callback_url -- if you set subscribe to true, you should set a callback_url. when there is a tracking update, the system will send a POST request to your callback_url with the tracking information.
  • additional_fields
  • some times,the carrier need some additional information to track the package. you can set additional_fields to carrier's api.

get the carrier additional_fields

endpoint

  • /shipment/tracking/additional-fields

method

  • POST

request parameters

fieldtyperequireddescription
carrier_codestringfalseCarrier code

response if success

response if failed