# 取消配送单
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
cancelOrder
# 功能描述
该接口用于取消配送单。
# 注意事项
调用本接口可向配送公司请求取消配送单,各家取消规则如下:
- 顺丰同城急送:配送完成前任意节点可取消配送单
- 闪送:配送完成前任意节点可取消配送单
- 美团配送:配送完成前任意节点可取消配送单
- 达达:骑手取货之前可取消配送单
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/cancel?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:51、71
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过getAccessToken接口获得; 如果是第三方代调用请传入authorizer_access_token; cloudbase_access_token可通过getOpenData接口获得 |
shopid | string | 是 | 商家id, 由配送公司分配的appkey |
shop_order_id | string | 是 | 唯一标识订单的 ID,由商户生成 |
delivery_id | string | 是 | 快递公司ID |
waybill_id | string | 否 | 配送单id |
cancel_reason_id | number | 是 | 取消原因Id。1表示暂时不需要邮寄;2表示价格不合适;3表示订单信息有误,重新下单;4表示骑手取货不及时;5表示骑手配送不及时;6表示其他原因( 如果选择6,需要填写取消原因,否则不需要填写 ) |
cancel_reason | string | 是 | 取消原因 |
shop_no | string | 是 | 商家门店编号,如果只有一个门店,闪送shop_no必填,值为店铺id |
delivery_sign | string | 是 | 用配送公司提供的appSecret加密的校验串说明 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
resultcode | number | 运力返回的错误码 |
resultmsg | string | 运力返回的错误描述 |
deduct_fee | number | 扣除的违约金(单位:元),精确到分 |
desc | string | 说明 |
# 其他说明
# cancel_reason_id 的合法值
值 | 说明 |
---|---|
1 | 暂时不需要邮寄 |
2 | 价格不合适 |
3 | 订单信息有误,重新下单 |
4 | 骑手取货不及时 |
5 | 骑手配送不及时 |
6 | 其他原因( 如果选择6,需要填写取消原因,否则不需要填写 ) |
# 调用示例
示例说明: HTTPS调用
# 请求数据示例
{
"shopid": "123456",
"shop_order_id": "123456",
"waybill_id": "123456",
"delivery_id": "123456",
"cancel_reason_id": 1,
"cancel_reason": "",
"delivery_sign": "123456",
"shop_no": "shop_no_111"
}
# 返回数据示例
{
"resultcode": 0,
"resultmsg": "ok",
"deduct_fee": 5,
"desc": "blabla"
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |