logistics.getPath

本接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

查询运单轨迹

调用方式：

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/cgi-bin/express/business/path/get?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
order_idstring是订单 ID，需保证全局唯一
openidstring否用户openid，当add_source=2时无需填写（不发送物流服务通知）
delivery_idstring是快递公司ID，参见getAllDelivery
waybill_idstring是运单ID

返回值

Object

属性类型说明
openidstring用户openid
delivery_idstring快递公司 ID
waybill_idstring运单 ID
path_item_numnumber轨迹节点数量
path_item_listArray.<Object>轨迹节点列表

path_item_list 的结构

属性类型说明
action_timenumber轨迹节点 Unix 时间戳
action_typenumber轨迹节点类型
action_msgstring轨迹节点详情

action_type 的合法值

值说明最低版本
100001揽件阶段-揽件成功
100002揽件阶段-揽件失败
100003揽件阶段-分配业务员
200001运输阶段-更新运输轨迹
300002派送阶段-开始派送
300003派送阶段-签收成功
300004派送阶段-签收失败
400001异常阶段-订单取消
400002异常阶段-订单滞留

请求数据示例

  1. {
  2.   "order_id": "01234567890123456789",
  3.   "openid": "oABC123456",
  4.   "delivery_id": "SF",
  5.   "waybill_id": "123456789"
  6. }

返回数据示例

  1. {
  2.   "openid": "OPENID",
  3.   "delivery_id": "SF",
  4.   "waybill_id": "12345678901234567890",
  5.   "path_item_num": 3,
  6.   "path_item_list": [
  7.     {
  8.       "action_time": 1533052800,
  9.       "action_type": 100001,
  10.       "action_msg": "快递员已成功取件"
  11.     },
  12.     {
  13.       "action_time": 1533062800,
  14.       "action_type": 200001,
  15.       "action_msg": "快件已到达xxx集散中心，准备发往xxx"
  16.     },
  17.     {
  18.       "action_time": 1533072800,
  19.       "action_type": 300001,
  20.       "action_msg": "快递员已出发，联系电话xxxxxx"
  21.     }
  22.   ]
  23. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.logistics.getPath

需在 config.json 中配置 logistics.getPath API 的权限，详情

请求参数

属性类型默认值必填说明
orderIdstring是订单 ID，需保证全局唯一
openidstring否用户openid，当add_source=2时无需填写（不发送物流服务通知）
deliveryIdstring是快递公司ID，参见getAllDelivery
waybillIdstring是运单ID

返回值

Object

属性类型说明
openidstring用户openid
deliveryIdstring快递公司 ID
waybillIdstring运单 ID
pathItemNumnumber轨迹节点数量
pathItemListArray.<Object>轨迹节点列表

pathItemList 的结构

属性类型说明
actionTimenumber轨迹节点 Unix 时间戳
actionTypenumber轨迹节点类型
actionMsgstring轨迹节点详情

actionType 的合法值

值说明最低版本
100001揽件阶段-揽件成功
100002揽件阶段-揽件失败
100003揽件阶段-分配业务员
200001运输阶段-更新运输轨迹
300002派送阶段-开始派送
300003派送阶段-签收成功
300004派送阶段-签收失败
400001异常阶段-订单取消
400002异常阶段-订单滞留

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4.   try {
  5.     const result = await cloud.openapi.logistics.getPath({
  6.         openid: 'oABC123456',
  7.         orderId: '01234567890123456789',
  8.         deliveryId: 'SF',
  9.         waybillId: '123456789'
  10.       })
  11.     console.log(result)
  12.     return result
  13.   } catch (err) {
  14.     console.log(err)
  15.     return err
  16.   }
  17. }

返回数据示例

  1. {
  2.   "openid": "OPENID",
  3.   "deliveryId": "SF",
  4.   "waybillId": "12345678901234567890",
  5.   "pathItemNum": 3,
  6.   "pathItemList": [
  7.     {
  8.       "actionTime": 1533052800,
  9.       "actionType": 100001,
  10.       "actionMsg": "快递员已成功取件"
  11.     },
  12.     {
  13.       "actionTime": 1533062800,
  14.       "actionType": 200001,
  15.       "actionMsg": "快件已到达xxx集散中心，准备发往xxx"
  16.     },
  17.     {
  18.       "actionTime": 1533072800,
  19.       "actionType": 300001,
  20.       "actionMsg": "快递员已出发，联系电话xxxxxx"
  21.     }
  22.   ],
  23.   "errMsg": "openapi.logistics.getPath:ok"
  24. }