淘宝开放平台

登录
文档中心 > API类目 > 千牛业务API

千牛业务API

taobao.qianniu.delivery.order.cancel (取消寄件)

取消寄件

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_cp_cancel_top_request CpCancelTopRequest 必须 取消寄件入参
  • └ cp_code
  • String
  • 必须
  • STO
  • 运力公司CODE
  • └ mail_no
  • String
  • 必须
  • YTO1234567
  • 运单号
  • └ reason
  • String
  • 可选
  • 不想寄了
  • 取消原因
  • └ reason_code
  • String
  • 可选
  • 1
  • 原因CODE
  • └ remark
  • String
  • 可选
  • 自定义原因
  • 自定义原因

响应参数

名称 类型 示例值 描述
result Result {}
  • └ res_err_code
  • String
  • 错误码
  • 错误码
  • └ res_err_msg
  • String
  • 错误信息
  • 错误码
  • └ model
  • Boolean
  • true
  • 取消是否成功
  • └ success
  • Boolean
  • true
  • 请求是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
8
9
10
11
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
QianniuDeliveryOrderCancelRequest req = new QianniuDeliveryOrderCancelRequest();
QianniuDeliveryOrderCancelRequest.CpCancelTopRequest obj1 = new QianniuDeliveryOrderCancelRequest.CpCancelTopRequest();
obj1.setCpCode("STO");
obj1.setMailNo("YTO1234567");
obj1.setReason("不想寄了");
obj1.setReasonCode("1");
obj1.setRemark("自定义原因");
req.setParamCpCancelTopRequest(obj1);
QianniuDeliveryOrderCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
<qianniu_delivery_order_cancel_response>
    <result>
        <res_err_code>错误码</res_err_code>
        <res_err_msg>错误信息</res_err_msg>
        <model>true</model>
        <success>true</success>
    </result>
</qianniu_delivery_order_cancel_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<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测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部