1.2 - 物流轨迹 for shop.com

简要描述：

  • 查询订单的物流轨迹

接口版本：

版本号 制定人 制定日期 修订日期
1.0.0 Damson Li 2024-07-03 xxxx-xx-xx

请求URL:

请求方式：

  • POST

请求头：

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型： application/json

请求参数:

参数名 是否必须 类型 说明
orderno 是 string(50） 订单号，或物流运单号
langid 是 int 语音号码（0:英文，1:简体中文，2:繁体中文）

请求示例:

正确时返回:

http://api-test.damsonware.com:12016/api-wtms/tracking?orderno=SF987654321&langid=1

返回参数:

参数名 是否必须 类型 说明
code 是 string(50) A001表示调用成功，其它值表示调用失败
message 是 string(200) 调用成功时返回空串，调用失败返回错误信息
freight_no 否 string(50) 调用成功：物流运单号
order_no 否 string(50) 调用成功：订单号
lines 否 object[] 物流轨迹数组

lines 物流轨迹:

参数名 是否必须 类型 说明
mil_name 是 string(200) 轨迹描述
mil_actual 是 string(20) 日期时间，格式：yyyy-mm-ddThh:mm:ss
site_name 是 string(50) 站点名称

返回示例:

正确时返回:

{
    "code": "A001",
    "message": "",
    "freight_no": "SF987654321",
    "order_no": "1709121357",
    "lines": [
        {
            "mil_name": "AFL物流已收取快件PU_PICKUP_SUCCESS",
            "mil_actual": "2024-02-27T10:48:25",
            "site_name": "香港紅磡倉"
        },
        {
            "mil_name": "派送领件DELIVERY_HANDOVER_IN",
            "mil_actual": "2024-02-29T13:30:17",
            "site_name": "香港紅磡倉"
        },
        {
            "mil_name": "包裹已拒收GTMS_SIGN_FAILURE_5530",
            "mil_actual": "2024-02-29T14:46:45",
            "site_name": "香港紅磡倉"
        }
    ]
}

错误时返回:

{
    "code": "API-NO-RECORD-FOUND",
    "message": "找不到物流轨迹，订单或运单号不存在，或者收件人电话后面后4位错误。"
}

下一版本改进:

  • 在请求的header加入JWT
  • 把langid从QueryString转移到header
  • 对公网的访问加入白名单管理

作者：Damson Li  创建时间：2024-07-03 10:59
最后编辑：Damson Li  更新时间：2024-07-03 11:22