# 取消配送单
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:intracity_cancelorder
通过该接口可以取消已创建的订单,取消配送中的订单需要扣减违约金。顺丰配送员接单后2分钟取消订单,收取¥2违约金;达达配送员接单后1分钟取消订单,收取¥2违约金。
如有开发问题或建议,可前往微信开放社区-微信物流服务 发帖提问讨论,官方工作人员会及时回复。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/intracity/cancelorder?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_store_id | string | 否 | 微信门店编号.wx_store_id和store_order_id需要成对出现 | - |
| store_order_id | string | 否 | wx_store_id和store_order_id需要成对出现 | - |
| wx_order_id | string | 否 | 可以单独使用wx_order_id取消订单 | - |
| cancel_reason_id | number | 是 | 取消原因 | 枚举值 |
| cancel_reason | string | 否 | 取消原因描述 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| wx_store_id | string | 微信门店编号。以下字段在请求成功时返回 |
| wx_order_id | string | 微信订单号 |
| store_order_id | string | 门店订单号 |
| order_status | number | 订单状态,详情看其他说明订单状态列表 |
| appid | string | 小程序appid |
| deductfee | number | 违约金。取消配送途中的订单,需要扣减违约金 |
# 4. 枚举信息
# Body.cancel_reason_id Enum
取消原因
| 枚举值 | 描述 |
|---|---|
| 1 | 不需要了 |
| 2 | 信息填错 |
| 3 | 无人接单 |
| 99 | 其他 |
# 5. 注意事项
# 其他说明
# 订单状态列表
| 状态类型 | 状态名称 |
|---|---|
| 10000 | 订单创建成功 |
| 20000 | 商家取消订单 |
| 20001 | 配送方取消订单 |
| 30000 | 配送员接单 |
| 40000 | 配送员到店 |
| 50000 | 配送中 |
| 60000 | 配送员撤单 |
| 70000 | 配送完成 |
| 90000 | 配送异常 |
# 6. 代码示例
请求示例
{
"wx_store_id":"4000000000000042001",
"wx_order_id":"2000000000000092001",
"cancel_reason_id":1,
"cancel_reason":"不需要了"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"wx_order_id": "2000000000000092001",
"store_order_id": "testorder12345879",
"wx_store_id": "4000000000000042001",
"appid": "wx539e0b4872f196d1",
"order_status": 20000,
"deductfee": 0
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 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 | 内部系统错误 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。