1. 接口
Help for ShipSage
  • 中文版 V2.0
    • 接口集成
      • OMS API
        • 入门指南
        • 接口
          • 店铺
          • 仓库
          • 产品
          • 库存
          • 订单
          • 包裹
          • 物流跟踪
          • 发货计划
          • 转运
          • 增值服务
          • 退货
          • 文件上传
  • English V2.0
    • API Integration
      • OMS API
        • Getting Started
        • APIs
          • Account
          • Warehouse
          • Product
          • Inventory
          • Order
          • Shipping
          • Tracking
          • ASN
          • Transfer
          • VAS
          • Return
          • File Upload
  1. 接口

物流跟踪

端点#

方法端点描述
GET/api/v202206/trackingsRetrieves a list of trackings

头部#

键值
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/Trackings#

请求#

参数#
类型名称描述必填/选填数据结构
queryapiAPI 类型

可用值:
index.by-default
必填enum
querynext_token下一页数据的秘钥选填string
bodytracking_numbers追踪号列表必填array
Body 示例#
{    
    "tracking_numbers": [ "UUXXXXXXXX1","UUXXXXXXXX2"]
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
名称描述数据结构
tracking_number跟踪号string
platform_order_id平台订单号string
customer_order_id客户订单号string
trx_idShipSage 系统内部订单编号string
carrier发货渠道;
例如: UPS, USPS, DHL, FedEx...
string
service_type_name物流承运商
例如: UPS Ground, UPS Sure Post, Fedex Ground Home Delivery, Fedex Ground...
string
latest_status最新状态string
latest_event_time最新轨迹发生时间 时区:太平洋标准时间datetime
latest_event_time_iso最新轨迹发生当地时间datetime
latest_event_time_utc最新轨迹发生时间 时区:国际标准时间datetime
latest_event_描述最新轨迹描述string
final_scan_time仓库最终扫描时间 太平洋标准时间datetime
origin_scan_time物流商揽收时间 太平洋标准时间datetime
delivered_time妥投时间 太平洋标准时间datetime
ship_to_name收件人姓名string
ship_to_address1收件人街道地址1string
ship_to_address2收件人街道地址2string
ship_to_phone收件人电话string
ship_to_city收件人城市string
ship_to_state收件人州/省string
ship_to_country收件人国家string
ship_to_postal_code收件人邮编string
milestone轨迹里程碑节点array
milestone.*.event_time轨迹发生时间 时区:太平洋标准时间datetime
milestone.*.event_time_iso轨迹发生当地时间datetime
milestone.*.event_time_utc轨迹发生时间 时区:国际标准时间datetime
milestone.*.描述轨迹描述string
milestone.*.location轨迹发生位置string
milestone.*.stage轨迹发生主节点string
milestone.*.sub_status轨迹发生子节点string
milestone.*.country轨迹发生国家string
milestone.*.state轨迹发生州/省string
milestone.*.city轨迹发生城市string
milestone.*.street轨迹发生街道string
postal_code轨迹发生邮编integer
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": [
        {
            "tracking_number": "UUXXXXXXXX1",
            "platform_order_id": "XXXXXXX",
            "customer_order_id": "XXXXXXX",
            "trx_id": "e28de150-bbde-480d-b1e5-67070907b50d1729568339403",
            "carrier": "FedEx",
            "service_type_name": "GROUND_HOME_DELIVERY",
            "latest_status": "Delivered",
            "latest_event_time": "2024-06-17 10:36:04",
            "latest_event_time_iso": "2024-06-17 13:36:04",
            "latest_event_time_utc": "2024-06-17 17:36:04",
            "latest_event_描述": "Delivered, Left at front door. Signature Service not 请求ed.",
            "final_scan_time": "2024-06-16 04:25:02",
            "origin_scan_time": "2024-06-16 00:00:00",
            "delivered_time": "2024-06-17 13:36:04",
            "ship_to_name": "XXX",
            "ship_to_address1": "XXX",
            "ship_to_address2": null,
            "ship_to_phone": "16026716610",
            "ship_to_city": "BAKERSFIELD",
            "ship_to_state": "CA",
            "ship_to_country": "US",
            "ship_to_postal_code": "10000",
            "milestone": [
            	{
                "event_time": "2024-06-15 21:00:00",
                "event_time_iso": "2024-06-16 00:00:00",
                "event_time_utc": "2024-06-16 04:00:00",
                "描述": "Picked up",
                "location": "US, PA, NORTHAMPTON",
                "stage": "PickedUp",
                "sub_status": "InTransit_PickedUp",
                "country": "US",
                "state": "PA",
                "city": "NORTHAMPTON",
                "street": "",
                "postal_code": 1000
            	},
                {
                "event_time": "2024-06-15 21:10:00",
                "event_time_iso": "2024-06-16 00:10:00",
                "event_time_utc": "2024-06-16 04:10:00",
                "描述": "Shipment information sent to FedEx",
                "location": "US, PA, NORTHAMPTON",
                "stage": "InfoReceived",
                "sub_status": "InfoReceived",
                "country": "US",
                "state": "PA",
                "city": "NORTHAMPTON",
                "street": "",
                "postal_code": 1000
            	},
                {
                "event_time": "2024-06-16 14:53:00",
                "event_time_iso": "2024-06-16 17:53:00",
                "event_time_utc": "2024-06-16 21:53:00",
                "描述": "Arrived at FedEx location",
                "location": "US, PA, NORTHAMPTON",
                "stage": "",
                "sub_status": "InTransit_Other",
                "country": "US",
                "state": "PA",
                "city": "NORTHAMPTON",
                "street": "",
                "postal_code": 1000
            	},
                {
                "event_time": "2024-06-16 22:57:52",
                "event_time_iso": "2024-06-17 01:57:52",
                "event_time_utc": "2024-06-17 05:57:52",
                "描述": "Left FedEx origin facility",
                "location": "US, PA, NORTHAMPTON",
                "stage": "",
                "sub_status": "InTransit_Other",
                "country": "US",
                "state": "PA",
                "city": "NORTHAMPTON",
                "street": "",
                "postal_code": 1000
            	},
                {
                "event_time": "2024-06-17 01:35:00",
                "event_time_iso": "2024-06-17 04:35:00",
                "event_time_utc": "2024-06-17 08:35:00",
                "描述": "At local FedEx facility",
                "location": "US, PA, READING",
                "stage": "",
                "sub_status": "InTransit_Other",
                "country": "US",
                "state": "PA",
                "city": "READING",
                "street": "",
                "postal_code": 1001
            	},
                {
                "event_time": "2024-06-17 01:48:00",
                "event_time_iso": "2024-06-17 04:48:00",
                "event_time_utc": "2024-06-17 08:48:00",
                "描述": "On FedEx vehicle for delivery",
                "location": "US, PA, READING",
                "stage": "OutForDelivery",
                "sub_status": "OutForDelivery_Other",
                "country": "US",
                "state": "PA",
                "city": "READING",
                "street": "",
                "postal_code": 1001
            	},
                {
                "event_time": "2024-06-17 10:36:04",
                "event_time_iso": "2024-06-17 13:36:04",
                "event_time_utc": "2024-06-17 17:36:04",
                "描述": "Delivered, Left at front door. Signature Service not 请求ed.",
                "location": "US, PA, Elverson",
                "stage": "Delivered",
                "sub_status": "Delivered_Other",
                "country": "US",
                "state": "PA",
                "city": "Elverson",
                "street": "",
                "postal_code": 1001
            	}
       		 ]
    
            }
        ]
}
Modified at 2026-08-13 00:43:51
Previous
包裹
Next
发货计划
Built with