文档中心 > API类目 > 菜鸟发货工作台API

cainiao.consignplatform.order.cancel (菜鸟发货工作台取消包裹以及订单)

菜鸟发货工作台,商家或者isv通过api取消包裹、回收单号,如果是裹裹运力会取消小件员上门。最后删除订单信息。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
cancel_request OrderCancelRequest 必须 取消参数
  • └ outer_order_id
  • String
  • 必须
  • 110022
  • 外部订单id
  • └ sub_outer_order_ids
  • String []
  • 必须
  • 110022-1,110022-2
  • 外部订单id列表
  • └ order_source
  • String
  • 必须
  • TMJL
  • 订单来源

响应参数

名称 类型 示例值 描述
fail_code String PARAM_INVALID 失败信息
fail_message String 参数无效 失败code
result Boolean false 取消是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoConsignplatformOrderCancelRequest req = new CainiaoConsignplatformOrderCancelRequest();
CainiaoConsignplatformOrderCancelRequest.OrderCancelRequest obj1 = new CainiaoConsignplatformOrderCancelRequest.OrderCancelRequest();
obj1.setOuterOrderId("110022");
obj1.setSubOuterOrderIds("110022-1,110022-2");
obj1.setOrderSource("TMJL");
req.setCancelRequest(obj1);
CainiaoConsignplatformOrderCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_consignplatform_order_cancel_response>
    <fail_code>PARAM_INVALID</fail_code>
    <fail_message>参数无效</fail_message>
    <result>false</result>
</cainiao_consignplatform_order_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部