微信小程序开发文档 第63页
immediateDelivery.onCancelAuth 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 取消授权帐号 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 cancel_auth_account,不区分大小写 shopid string 商家id, 配送公司唯一标识 wx_appid string 发起授权的商户小程序appid 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为 event Event string 是 事件类型,固定为 cancel_auth_account,不区分大小写 resultcode number 是 错误码 resultmsg string 是 错误描述
immediateDelivery.onAuthInfoGet 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 使用授权码拉取授权信息 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 get_auth_info,不区分大小写 wx_appid string 发起授权的商户小程序appid code string 授权码 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为 event Event string 是 事件类型,固定为 get_auth_info,不区分大小写 resultcode number 是 错误码 resultmsg string 是 错误描述 appkey string 是 配送公司分配的appkey,对应shopid account string 是 帐号名称 account_type number 是 帐号类型:0.不确定,1.预充值,2,月结,3,其它
immediateDelivery.onAgentPosQuery 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 查询骑手当前位置信息 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 transport_get_agent_pos,不区分大小写 shopid string 商家id, 由配送公司分配,可以是dev_id或者appkey shop_order_id string 唯一标识订单的 ID,由商户生成 shop_no string 商家门店编号, 在配送公司侧登记 waybill_id string 配送单id 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为 event Event string 是 事件类型,固定为 transport_get_agent_pos,不区分大小写 resultcode number 是 错误码 resultmsg string 是 错误描述 lng number 是 经度,火星坐标,精确到小数点后6位 lat number 是 纬度,火星坐标,精确到小数点后6位 distance number 是 和目的地距离,已取货配送中需返回,单位米 reach_time number 是 预计还剩多久送达时间, 单位秒, 已取货配送中需返回,比如5分钟后送达,填300
immediateDelivery.reOrder 本接口应在服务器端调用,详细说明参见服务端API。 重新下单 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/readd?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 delivery_token string 否 预下单接口返回的参数,配送公司可保证在一段时间内运费不变 shopid string 是 商家id, 由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成, 不超过128字节 shop_no string 是 商家门店编号,在配送公司登记,如果只有一个门店,闪送shop_no必填,值为店铺id delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 delivery_id string 是 配送公司ID openid string 是 下单用户的openid sender Object 是 发件人信息,顺丰同城急送必须填写,美团配送、达达、闪送,若传了shop_no的值可不填该字段 receiver Object 是 收件人信息 cargo Object 是 货物信息 order_info Object 是 订单信息 shop Object 是 商品信息,会展示到物流通知消息中 sub_biz_id string 否 子商户id,区分小程序内部多个子商户 sender 的结构 属性 类型 默认值 必填 说明 name string 是 姓名,最长不超过256个字符 city string 是 城市名称,如广州市 address string 是 地址(街道、小区、大厦等,用于定位) address_detail string 是 地址详情(楼号、单元号、层号) phone string 是 电话/手机号,最长不超过64个字符 lng number 是 经度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,确到小数点后6位 lat number 是 纬度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,精确到小数点后6位) coordinate_type number 0 否 坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标 receiver 的结构 属性 类型...
immediateDelivery.realMockUpdateOrder 本接口应在服务器端调用,详细说明参见服务端API。 模拟配送公司更新配送单状态, 该接口用于测试账户下的单,将请求转发到运力测试环境 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/realmock_update_order?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id shop_order_id string 是 唯一标识订单的 ID,由商户生成 action_time number 是 状态变更时间点,Unix秒级时间戳 order_status number 是 配送状态,枚举值 action_msg string 否 附加信息 delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 使用场景 该接口只能用于测试,请求会转发到运力测试环境, 目前支持顺丰同城和达达 顺丰同城测试号 shopid: 1534713176 appsecret: d80400f91e156f63b38886e616d84590 shopno: 3243279847393 支持变更状态: 102 202 202 302 达达测试号 shopid: dadaaee18818d97e236 appsecret: 1c6f40492d6d89caaad80b85f7d31670 shopno: 77071-47913 支持变更状态: 102 201 202 301 302 304 305 请求示例 { "shopid": "xxxxxxx", "shop_order_id": "xxxxxxxxxxx", "action_time": 1584145981, "order_status": 101, "action_msg": "", "delivery_sign": "xxxxxxx", } 返回数据示例 { "resultcode": 0, "resultmsg": "ok" }
immediateDelivery.preCancelOrder 本接口应在服务器端调用,详细说明参见服务端API。 预取消配送单接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/precancel?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id, 由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成 shop_no string 是 商家门店编号,在配送公司登记,闪送shop_no必填,值为店铺id delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 delivery_id string 是 快递公司ID waybill_id string 是 配送单id cancel_reason_id number 否 取消原因Id cancel_reason string 否 取消原因 cancel_reason_id 的合法值 值 说明 最低版本 1 暂时不需要邮寄 2 价格不合适 3 订单信息有误,重新下单 4 骑手取货不及时 5 骑手配送不及时 6 其他原因( 如果选择6,需要填写取消原因,否则不需要填写 ) 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 deduct_fee number 预计扣除的违约金(单位:元),精确到分 desc string 说明 使用场景 在正式取消配送单前,商家可调用本接口查询该订单是否可以取消,取消订单配送公司需要扣除的费用是多少。各家取消规则如下: 配送公司 取消规则 顺丰同城急送 配送完成前任意节点可取消配送单 闪送 配送完成前任意节点可取消配送单 美团配送 配送完成前任意节点可取消配送单 达达 骑手取货之前可取消配送单 请求示例 { "shopid": "123456", "shop_order_id": "123456", "waybill_id": "123456", "delivery_id": "123456", "cancel_reason_id": 1, "cancel_reason": "", "delivery_sign":...
immediateDelivery.preAddOrder 本接口应在服务器端调用,详细说明参见服务端API。 预下配送单接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/pre_add?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id, 由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成, 不超过128字节 shop_no string 是 商家门店编号,在配送公司登记,美团、闪送必填 delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 delivery_id string 是 配送公司ID openid string 是 下单用户的openid sender Object 是 发件人信息,闪送、顺丰同城急送必须填写,美团配送、达达,若传了shop_no的值可不填该字段 receiver Object 是 收件人信息 cargo Object 是 货物信息 order_info Object 是 订单信息 shop Object 是 商品信息,会展示到物流通知消息中 sub_biz_id string 否 子商户id,区分小程序内部多个子商户 sender 的结构 属性 类型 默认值 必填 说明 name string 是 姓名,最长不超过256个字符 city string 是 城市名称,如广州市 address string 是 地址(街道、小区、大厦等,用于定位) address_detail string 是 地址详情(楼号、单元号、层号) phone string 是 电话/手机号,最长不超过64个字符 lng number 是 经度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,确到小数点后6位 lat number 是 纬度(火星坐标或百度坐标,和 coordinate_type 字段配合使用,精确到小数点后6位) coordinate_type number 0 否 坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标 receiver 的结构 属性 类型 默认值 必填 说明 name...
immediateDelivery.openDelivery 本接口应在服务器端调用,详细说明参见服务端API。 第三方代商户发起开通即时配送权限 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/open?access_token=COMPNENT_ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 errcode 的合法值 值 说明 最低版本 0 成功 43016 小程序未认证 86000 不是第三方的调用 930568 不支持个人类型小程序 930569 已经开通不需要再开通 930571 该商户没有内测权限 使用场景 只能由第三方服务商调用此接口 服务商可通过本接口代开发的小程序发起开通即时配送接口权限的操作,当调用成功,小程序管理员将收到模版消息,进行开通操作 返回数据示例 { "resultcode": 0, "resultmsg": "ok", }
immediateDelivery.onOrderStatus 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 配送单配送状态更新通知接口 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 update_waybill_status,不区分大小写 shopid string 商家id, 由配送公司分配的appkey shop_order_id string 唯一标识订单的 ID,由商户生成 shop_no string 商家门店编号, 在配送公司侧登记 waybill_id string 配送单id action_time number Unix时间戳 order_status number 配送状态,枚举值 action_msg string 附加信息 agent Object 骑手信息 agent 的结构 属性 类型 说明 name string 骑手姓名 phone string 骑手电话 reach_time number 预计送达时间戳, 配送中返回 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为 event Event string 是 事件类型,固定为 update_waybill_status,不区分大小写 resultcode number 是 错误码 resultmsg string 是 错误描述 使用场景 当配送公司更新订单配送状态时,微信会通过本接口同步通知商户 消息数据包示例 JSON 格式 { "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1546924844,...
immediateDelivery.mockUpdateOrder 本接口应在服务器端调用,详细说明参见服务端API。 模拟配送公司更新配送单状态, 该接口只用于沙盒环境,即订单并没有真实流转到运力方 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/test_update_order?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id, 必须是 “test_shop_id” shop_order_id string 是 唯一标识订单的 ID,由商户生成 action_time number 是 状态变更时间点,Unix秒级时间戳 order_status number 是 配送状态,枚举值 action_msg string 否 附加信息 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 使用场景 该接口只能用于测试 请求示例 { "shopid": "test_shop_id", "shop_order_id": "xxxxxxxxxxx", "waybill_id": "xxxxxxxxxxxxx", "action_time": 12345678, "order_status": 101, "action_msg": "", } 返回数据示例 { "resultcode": 0, "resultmsg": "ok" }