淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
mail_no	String	必须	21345	运单号
receive_provice	String	必须	浙江省	收件人省份
mail_cp_price	Number	必须	2	cp价格
send_city	String	必须	杭州	寄件人市
mail_cp_code	String	必须	kdemo	运输cp编码
lp_code	String	必须	lp123	外部订单号
take_packge_cp_code	String	必须	demo	揽件cp编码
goods_weight	String	必须	1	重量
mail_no_date	Number	必须	221	回单时间

名称	类型	示例值	描述
status_code	String	demo	状态编码
data	Boolean	1234	结果集
is_success	Boolean	true	是否成功
status_message	String	kkdemo	状态信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoCpGraborderCporderreturnsettleserviceRequest req = new CainiaoGuoguoCpGraborderCporderreturnsettleserviceRequest();
req.setMailNo("21345");
req.setReceiveProvice("浙江省");
req.setMailCpPrice(2L);
req.setSendCity("杭州");
req.setMailCpCode("kdemo");
req.setLpCode("lp123");
req.setTakePackgeCpCode("demo");
req.setGoodsWeight("1");
req.setMailNoDate(221L);
CainiaoGuoguoCpGraborderCporderreturnsettleserviceResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoCpGraborderCporderreturnsettleserviceRequest req = new CainiaoGuoguoCpGraborderCporderreturnsettleserviceRequest();
req.MailNo = "21345";
req.ReceiveProvice = "浙江省";
req.MailCpPrice = 2L;
req.SendCity = "杭州";
req.MailCpCode = "kdemo";
req.LpCode = "lp123";
req.TakePackgeCpCode = "demo";
req.GoodsWeight = "1";
req.MailNoDate = 221L;
CainiaoGuoguoCpGraborderCporderreturnsettleserviceResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoCpGraborderCporderreturnsettleserviceRequest;
$req->setMailNo("21345");
$req->setReceiveProvice("浙江省");
$req->setMailCpPrice("2");
$req->setSendCity("杭州");
$req->setMailCpCode("kdemo");
$req->setLpCode("lp123");
$req->setTakePackgeCpCode("demo");
$req->setGoodsWeight("1");
$req->setMailNoDate("221");
$resp = $c->execute($req);

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.guoguo.cp.graborder.cporderreturnsettleservice' \
-d 'partner_id=apidoc' \
-d 'sign=ED74997BF1D3E59745FB20FF75A503D9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A57%3A46' \
-d 'v=2.0' \
-d 'goods_weight=1' \
-d 'lp_code=lp123' \
-d 'mail_cp_code=kdemo' \
-d 'mail_cp_price=2' \
-d 'mail_no=21345' \
-d 'mail_no_date=221' \
-d 'receive_provice=%E6%B5%99%E6%B1%9F%E7%9C%81' \
-d 'send_city=%E6%9D%AD%E5%B7%9E' \
-d 'take_packge_cp_code=demo'

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

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

req.mail_no="21345"
req.receive_provice="浙江省"
req.mail_cp_price=2
req.send_city="杭州"
req.mail_cp_code="kdemo"
req.lp_code="lp123"
req.take_packge_cp_code="demo"
req.goods_weight="1"
req.mail_no_date=221
try:
	resp= req.getResponse()
	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.guoguo.cp.graborder.cporderreturnsettleservice");
add_param(pRequest,"mail_no","21345");
add_param(pRequest,"receive_provice","浙江省");
add_param(pRequest,"mail_cp_price","2");
add_param(pRequest,"send_city","杭州");
add_param(pRequest,"mail_cp_code","kdemo");
add_param(pRequest,"lp_code","lp123");
add_param(pRequest,"take_packge_cp_code","demo");
add_param(pRequest,"goods_weight","1");
add_param(pRequest,"mail_no_date","221");
pResponse = top_execute(pClient,pRequest,NULL);
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.guoguo.cp.graborder.cporderreturnsettleservice', {
	'mail_no':'21345',
	'receive_provice':'浙江省',
	'mail_cp_price':'2',
	'send_city':'杭州',
	'mail_cp_code':'kdemo',
	'lp_code':'lp123',
	'take_packge_cp_code':'demo',
	'goods_weight':'1',
	'mail_no_date':'221'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_cp_graborder_cporderreturnsettleservice_response>
    <status_code>demo</status_code>
    <data>1234</data>
    <is_success>true</is_success>
    <status_message>kkdemo</status_message>
</cainiao_guoguo_cp_graborder_cporderreturnsettleservice_response>

{
    "cainiao_guoguo_cp_graborder_cporderreturnsettleservice_response":{
        "status_code":"demo",
        "data":1234,
        "is_success":true,
        "status_message":"kkdemo"
    }
}

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测试工具错误码查询工具 SDK下载

开放平台

菜鸟无线API

cainiao.guoguo.cp.graborder.cporderreturnsettleservice (回单对账服务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ