微信小程序开发文档 微信小程序 运力方使用·updatePath

2024-02-25 开发教程 微信小程序开发文档 匿名 4

logistics.updatePath

本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载
wx-server-sdk >= 0.4.0

更新运单轨迹

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/cgi-bin/express/delivery/path/update?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
tokenstring商户侧下单事件中推送的 Token 字段
waybill_idstring运单 ID
action_timenumber轨迹变化 Unix 时间戳
action_typenumber轨迹变化类型
action_msgstring轨迹变化具体信息说明,展示在快递轨迹详情页中。若有手机号码,则直接写11位手机号码。使用UTF-8编码。

action_type 的合法值

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

返回值

Object

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

说明最低版本
0成功
-1系统失败
40199运单 ID 错误,未查到运单
9300507Token 不正确

请求数据示例

{
"token": "TOKEN",
"waybill_id": "12345678901234567890",
"action_time": 1533052800,
"action_type": 300002,
"action_msg": "丽影邓丽君【18666666666】正在派件"
}

返回数据示例

{
"errcode": 0,
"errmsg": "ok"
}

云调用

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

接口方法

openapi.logistics.updatePath

需在 config.json 中配置 logistics.updatePath API 的权限,详情

请求参数

属性类型默认值必填说明
tokenstring商户侧下单事件中推送的 Token 字段
waybillIdstring运单 ID
actionTimenumber轨迹变化 Unix 时间戳
actionTypenumber轨迹变化类型
actionMsgstring轨迹变化具体信息说明,展示在快递轨迹详情页中。若有手机号码,则直接写11位手机号码。使用UTF-8编码。

actionType 的合法值

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

返回值

Object

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
0成功

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
-1系统失败
40199运单 ID 错误,未查到运单
9300507Token 不正确

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.logistics.updatePath({
token: 'TOKEN',
waybillId: '12345678901234567890',
actionTime: 1533052800,
actionType: 300002,
actionMsg: '丽影邓丽君【18666666666】正在派件'
})
return result
} catch (err) {
return err
}
}

返回数据示例

{
"errCode": 0,
"errMsg": "openapi.logistics.updatePath:ok"
}