国際配送追跡 API

対応する任意の番号で検索

HioBuy の発送 ID が不明な場合は GET /v1/fulfillment/tracking?sn={sn} を使用します。sn には物流番号(logistics_sn)、倉庫注文番号 (order_sn)、または開発者の外部番号(client_order_sn)を指定できます。 HioBuy は値をそのまま転送し、倉庫側が種類を自動判定します。 必要なスコープは tracking:read です。API Key をブラウザーコードに 埋め込まないでください。

GET /v1/fulfillment/shipments/{shipment_id}/tracking — warehouse → overseas recipient.

Not domestic procurement trace (seller → warehouse).
Not package tracking (HioBuy warehouse inbound timeline).
Not shipment detail: that response holds tracking numbers (international_tracking, shipping_legs[], boxes[].tracking) and warehouse business timeline[] (created / packed / paid). This route returns carrier scan events.

Path {shipment_id} accepts the HioBuy shipment id or the external_shipment_id supplied at create time. Numeric-only values are sent as shipment_id; any value containing a non-digit is sent as external_shipment_id. Prefix developer identifiers, for example shp_MY-ORDER-001.

Warehouse upstream: POST /api/gateway-worker/v1/shipments/track. Retired: POST /v1/fulfillment/shipments/logistics/trace.

Request

GET /v1/fulfillment/shipments/107/tracking?language=en
Authorization: Bearer <API_KEY>
ParamInRequiredDescription
snqueryyes, for /v1/fulfillment/trackingLogistics number, warehouse order number, or developer external shipment number
shipment_idpathyes, for the ID-oriented routeShipment order ID or prefixed external_shipment_id
languagequerynoDisplay copy (sandbox). Not forwarded in the warehouse body

Response

The response includes status, independent interception, and newest-first timeline[]. interception is null when no interception was requested; otherwise it reports the interception request state without replacing the shipment lifecycle status. Every event requires { code, status, title, occurred_at, details }; code is stable and non-null, occurred_at is timezone-aware ISO 8601, and details is {} when empty. Use code and status for program logic; title is localized display copy. Standard codes and interception semantics are documented in Shipments · timeline contract.

Get Support

Need integration help? Contact Developer Support at support@hiobuy.com · Response within 1–2 business days

Email support