# 预取消配送单

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:preCancelOrder

# 使用场景描述

  • 在正式取消配送单前,商家可调用本接口查询该订单是否可以取消,取消订单配送公司需要扣除的费用是多少。各家取消规则如下:
  • 顺丰同城急送:配送完成前任意节点可取消配送单
  • 闪送:配送完成前任意节点可取消配送单
  • 美团配送:配送完成前任意节点可取消配送单
  • 达达:骑手取货之前可取消配送单

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/express/local/business/order/precancel?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:51、71

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
shopidstring商家id, 由配送公司分配的appkey
shop_order_idstring唯一标识订单的 ID,由商户生成
delivery_idstring快递公司ID
waybill_idstring配送单id
cancel_reason_idnumber取消原因Id
cancel_reasonstring取消原因
shop_nostring商家门店编号,在配送公司登记,闪送shop_no必填,值为店铺id
delivery_signstring用配送公司提供的appSecret加密的校验串说明

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
resultcodenumber运力返回的错误码
resultmsgstring运力返回的错误描述
deduct_feenumber预计扣除的违约金(单位:元),精确到分
descstring说明

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "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"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。