# 运力下单

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

事件英文名:add_single_waybill

当用户下单时,会发送此事件。

# 1. 消息参数

# 请求体 Request Payload

参数名类型说明枚举
ToUserNamestring快递公司小程序UserName-
FromUserNamestring微信团队的OpenID(固定值)-
CreateTimenumber事件时间,Unix时间戳-
MsgTypestring消息类型,固定为event-
Eventstring事件类型,固定为add_single_waybill,不区分大小写-
Tokenstring订单Token。请保存该Token,更新运单轨迹时需要传入,长度需预留256个字符-
WXAppIdstring商户微信小程序的appid-
OrderIDstring商户订单ID,可以使用token而不用这个字段-
Senderobject发件人信息-
Receiverobject收件人信息-
GoodDetailobject物品详情-
Insuredobject保价信息-
ExpectStartTimenumber期望上门取件起始时间-
ExpectEndTimenumber期望上门取件结束时间-
Settingmentnumber结算方式默认0现结,1到付,2月结,3支付分-
CompanyIDstring中通大客户CompanyID,结算方式为2,且选中通时需填-
Accountstring月结账号,结算方式为2时需填-
AccountPwdstring月结账号密码结算方式为2时需填-
Remarkstring备注信息-
PickUpStartTimenumber上门时间段(开始时间)-
PickUpEndTimenumber上门时间段(结束时间)-
Scenenumber场景值枚举值

# Body.Sender Object Payload

发件人信息

参数名类型说明
Namestring收件人姓名
Telstring收件人座机号码
Mobilestring收件人手机号码
Provincestring省份,比如"广东省"
Citystring地区/市,比如"广州市"
Areastring区/县,比如"海珠区"
Streetstring街道,比如新港中路
Addressstring详细地址,比如"XX路XX号XX大厦XX"
Idstring地址id

# Body.Receiver Object Payload

收件人信息

参数名类型说明
Namestring收件人姓名
Telstring收件人座机号码
Mobilestring收件人手机号码
Provincestring省份,比如"广东省"
Citystring地区/市,比如"广州市"
Areastring区/县,比如"海珠区"
Streetstring街道,比如新港中路
Addressstring详细地址,比如"XX路XX号XX大厦XX"
Idstring地址id

# Body.GoodDetail Object Payload

物品详情

参数名类型示例说明枚举
Weightnumber1货物总重量,比如1.2,单位是千克(kg)-
Specialnumber0物品类型,见物品类型说明枚举值

# Body.Insured Object Payload

保价信息

参数名类型说明
UseInsurednumber是否保价,0表示不保价,1表示保价
InsuredValuenumber保价金额,单位是分,比如:10000表示100元

# 2. 消息返回

# 返回体 Response Payload

参数名类型必填说明
ToUserNamestring原样返回请求中的FromUserName
FromUserNamestring快递公司小程序UserName
CreateTimenumber事件时间,Unix时间戳
MsgTypestring消息类型,固定为event
Eventstring事件类型,固定为add_single_waybill,不区分大小写
ResultCodenumber处理结果错误码
ResultMsgstring处理结果的详细信息
WayBillIDstring运单ID,如果不能立即返回,可以在打印面单时候回调通知微信端
EstimatedDeliveryTimestring预计送达时间,格式:yyyy-mm-dd
JumpPathstring下单成功后跳转的地址(appid需要联系微信进行登记配置)
PickCodestring取件码

# 3. 枚举信息

# Body.Scene Enum

场景值

枚举值描述
1C端散单
2B端退货
3B端发货

# Body.GoodDetail.Special Enum

物品类型,见物品类型说明

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

# 4. 注意事项

本事件无特殊注意事项

# 5. 代码示例

本事件无代码示例