# 推送已绑定物流轨迹信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:deliveryPathNotify
运力方可以调用此接口来推送物流轨迹消息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/delivery/pathnotify?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sender | object | 是 | 寄件人 |
| receiver | object | 是 | 收件人 |
| waybill_id | string | 是 | 运单号 |
| path | object | 是 | 当前需要推送消息的轨迹 |
| create_time | number | 是 | 运单创建时间,unix时间戳(秒) |
# Body.sender Object Payload
寄件人
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 姓名(收件人必传,寄件人非必传) |
| phone | string | 否 | 电话(收件人必传,寄件人非必传) |
| province | string | 是 | 省 |
| city | string | 是 | 市 |
| area | string | 是 | 区/县 |
| street | string | 否 | 街道 |
| address | string | 否 | 地址 |
| id | string | 否 | 地址id |
# Body.receiver Object Payload
收件人
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 姓名(收件人必传,寄件人非必传) |
| phone | string | 否 | 电话(收件人必传,寄件人非必传) |
| province | string | 是 | 省 |
| city | string | 是 | 市 |
| area | string | 是 | 区/县 |
| street | string | 否 | 街道 |
| address | string | 否 | 地址 |
| id | string | 否 | 地址id |
# Body.path Object Payload
当前需要推送消息的轨迹
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| action_time | number | 是 | 轨迹变化Unix时间戳 | - |
| action_type | number | 是 | 轨迹变化类型,与普通单保持一致,参见下方其他说明action_type定义 | 枚举值 |
| action_msg | string | 是 | 轨迹变化具体信息说明,展示在快递轨迹详情页中 | - |
| pickup_courier_name | string | 否 | 取件员姓名,当分配取件员成功时返回 | - |
| pickup_courier_phone | string | 否 | 取件员电话,当分配取件员成功时返回 | - |
| delivery_courier_name | string | 否 | 派件员姓名,当分配派件员成功时返回 | - |
| delivery_courier_phone | string | 否 | 派件员电话,当分配派件员成功时返回 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| exist | number | 用户是否绑定 0-未绑定 1-已绑定 |
# 4. 枚举信息
# Body.path.action_type Enum
轨迹变化类型,与普通单保持一致,参见下方其他说明action_type定义
| 枚举值 | 描述 |
|---|---|
| 90001 | 揽件前阶段-网点接单 |
| 90002 | 揽件前阶段-分配业务员 |
| 90003 | 揽件前阶段-重新分配业务员 |
| 90010 | 揽件前阶段-待支付 |
| 90011 | 揽件前阶段-已支付 |
| 100001 | 揽件阶段-揽件成功 |
| 100002 | 揽件阶段-揽件失败 |
| 200001 | 运输阶段-更新运输轨迹 |
| 300002 | 派送阶段-派送中 |
| 300003 | 派送阶段-签收成功 |
| 300004 | 派送阶段-签收失败 |
| 300005 | 派送阶段-第三方代收入库 |
| 300006 | 派送阶段-第三方代收快递员取出 |
| 300007 | 派送阶段-代签收 |
| 400001 | 异常阶段-订单取消 |
| 400002 | 异常阶段-订单滞留 |
| 400003 | 异常阶段-订单退回 |
| 400004 | 异常阶段-订单拒收 |
| 400005 | 异常阶段-问题件 |
| 500001 | 兜底状态-其他未分类状态纳入本action_type |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"path": {
"action_time": 1597396101,
"action_type": 200001,
"action_msg": "快件到达 【泉州磁灶集散中心】",
"pickup_courier_name":"",
"pickup_courier_phone":"",
"delivery_courier_name":"",
"delivery_courier_phone":""
},
"receiver": {
"area": "晋江市",
"address": "庄宅北区158-6",
"province": "福建省",
"city": "泉州市",
"phone": "13800138000",
"name": "李四"
},
"sender": {
"area": "柯桥区",
"address": "纺都路137号",
"province": "浙江省",
"city": "绍兴市",
"phone": "13800138001",
"name": "张三"
},
"waybill_id": "1234567890"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"exist": 0
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 40014/40001 | 无效accesstoken |
| 40097 | 参数错误 |
| 41001 | accesstoken不存在 |
| 42001 | accesstoken过期 |
| 150004 | 运力配置不存在 |
| 932001 | 反查运单系统错误 |
| 932002 | 反查运单逻辑错误 |
| 932003 | 反查运单获取到的运单数据异常 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。