注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 电子面单对接知识库

cainiao.waybill.ii.cancel (商家取消获取的电子面单号)

面单号有误需要取消的时候,调用该接口取消获取的电子面单。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
cp_code String 必须 POSTB 快递公司code
waybill_code String 必须 1111 电子面单号

响应参数

名称 类型 示例值 描述
cancel_result Boolean true 调用取消是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillIiCancelRequest req = new CainiaoWaybillIiCancelRequest();
req.setCpCode("POSTB");
req.setWaybillCode("1111");
CainiaoWaybillIiCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_waybill_ii_cancel_response>
    <cancel_result>true</cancel_result>
</cainiao_waybill_ii_cancel_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
cancel detail is not found! 取消面单时,没有对应的订单明细 确定入参面单号合法
invalid detail status 面单已经被揽收,签收或回收 检查入参
cancel count over the limit 取消次数已经超过预设所允许的次数(超过申请面单的20%) 放弃取消
isp.WAYBILL_APPLY_CANCEL_ERROR 取消面单号失败 稍后重试
waybill service cannot open 当前传入的快递公司编号代表的快递公司取消服务暂不开放 检查cpCode是否错误,或开通服务
update invalid status 面单明细状态异常,可能正在被其他人修改 稍等后查询或者再次执行取消操作

API工具

如何获得此API

FAQ

返回
顶部