文档中心 > API类目 > 物流API

cainiao.pickup.business.cancelreason.get (菜鸟商家寄件获取可选的取消原因)

商家取消时需要勾选取消原因，提供可选的取消原因查询功能

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
mobile	String	可选	13817778888		下单操作人的手机号，用作联系，可以不填写
order_id	Number	必须	12345		裹裹订单id

响应参数

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data_list OrderCancelReason [] [] 返回对象 └ desc String 小件员迟到具体取消原因，直接显示给用户，供用户选择 └ code String 10 取消原因code，用户内外系统的交互 └ success Boolean true 是否操作成功 └ retry Boolean false 是否需要重试 └ status_message String 系统错误错误描述，如果不能使用服务，会在这里提示错误信息 └ status_code String SYS_ERROIR 错误码

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessCancelreasonGetRequest req = new CainiaoPickupBusinessCancelreasonGetRequest();
req.setMobile("13817778888");
req.setOrderId(12345L);
CainiaoPickupBusinessCancelreasonGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessCancelreasonGetRequest req = new CainiaoPickupBusinessCancelreasonGetRequest();
req.Mobile = "13817778888";
req.OrderId = 12345L;
CainiaoPickupBusinessCancelreasonGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessCancelreasonGetRequest;
$req->setMobile("13817778888");
$req->setOrderId("12345");
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=cainiao.pickup.business.cancelreason.get' \
-d 'partner_id=apidoc' \
-d 'session=617baa74-396f-47f9-ab1f-7c565b9e39bd' \
-d 'sign=6B21F0FB411DA654ECA707688F0DF4E3' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-09-27+12%3A16%3A44' \
-d 'v=2.0' \
-d 'mobile=13817778888' \
-d 'order_id=12345'

# -*- coding: utf-8 -*-
import top.api

req=top.api.CainiaoPickupBusinessCancelreasonGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.mobile="13817778888"
req.order_id=12345
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"cainiao.pickup.business.cancelreason.get");
add_param(pRequest,"mobile","13817778888");
add_param(pRequest,"order_id","12345");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('cainiao.pickup.business.cancelreason.get', {
	'mobile':'13817778888',
	'order_id':'12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_pickup_business_cancelreason_get_response>
    <result>
        <data_list>
            <order_cancel_reason>
                <desc>小件员迟到</desc>
                <code>10</code>
            </order_cancel_reason>
        </data_list>
        <success>true</success>
        <retry>false</retry>
        <status_message>系统错误</status_message>
        <status_code>SYS_ERROIR</status_code>
    </result>
</cainiao_pickup_business_cancelreason_get_response>

{
    "cainiao_pickup_business_cancelreason_get_response":{
        "result":{
            "data_list":{
                "order_cancel_reason":[
                    {
                        "desc":"小件员迟到",
                        "code":"10"
                    }
                ]
            },
            "success":true,
            "retry":false,
            "status_message":"系统错误",
            "status_code":"SYS_ERROIR"
        }
    }
}

异常示例

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

物流API

cainiao.pickup.business.cancelreason.get (菜鸟商家寄件获取可选的取消原因)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ