API ReferenceShipmentsGet detail for a single shipment

Get detail for a single shipment

GET/api/v1/shipments/{shipment_id}

shipment_id accepts the tracking number. Filters by clientId + livemode — your shipment only. Distinct from GET /v1/tracking/{tn} which is intentionally broader (tracking-widget use case).

Parameters

shipment_id*

stringpath

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "id": "IM2605288471293048",
    "status": "in_transit",
    "service_tier": "HKASTDGGSTCM",
    "declared_currency": "USD",
    "declared_fx": {
      "rate": 7.8454,
      "rate_type": "daily",
      "fetched_at": "2026-05-28T07:44:23.908Z",
      "stale": false
    },
    "destination": {
      "country": "US",
      "district": "CA"
    },
    "carrier_code": "yunexpress",
    "dispatch_status": "dispatched",
    "label_pdf_url": "https://example.com/labels/YT2614891234567890.pdf",
    "label_available": true,
    "waybill_number": "YT2614891234567890",
    "last_mile_tracking_number": "9214490312345678901234",
    "billing": {
      "currency": "HKD",
      "status": "settled",
      "pre_charge_hkd": 68.5,
      "charged_hkd": 57.2,
      "chargeable_weight_kg": 0.42,
      "declared_weight_kg": 0.5,
      "settled_at": "2026-05-30T03:12:45.000Z",
      "adjustments_hkd": 0
    },
    "livemode": true,
    "created_at": "2026-05-28T07:44:23.908Z",
    "delivered_at": null,
    "reference_no": "PO-2026-0528-0017",
    "events": [
      {
        "event_at": "2026-06-02T15:20:00.000Z",
        "location": "US",
        "description": "In Transit to Next Facility",
        "status_label": "第三方運送中",
        "carrier_code": "yunexpress",
        "carrier_name": "Yun Express (云途物流)"
      },
      {
        "event_at": "2026-06-01T09:10:00.000Z",
        "location": "CHICAGO, ILLINOIS, US",
        "description": "Clearance processing completed - Import",
        "status_label": "目的地清關",
        "carrier_code": "yunexpress",
        "carrier_name": "Yun Express (云途物流)"
      },
      {
        "event_at": "2026-05-29T13:05:00.000Z",
        "location": "HONG KONG, HK",
        "description": "Departed from sort facility",
        "status_label": "中轉發出",
        "carrier_code": "yunexpress",
        "carrier_name": "Yun Express (云途物流)"
      },
      {
        "event_at": "2026-05-29T02:30:00.000Z",
        "location": "HONG KONG, HK",
        "description": "Arrived at origin facility",
        "status_label": "中轉收貨",
        "carrier_code": "yunexpress",
        "carrier_name": "Yun Express (云途物流)"
      },
      {
        "event_at": "2026-05-28T07:45:10.000Z",
        "location": null,
        "description": "Shipment information received",
        "status_label": "已建單",
        "carrier_code": "yunexpress",
        "carrier_name": "Yun Express (云途物流)"
      }
    ]
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{18 keys}

{ "status": 200, "message": "OK", "data": { "id": "IM2605288471293048", "status": "in_transit", "service_tier": "HKASTDGGSTCM", "declared_currency": "USD", "declared_fx": { "rate": 7.8454, "rate_type": "daily", "fetched_at": "2026-05-28T07:44:23.908Z", "stale": false }, "destination": { "country": "US", "district": "CA" }, "carrier_code": "yunexpress", "dispatch_status": "dispatched", "label_pdf_url": "https://example.com/labels/YT2614891234567890.pdf", "label_available": true, "waybill_number": "YT2614891234567890", "last_mile_tracking_number": "9214490312345678901234", "billing": { "currency": "HKD", "status": "settled", "pre_charge_hkd": 68.5, "charged_hkd": 57.2, "chargeable_weight_kg": 0.42, "declared_weight_kg": 0.5, "settled_at": "2026-05-30T03:12:45.000Z", "adjustments_hkd": 0 }, "livemode": true, "created_at": "2026-05-28T07:44:23.908Z", "delivered_at": null, "reference_no": "PO-2026-0528-0017", "events": [ { "event_at": "2026-06-02T15:20:00.000Z", "location": "US", "description": "In Transit to Next Facility", "status_label": "第三方運送中", "carrier_code": "yunexpress", "carrier_name": "Yun Express (云途物流)" }, { "event_at": "2026-06-01T09:10:00.000Z", "location": "CHICAGO, ILLINOIS, US", "description": "Clearance processing completed - Import", "status_label": "目的地清關", "carrier_code": "yunexpress", "carrier_name": "Yun Express (云途物流)" }, { "event_at": "2026-05-29T13:05:00.000Z", "location": "HONG KONG, HK", "description": "Departed from sort facility", "status_label": "中轉發出", "carrier_code": "yunexpress", "carrier_name": "Yun Express (云途物流)" }, { "event_at": "2026-05-29T02:30:00.000Z", "location": "HONG KONG, HK", "description": "Arrived at origin facility", "status_label": "中轉收貨", "carrier_code": "yunexpress", "carrier_name": "Yun Express (云途物流)" }, { "event_at": "2026-05-28T07:45:10.000Z", "location": null, "description": "Shipment information received", "status_label": "已建單", "carrier_code": "yunexpress", "carrier_name": "Yun Express (云途物流)" } ] } }