# 模拟回调接口
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:intracity_mocknotify
由于测试订单没有快递员接单,不会自动推送订单状态变化回调,为了方便开发者在沙箱环境联调,我们提供了模拟回调接口,针对测试订单开发者可以通过该接口触发其他说明中订单状态回调
如有开发问题或建议,可前往微信开放社区-微信物流服务 发帖提问讨论,官方工作人员会及时回复。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/intracity/mocknotify?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:51
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| wx_order_id | string | 否 | 微信订单号,可以单独使用wx_order_id |
| wx_store_id | string | 否 | 门店ID wx_store_id和store_order_id需要成对出现 |
| store_order_id | string | 否 | 门店订单号 wx_store_id和store_order_id需要成对出现 |
| order_status | number | 是 | 订单状态,详见其他说明订单状态列表 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
# 其他说明
# 订单状态回调
# 回调协议
当订单状态发生变更时,会由微信服回调接入方的回调地址进行状态变更的通知,回调接口地址需要接入方在下单时传入,详见门店余额查询
| 字段 | 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| appid | appid | string | 是 | 下单小程序appid |
| wx_store_id | 微信门店id | string | 是 | |
| wx_order_id | 微信订单号 | string | 是 | |
| store_order_id | 门店订单号 | string | 是 | |
| order_status | 订单状态 | uint32 | 是 | 详情看下方订单状态列表 |
| status_change_time | 订单状态变更时间 | uint32 | 是 | 秒级时间戳格式 |
| timestamp | 消息推送时间 | uint32 | 是 | 秒级时间戳格式 |
| service_trans_id | 运力ID | string | 是 | |
| sign | 签名值 | string | 是 | 生成方式详见回调报文示例里的签名步骤说明 |
# 回调报文示例:
{
"appid":"wx539e0b4872f19621",
"order_status":40000,
"service_trans_id":"DADA",
"status_change_time":1711458532,
"store_order_id":"sa5dadada12fd4assdsdad11s",
"timestamp":1711458532,
"wx_order_id":"4018734875633256960",
"wx_store_id":"4000000000000042001",
"sign":"a85489d9444bdd382e0de0ddca67a8ee"
}
# 签名步骤:
1.对报文的数据做预处理用=连接key和value组成键值对,按key的ascii码升序排列键值对用&链接,示例如下:
appid=wx539e0b4872f19621&order_status=40000&service_trans_id=DADA&status_change_time=1711458532&store_order_id=sa5dadada12fd4assdsdad11s×tamp=1711458532&wx_order_id=4018734875633256960&wx_store_id=4000000000000042001
2.拼接小程序的安全token,安全token需要在下单小程序管理后台设置和获取,设置路径:开发管理->开发设置->消息推送->Token
appid=wx539e0b4872f19621&order_status=40000&service_trans_id=DADA&status_change_time=1711458532&store_order_id=sa5dadada12fd4assdsdad11s×tamp=1711458532&wx_order_id=4018734875633256960&wx_store_id=4000000000000042001&token=abcdefghi
3.对第二步中的字符串计算MD5,得到十六进制结果取小写。
to_lower(to_hex(md5(sign_str)))
签名值:a85489d9444bdd382e0de0ddca67a8ee 商家需要回复报文:
{
"return_code":0,
"return_msg":"OK"
}
表示应答成功,如果没有接收到正确的请求应答,微信会重试回调。
# 订单状态列表
| 状态类型 | 状态名称 |
|---|---|
| 10000 | 订单创建成功 |
| 20000 | 商家取消订单 |
| 20001 | 配送方取消订单 |
| 30000 | 配送员接单 |
| 40000 | 配送员到店 |
| 50000 | 配送中 |
| 60000 | 配送员撤单 |
| 70000 | 配送完成 |
| 90000 | 配送异常 |
# 物品类型列表
| 物品类型 | 类型名称 |
|---|---|
| 1 | 快餐 |
| 2 | 药品 |
| 3 | 百货 |
| 6 | 生鲜 |
| 8 | 酒品 |
| 12 | 文件 |
| 13 | 蛋糕 |
| 14 | 鲜花 |
| 15 | 数码 |
| 16 | 服装 |
| 17 | 汽配 |
| 18 | 珠宝 |
| 32 | 饮料 |
| 36 | 证照 |
| 55 | 宠物用品 |
| 56 | 母婴用品 |
| 57 | 美妆用品 |
| 58 | 家居建材 |
| 99 | 其他 |
# 运力列表
| 运力名称 | 运力ID |
|---|---|
| 达达 | DADA |
| 顺丰同城 | SFTC |
# 5. 代码示例
请求示例
{
"wx_order_id":"2000000000000092001",
"order_status":30000
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 0 | 请求成功 |
| 48001 | api unauthorized。原因是小程序没有获得同城配送接口权限,在小程序管理后台开通【同城配送】后即可 |
| 61007 | api is unauthorized to component。此小程序没有授权当前服务商调用接口权限,服务商需获得小程序的51接口权限集 |
| 934000 | 其他逻辑错误 |
| 934001 | 请求参数有误,详细看错误提示 |
| 934002 | 订单已存在,且订单在处理中,请勿重复添加 |
| 934003 | 运力ID错误 |
| 934005 | 运力预创建订单错误 |
| 934006 | 有在途订单,暂不能退款,请等待配送完成 |
| 934007 | 不是在途订单 |
| 934008 | 门店ID和APPID不匹配 |
| 934009 | 不支持该门店所在城市 |
| 934010 | 重复创建门店,请更换out_store_id |
| 934011 | 请求签名错误 |
| 934011 | signature is needed, please refer document for help https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html。 原因是接口没有带签名验证信息,可以参照微信服务端api签名指南的指引开发,同时社区内也有同行分享的php和java的开发实践经验。 |
| 934012 | appid和access_token不匹配 |
| 934013 | 门店余额不足无法下单 |
| 934014 | 运力公司返回了非法金额 |
| 934015 | 余额扣减失败 |
| 934016 | 订单不存在 |
| 934017 | 订单处在不能被取消的状态 |
| 934018 | 订单已取消,请勿重复操作 |
| 934019 | 超出运力支持的配送范围 |
| 934019 | 沙箱环境下单接口返回934019 用户超出配送范围 解决方法:使用顺丰的沙箱环境环境需要固定的收件人信息(达达没有要求) 收件人信息如下:收件人姓名:顺丰同城 收件人手机:13881979410 收件地址:北京市海淀区学清嘉创大厦A座15层 |
| 934020 | 商品超重 |
| 934021 | 门店不存在 |
| 934022 | 账号类型不可以为个人账号 |
| 934023 | 小程序类型必须为普通小程序 |
| 934999 | 内部系统错误 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。