下发订单取消拦截指令接口
注意:能否发起取消拦截需满足一定条件,否则会发起失败取消拦截的条件如下
1、已发起承诺拦截
2、包裹未被实物拦截
3、包裹取消拦截次数小于1次
基本信息
请求方式 | Post application/x-www-form-urlencoded |
---|---|
功能描述 | 商家在包裹拦截后请求edi下发取消拦截指令,取消拦截成功后,包裹按照原有链路继续派送 |
编码 | UTF-8 |
入参
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
对接码 | logistic_provider_id | String | 是 | 菜鸟侧提供 |
签名 | data_digest | String | 是 | Base64(Md5(logistics_interface+双方约定的secretKey)),0.2 签名方法 |
业务报文 | logistics_interface | String | 是 | JSON |
logistics_interface内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
运单号 | mailNos | List<String> | 是 | 示例:20140804138802。允许批量拦截,最多取消拦截50条运单 |
出参
项目 | 名称 | 类型 | 必填 |
---|---|---|---|
成功标识 | success | boolean | 是 |
错误码 | errorCode | String | 否 |
错误说明 | errorMsg | String | 否 |
总运单数 | totalCount | Integer | 否 |
取消拦截失败的运单数 | failCount | Integer | 否 |
取消拦截成功的运单数 | successCount | Integer | 否 |
具体的取消拦截结果 | waybillCancelInterceptDetail | List<CancelInterceptDetail> | 否 |
CancelInterceptDetail
项目 | 名称 | 类型 | 必填 |
---|---|---|---|
取消拦截状态 | success | boolean | 是 |
取消拦截失败原因Code | reasonCode | String | 否 |
取消拦截失败原因msg | reasonMsg | String | 否 |
示例报文
url:
http://edi-daily.xpm.cainiao.com/ext/gateway/ediStandardWaybillCancelIntercept/api
请求: 仅供参考,实际测试账号需联系菜鸟速递开发提供
logistic_provider_id: edi_test_gongpei_json
data_digest: a4drgzJuYyrgFwY/BdWRWQ==
logistics_interface:
{
mailNos: [
"DN123",
"DN456"
]
}
返回:
{
success: true,
errorCode: "",
errorMsg: "",
totalCount: 1,
successCount: 1,
failCount: 0,
waybillCancelInterceptDetail: [
{
success: true,
reasonCode: "",
resonMsg: ""
}
]
}
取消拦截失败异常码
异常分类 | 异常码 | 异常消息 |
---|---|---|
业务原因 | CANCEL_INTERCEPT_FAIL_FOR_INVERSE_ORDER_ALREADY_EXIST | 已生成逆向单不允许取消拦截 |
业务原因 | CANCEL_INTERCEPT_FAIL_FOR_INTERCEPT_SUCCESS | 实物拦截成功不支持取消 |
业务原因 | DOWNGRADE | 大促降级,取消拦截失败 |
业务原因 | IMPERCEPTIBLE_INTERCEPT | 内部拦截,取消拦截失败 |
业务原因 | NO_NEED_CANCEL_INTERCEPT | 未下发拦截或拦截已取消,无需取消拦截 |
业务原因 | TIMES_LIMIT | 超过次数限制,取消拦截失败 |
技术原因 | WAYBILL_NUMBER_OVER_LIMIT | 一次最多只能操作50条运单 |
技术原因 | 413-E-12 | 订单不存在 |
技术原因 | WAYBILL_NOT_FOUND | waybill查询为空 |
技术原因 | 413-E-2 | 系统未知异常 |
技术原因 | BIZ_CANCEL_INTERCEPT_ABILITY_CONFIG_NOT_EXIST | 未配置行业取消拦截能力 |
技术原因 | INVOKE_SMS_CANCEL_INTERCEPT_FAIL | 调用末端取消拦截服务失败 |
技术原因 | SYSTEM_EXCEPTION | 系统异常 |
技术原因 | CPC_CANCEL_INTERCEPT_INVOKE_EXCEPTION | 调用CPC取消拦截接口异常 |
技术原因 | UNKNOWN_SYS_ERROR | 未知系统异常 |
末端原因 | 107 | 未拦截运单无法取消拦截 |
末端原因 | 108 | 包裹已丢失 |
末端原因 | 109 | 包裹未被拦截 |
末端原因 | 110 | 包裹拦截退回中 |
末端原因 | 111 | 已确认拦截不支持取消拦截 |
末端原因 | 105 | 运单状态不支持 |