# 传运单

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:follow_waybill

商户使用此接口向微信提供某交易单号对应的运单号。微信后台会跟踪运单的状态变化,在关键物流节点给下单用户推送消息通知。

如有开发问题或建议,可前往微信开放社区-微信物流服务 发帖提问讨论,官方工作人员会及时回复。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:45

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
openidstring用户openid
sender_phonestring寄件人手机号
receiver_phonestring收件人手机号,部分运力需要用户手机号作为查单依据
waybill_idstring运单号
goods_infoobject商品信息
trans_idstring交易单号(微信支付生成的交易单号,一般以420开头)
order_detail_pathstring点击落地页商品卡片跳转路径(建议为订单详情页path),不传默认跳转小程序首页。
delivery_idstring运力id(运单号所属运力公司id),该字段从 get_delivery_list 获取。 该参数用于提高运单号识别的准确度;特别是对非主流快递公司,建议传入该参数,确保查询正确率。

# Body.goods_info Object Payload

商品信息

参数名类型必填说明
detail_listobjarray商品信息

# Body.goods_info.detail_list(Array) Object Payload

商品信息

参数名类型必填说明
goods_namestring商品名称
goods_img_urlstring商品图片url
goods_descstring商品详情描述,不传默认取“商品名称”值,最多40汉字

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
waybill_tokenstring查询id

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "openid":"ovtZW4yB7DIj3CxOb6ii-nk4HhFo",
  "waybill_id":"WXTESTEXPRESS0000014",
  "sender_phone":"12345678901" ,
  "receiver_phone":"123456566" ,
  "goods_info":{
  	"detail_list":[
     {
       "goods_name":"测试名字",
       "goods_img_url":"www.qq.com"
     },
     {
       "goods_name":"测试名字2",
       "goods_img_url":"www.qq.com"
     }
    ]
  }
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "waybill_token": "o_ARWHaxIxzWHmdui-AIw9KBr8qNnbmc08V0KhDyXE-IMLo6AcOqJkPsNLcLzfTb"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
40003invalid openid不合法的 OpenID ,请开发者确认 OpenID (该用户)是否已关注公众号,或是否是其他公众号的 OpenID
9300507invalid token  can't decryption ordecryption result is different from the plaintextwaybill_token参数错误
9300513out of quota调用次数达到上限
9300534invalid shop argsaccess_token与openid参数不匹配
9300559waybill not exist运单不存在
9300560达到修改次数上限

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。