# 查询运单

本文档描述服务器端接收的消息或事件，详细说明参见消息推送。

事件英文名：query_single_waybill

用户查询运单时，会发送此请求，开发者需要返回相应运单信息。

# 1. 消息参数

# 请求体 `Request Payload`

参数名	类型	说明
ToUserName	string	快递公司小程序UserName
FromUserName	string	微信团队的OpenID（固定值）
CreateTime	number	事件时间，Unix时间戳
MsgType	string	消息类型，固定为event
Event	string	事件类型，固定为query_single_waybill，不区分大小写
Token	string	订单Token，下单时传入的值
WXAppId	string	下单的小程序的appid
WaybillId	string	运单号，运力方如有更新会同步带上
OrderID	string	订单ID，可以使用token而不用这个字段

# 2. 消息返回

# 返回体 `Response Payload`

参数名	类型	必填	说明
ToUserName	string	是	原样返回请求中的FromUserName
FromUserName	string	是	快递公司小程序UserName
CreateTime	number	是	事件时间，Unix时间戳
MsgType	string	是	消息类型，固定为event
Event	string	是	事件类型，固定为query_single_waybill，不区分大小写
ResultCode	number	是	处理结果错误码
ResultMsg	string	否	处理结果的详细信息
WayBillID	string	否	运单ID，已生成时必填
Sender	object	否	发件人信息
Receiver	object	否	收件人信息
GoodDetail	object	否	物品详情
Insured	object	否	保价信息
PathInfo	object	否	轨迹信息
Fee	number	否	运单所需要支付的费用，单位分，费用确定时必填
OriginalFee	number	否	原价，单位分
OnlinePay	number	是	是否支持在线支付，0-不支持，1-支持在线支付
PayResult	number	是	支付结果 0-未支付 1-线上支付完成 2-线下支付完成

# Res.Sender `Object Payload`

发件人信息

参数名	类型	必填	说明
Name	string	是	收件人姓名
Tel	string	是	收件人座机号码
Mobile	string	是	收件人手机号码
Province	string	是	省份，比如"广东省"
City	string	是	地区/市，比如"广州市"
Area	string	是	区/县，比如"海珠区"
Street	string	否	街道，比如新港中路
Address	string	是	详细地址，比如"XX路XX号XX大厦XX"

# Res.Receiver `Object Payload`

收件人信息

参数名	类型	必填	说明
Name	string	是	收件人姓名
Tel	string	是	收件人座机号码
Mobile	string	是	收件人手机号码
Province	string	是	省份，比如"广东省"
City	string	是	地区/市，比如"广州市"
Area	string	是	区/县，比如"海珠区"
Street	string	否	街道，比如新港中路
Address	string	是	详细地址，比如"XX路XX号XX大厦XX"

# Res.GoodDetail `Object Payload`

物品详情

参数名	类型	必填	说明	枚举
Weight	number	是	货物总重量，比如1.2，单位是千克(kg)	-
Special	number	是	物品类型，见物品类型说明	枚举值

# Res.Insured `Object Payload`

保价信息

参数名	类型	必填	说明
UseInsured	number	否	是否保价，0表示不保价，1表示保价，默认0
InsuredValue	number	否	保价金额，单位是分，比如:10000表示100元

# Res.PathInfo `Object Payload`

轨迹信息

参数名	类型	必填	说明
path_info	objarray	是	轨迹内容

# Res.PathInfo.path_info(Array) `Object Payload`

轨迹内容

参数名	类型	必填	说明	枚举
action_time	number	是	轨迹变化Unix时间戳	-
action_type	number	是	轨迹变化类型，与普通单保持一致，参见附录action_type定义	枚举值
action_msg	string	是	轨迹变化具体信息说明，展示在快递轨迹详情页中。若有手机号码，则直接写11位手机号码。使用UTF-8编码。	-
pickup_courier_name	string	否	取件员姓名,当分配取件员成功时返回	-
pickup_courier_phone	string	否	取件员电话,当分配取件员成功时返回	-
delivery_courier_name	string	否	派件员姓名,当分配派件员成功时返回	-
delivery_courier_phone	string	否	派件员电话,当分配派件员成功时返回	-

# 3. 枚举信息

# Res.GoodDetail.Special `Enum`

物品类型，见物品类型说明

枚举值	描述
0	文件类
1	电子产品类(包括家用电器)
2	办公用品类,服装鞋帽，箱包类
3	化妆品，美容产品类
4	珠宝，手表，眼镜，贵重饰品类
5	食品，保健药品类
6	工艺品类(包括瓷器，茶具，烹饪用品)
7	玩具乐器类
8	其他类

# Res.PathInfo.path_info(Array).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

# 4. 注意事项

本事件无特殊注意事项

# 5. 代码示例

本事件无代码示例

# 查询运单

# 1. 消息参数

# 请求体 Request Payload

# 2. 消息返回

# 返回体 Response Payload

# Res.Sender Object Payload

# Res.Receiver Object Payload

# Res.GoodDetail Object Payload

# Res.Insured Object Payload

# Res.PathInfo Object Payload

# Res.PathInfo.path_info(Array) Object Payload

# 3. 枚举信息

# Res.GoodDetail.Special Enum

# Res.PathInfo.path_info(Array).action_type Enum

# 4. 注意事项

# 5. 代码示例

# 请求体 `Request Payload`

# 返回体 `Response Payload`

# Res.Sender `Object Payload`

# Res.Receiver `Object Payload`

# Res.GoodDetail `Object Payload`

# Res.Insured `Object Payload`

# Res.PathInfo `Object Payload`

# Res.PathInfo.path_info(Array) `Object Payload`

# Res.GoodDetail.Special `Enum`

# Res.PathInfo.path_info(Array).action_type `Enum`