# 运力下单
本文档描述服务器端接收的消息或事件,详细说明参见消息推送。
事件英文名:add_single_waybill
当用户下单时,会发送此事件。
# 1. 消息参数
# 请求体 Request Payload
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| ToUserName | string | 快递公司小程序UserName | - |
| FromUserName | string | 微信团队的OpenID(固定值) | - |
| CreateTime | number | 事件时间,Unix时间戳 | - |
| MsgType | string | 消息类型,固定为event | - |
| Event | string | 事件类型,固定为add_single_waybill,不区分大小写 | - |
| Token | string | 订单Token。请保存该Token,更新运单轨迹时需要传入,长度需预留256个字符 | - |
| WXAppId | string | 商户微信小程序的appid | - |
| OrderID | string | 商户订单ID,可以使用token而不用这个字段 | - |
| Sender | object | 发件人信息 | - |
| Receiver | object | 收件人信息 | - |
| GoodDetail | object | 物品详情 | - |
| Insured | object | 保价信息 | - |
| ExpectStartTime | number | 期望上门取件起始时间 | - |
| ExpectEndTime | number | 期望上门取件结束时间 | - |
| Settingment | number | 结算方式默认0现结,1到付,2月结,3支付分 | - |
| CompanyID | string | 中通大客户CompanyID,结算方式为2,且选中通时需填 | - |
| Account | string | 月结账号,结算方式为2时需填 | - |
| AccountPwd | string | 月结账号密码结算方式为2时需填 | - |
| Remark | string | 备注信息 | - |
| PickUpStartTime | number | 上门时间段(开始时间) | - |
| PickUpEndTime | number | 上门时间段(结束时间) | - |
| Scene | number | 场景值 | 枚举值 |
# Body.Sender Object Payload
发件人信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| Name | string | 收件人姓名 |
| Tel | string | 收件人座机号码 |
| Mobile | string | 收件人手机号码 |
| Province | string | 省份,比如"广东省" |
| City | string | 地区/市,比如"广州市" |
| Area | string | 区/县,比如"海珠区" |
| Street | string | 街道,比如新港中路 |
| Address | string | 详细地址,比如"XX路XX号XX大厦XX" |
| Id | string | 地址id |
# Body.Receiver Object Payload
收件人信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| Name | string | 收件人姓名 |
| Tel | string | 收件人座机号码 |
| Mobile | string | 收件人手机号码 |
| Province | string | 省份,比如"广东省" |
| City | string | 地区/市,比如"广州市" |
| Area | string | 区/县,比如"海珠区" |
| Street | string | 街道,比如新港中路 |
| Address | string | 详细地址,比如"XX路XX号XX大厦XX" |
| Id | string | 地址id |
# Body.GoodDetail Object Payload
物品详情
| 参数名 | 类型 | 示例 | 说明 | 枚举 |
|---|---|---|---|---|
| Weight | number | 1 | 货物总重量,比如1.2,单位是千克(kg) | - |
| Special | number | 0 | 物品类型,见物品类型说明 | 枚举值 |
# Body.Insured Object Payload
保价信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| UseInsured | number | 是否保价,0表示不保价,1表示保价 |
| InsuredValue | number | 保价金额,单位是分,比如:10000表示100元 |
# 2. 消息返回
# 返回体 Response Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ToUserName | string | 是 | 原样返回请求中的FromUserName |
| FromUserName | string | 是 | 快递公司小程序UserName |
| CreateTime | number | 是 | 事件时间,Unix时间戳 |
| MsgType | string | 是 | 消息类型,固定为event |
| Event | string | 是 | 事件类型,固定为add_single_waybill,不区分大小写 |
| ResultCode | number | 是 | 处理结果错误码 |
| ResultMsg | string | 否 | 处理结果的详细信息 |
| WayBillID | string | 否 | 运单ID,如果不能立即返回,可以在打印面单时候回调通知微信端 |
| EstimatedDeliveryTime | string | 否 | 预计送达时间,格式:yyyy-mm-dd |
| JumpPath | string | 否 | 下单成功后跳转的地址(appid需要联系微信进行登记配置) |
| PickCode | string | 否 | 取件码 |
# 3. 枚举信息
# Body.Scene Enum
场景值
| 枚举值 | 描述 |
|---|---|
| 1 | C端散单 |
| 2 | B端退货 |
| 3 | B端发货 |
# Body.GoodDetail.Special Enum
物品类型,见物品类型说明
| 枚举值 | 描述 |
|---|---|
| 0 | 文件类 |
| 1 | 电子产品类(包括家用电器) |
| 2 | 办公用品类,服装鞋帽,箱包类 |
| 3 | 化妆品,美容产品类 |
| 4 | 珠宝,手表,眼镜,贵重饰品类 |
| 5 | 食品,保健药品类 |
| 6 | 工艺品类(包括瓷器,茶具,烹饪用品) |
| 7 | 玩具乐器类 |
| 8 | 其他类 |
# 4. 注意事项
本事件无特殊注意事项
# 5. 代码示例
本事件无代码示例