微信小程序开发文档 第64页
immediateDelivery.getOrder 本接口应在服务器端调用,详细说明参见服务端API。 拉取配送单信息 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/get?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id, 由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成 shop_no string 是 商家门店编号, 在配送公司登记,如果只有一个门店,可以不填 delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 order_status number 配送状态,枚举值 waybill_id string 配送单号 rider_name string 骑手姓名 rider_phone string 骑手电话 rider_lng number 骑手位置经度, 配送中时返回 rider_lat number 骑手位置纬度, 配送中时返回 reach_time number 预计还剩多久送达时间, 配送中时返回,单位秒, 已取货配送中需返回,比如5分钟后送达,填300 使用场景 商家可使用本接口查询某一配送单的配送状态,便于商家掌握配送情况。
immediateDelivery.getBindAccount 本接口应在服务器端调用,详细说明参见服务端API。 拉取已绑定账号 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/shop/get?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 shop_list Array.<Object> 绑定的商家签约账号列表 shop_list 的结构 属性 类型 说明 delivery_id string 配送公司Id shopid string 商家id audit_result number 审核状态 audit_result 的合法值 值 说明 最低版本 0 审核通过 1 审核中 2 审核不通过 使用场景 商家可通过本接口查询自己已经在小程序后台绑定的和配送公司签约的账号; 服务商可通过本接口查询代开发的小程序在小程序后台绑定的和配送公司签约的账号,为其完成后续的接口代开发业务。 返回数据示例 { "resultcode": 0, "resultmsg": "ok", "shop_list": [ { "delivery_id": "SFTC", "shopid": "123456", "audit_result": 0 }, { "delivery_id": "MTPS", "shopid": "123456", "audit_result": 0 } ] }
immediateDelivery.getAllImmeDelivery 本接口应在服务器端调用,详细说明参见服务端API。 获取已支持的配送公司列表接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/delivery/getall?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 list Array.<Object> 配送公司列表 list 的结构 属性 类型 说明 delivery_id string 配送公司Id delivery_name string 配送公司名称 使用场景 查询即时配送接口已支持的配送公司和delivery_id 返回数据示例 { "resultcode": 0, "resultmsg": "ok", "list": [ { "delivery_id": "SFTC", "delivery_name": "顺发同城" }, { "delivery_id": "MTPS", "delivery_name": "美团配送" } ] }
immediateDelivery.cancelOrder 本接口应在服务器端调用,详细说明参见服务端API。 取消配送单接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/cancel?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.bindAccount 本接口应在服务器端调用,详细说明参见服务端API。 第三方代商户发起绑定配送公司帐号的请求 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/shop/add?access_token=COMPNENT_ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 delivery_id string 是 配送公司ID 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 errcode 的合法值 值 说明 最低版本 0 成功 86000 不是第三方的调用 930561 delivery_id无效 使用场景 只能由第三方服务商调用此接口 服务商可通过本接口代开发的小程序发起绑定配送公司帐号的操作,当调用成功,小程序管理员将收到模版消息,点击详情进入配送公司网站进行绑定操作 返回数据示例 { "resultcode": 0, "resultmsg": "ok", }
immediateDelivery.addTip 本接口应在服务器端调用,详细说明参见服务端API。 可以对待接单状态的订单增加小费。需要注意:订单的小费,以最新一次加小费动作的金额为准,故下一次增加小费额必须大于上一次小费额 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/addtips?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加密的校验串说明 waybill_id string 是 配送单id openid string 是 下单用户的openid tips number 是 小费金额(单位:元) 各家配送公司最大值不同 remark string 是 备注 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 使用场景 调用本接口,可以给待接单状态的订单增加小费,各家配送公司增加消费的规则如下: 配送公司 加小费规则 顺丰同城急送 支持加小费,小费规则:骑手接单前可加小费,上限10次,200元封顶 闪送 支持加小费,小费规则:骑手接单前可加小费,需按固定档位加小费,档位为2、3、5、10、15、20、50、100 美团配送 不支持加小费 达达配送 支持加小费,小费规则:骑手接单前可加小费,小费金额以最新一次为准,同一单新增的小费额须大于上一次的小费额,小费不可以超过货值,上限30元 请求示例 { "shopid": "123456", "shop_order_id": "123456", "waybill_id": "123456", "tips": 5, "remark": "gogogo", "delivery_sign": "123456", "shop_no": "shop_no_111" } 返回数据示例 { "resultcode": 0, "resultmsg": "ok" }
immediateDelivery.addOrder 本接口应在服务器端调用,详细说明参见服务端API。 下配送单接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/add?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 delivery_token string 否 预下单接口返回的参数,配送公司可保证在一段时间内运费不变 shopid string 是 商家id,由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成, 不超过128字节 shop_no string 是 商家门店编号,在配送公司登记,如果只有一个门店,美团闪送必填, 值为店铺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.abnormalConfirm 本接口应在服务器端调用,详细说明参见 服务端API 。 异常件退回商家商家确认收货接口 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/confirm_return?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 shopid string 是 商家id,由配送公司分配的appkey shop_order_id string 是 唯一标识订单的 ID,由商户生成 shop_no string 是 商家门店编号,在配送公司登记,闪送必填,值为店铺id delivery_sign string 是 用配送公司提供的appSecret加密的校验串说明 waybill_id string 是 配送单id remark string 否 备注 返回值 Object 属性 类型 说明 errcode number 错误码, 当errcode==0或者不存在还需要看resultcode errmsg string 错误描述 resultcode number 运力返回的错误码 resultmsg string 运力返回的错误描述 使用场景 当订单配送异常,骑手把货物退还给商家,商家收货以后调用本接口返回确认收货。 请求示例 { "shopid": "123456", "shop_order_id": "123456", "shop_no": "shop_no_111" "waybill_id": "123456", "remark": "remark", "delivery_sign": "123456" } 返回数据示例 { "resultcode": 0, "resultmsg": "ok" }
logistics.onGetQuota 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 查询商户余额事件。 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 get_quota,不区分大小写 BizID string 商户ID,即商户在快递注册的客户编码或月结账户名 BizPwd string BizID 对应的密码 ShopAppID string 商户小程序的 AppID 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为event Event string 是 事件类型,固定为get_quota,不区分大小写 BizID string 是 商户ID ResultCode number 是 处理结果错误码 ResultMsg string 是 处理结果详情 Quota number 是 商户可用余额,0 表示无可用余额 ResultCode 的合法值 值 说明 最低版本 0 查询成功 -1 其他错误 10001 客户编码或者月结账户不存在 10002 客户密码不正确 消息数据包示例 XML 格式 <xml> <ToUserName><![CDATA[gh_abcdefg]]></ToUserName> <FromUserName><![CDATA[oABCD]]></FromUserName> <CreateTime>1533042556</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[get_quota]]></Event> <BizID><![CDATA[xyz]]></BizID> <BizPwd><![CDATA[xyz123]]></BizPwd> <ShopAppID><![CDATA[wxABCD]]></ShopAppID> </xml> JSON 格式 { "ToUserName": "gh_abcdefg", "FromUserName": "oABCD", "CreateTime": 1533042556, "MsgType":...
logistics.onCheckBusiness 本文档描述服务器端接收的消息或事件,详细说明参见消息推送。 审核商户事件。 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID (固定值) CreateTime number 事件时间,Unix 时间戳 MsgType string 消息类型,固定为 event Event string 事件类型,固定为 check_biz,不区分大小写 BizID string 商户ID,即商户在快递注册的客户编码或月结账户名 BizPwd string BizID 对应的密码 ShopAppID string 商户的小程序 AppID ShopName string 商户名称,即小程序昵称(仅EMS可用) ShopTelphone string 商户联系电话(仅EMS可用) ShopContact string 商户联系人姓名(仅EMS可用) ServiceName string 预开通的服务类型名称(仅EMS可用) SenderAddress string 商户发货地址(仅EMS可用) SenderProvince string 商户发货省份(仅EMS可用) SenderCity string 商户发货城市(仅EMS可用) SenderArea string 商户发货区域(仅EMS可用) 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间,Unix时间戳 MsgType string 是 消息类型,固定为event Event string 是 事件类型,固定为check_biz,不区分大小写 BizID string 是 商户ID ResultCode number 是 处理结果错误码 ResultMsg string 是 处理结果详情 Quota number 是 商户可用余额,0 表示无可用余额 ResultCode 的合法值 值 说明 最低版本 0 审核通过 -1 其他错误 10001 客户编码或者月结账户不存在...