淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
seller_id	Number	必须	3892269560	商家id
param_waybill_cloud_print_update_request	WaybillCloudPrintUpdateRequest	必须		更新请求信息
└ cp_code String 必须 POSTB 物流公司CODE └ logistics_services String 可选 { "SVC-COD": { "value": "200" } } 物流服务内容链接 package_info PackageInfoDto 可选包裹信息 items Item [] 可选商品 └ count Number 可选 1 数量 └ name String 可选鞋子名称 └ volume Number 可选 1 体积 └ weight Number 可选 1 重量 recipient UserInfoDto 可选收件信息 address AddressDto 可选地址 └ city String 可选杭州市城市 └ detail String 可选西溪园区详细地址 └ district String 可选余杭区区地址 └ province String 可选浙江省省 └ town String 可选文一西路街道 └ mobile String 可选 132432323 手机号码 └ name String 可选 Foo 姓名 └ phone String 可选 05712323241 固定电话 └ oaid String 可选 abcdefghijklmn 开放地址ID └ caid String 可选 abcdefghijklmn 菜鸟地址ID，针对电商平台加密订单场景使用，淘系订单使用oaid，非淘使用caid。 sender UserInfoDto 可选发件信息 └ mobile String 可选 1352353325 手机号码 └ name String 可选 Foo 姓名 └ phone String 可选 05714232523 固定电话 └ template_url String 可选 http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id=1001 模板URL └ waybill_code String 必须 9890000160004 面单号 └ object_id String 可选 x 请求表示id
param_client_info_for_top	ClientInfoForTopDto	必须		系统自动生成
└ app_name String 必须 waybill 调用来源应用appname

名称	类型	示例值	描述
print_data	String	x	模板内容
waybill_code	String	x	面单号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillIiInnerUpdateRequest req = new CainiaoWaybillIiInnerUpdateRequest();
req.setSellerId(3892269560L);
CainiaoWaybillIiInnerUpdateRequest.WaybillCloudPrintUpdateRequest obj1 = new CainiaoWaybillIiInnerUpdateRequest.WaybillCloudPrintUpdateRequest();
obj1.setCpCode("POSTB");
obj1.setLogisticsServices("{     \"SVC-COD\": {         \"value\": \"200\"     } }");
CainiaoWaybillIiInnerUpdateRequest.PackageInfoDto obj2 = new CainiaoWaybillIiInnerUpdateRequest.PackageInfoDto();
List<CainiaoWaybillIiInnerUpdateRequest.Item> list4 = new ArrayList<CainiaoWaybillIiInnerUpdateRequest.Item>();
CainiaoWaybillIiInnerUpdateRequest.Item obj5 = new CainiaoWaybillIiInnerUpdateRequest.Item();
list4.add(obj5);
obj5.setCount(1L);
obj5.setName("鞋子");
obj2.setItems(list4);
obj2.setVolume(1L);
obj2.setWeight(1L);
obj1.setPackageInfo(obj2);
CainiaoWaybillIiInnerUpdateRequest.UserInfoDto obj6 = new CainiaoWaybillIiInnerUpdateRequest.UserInfoDto();
CainiaoWaybillIiInnerUpdateRequest.AddressDto obj7 = new CainiaoWaybillIiInnerUpdateRequest.AddressDto();
obj7.setCity("杭州市");
obj7.setDetail("西溪园区");
obj7.setDistrict("余杭区");
obj7.setProvince("浙江省");
obj7.setTown("文一西路");
obj6.setAddress(obj7);
obj6.setMobile("132432323");
obj6.setName("Foo");
obj6.setPhone("05712323241");
obj6.setOaid("abcdefghijklmn");
obj6.setCaid("abcdefghijklmn");
obj1.setRecipient(obj6);
CainiaoWaybillIiInnerUpdateRequest.UserInfoDto obj8 = new CainiaoWaybillIiInnerUpdateRequest.UserInfoDto();
obj8.setMobile("1352353325");
obj8.setName("Foo");
obj8.setPhone("05714232523");
obj1.setSender(obj8);
obj1.setTemplateUrl("http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id=1001");
obj1.setWaybillCode("9890000160004");
obj1.setObjectId("x");
req.setParamWaybillCloudPrintUpdateRequest(obj1);
CainiaoWaybillIiInnerUpdateRequest.ClientInfoForTopDto obj9 = new CainiaoWaybillIiInnerUpdateRequest.ClientInfoForTopDto();
obj9.setAppName("waybill");
req.setParamClientInfoForTop(obj9);
CainiaoWaybillIiInnerUpdateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoWaybillIiInnerUpdateRequest req = new CainiaoWaybillIiInnerUpdateRequest();
req.SellerId = 3892269560L;
CainiaoWaybillIiInnerUpdateRequest.WaybillCloudPrintUpdateRequestDomain obj1 = new CainiaoWaybillIiInnerUpdateRequest.WaybillCloudPrintUpdateRequestDomain();
obj1.CpCode = "POSTB";
obj1.LogisticsServices = "{     \"SVC-COD\": {         \"value\": \"200\"     } }";
CainiaoWaybillIiInnerUpdateRequest.PackageInfoDtoDomain obj2 = new CainiaoWaybillIiInnerUpdateRequest.PackageInfoDtoDomain();
List<CainiaoWaybillIiInnerUpdateRequest.ItemDomain> list4 = new List<CainiaoWaybillIiInnerUpdateRequest.ItemDomain>();
CainiaoWaybillIiInnerUpdateRequest.ItemDomain obj5 = new CainiaoWaybillIiInnerUpdateRequest.ItemDomain();
list4.Add(obj5);
obj5.Count = 1L;
obj5.Name = "鞋子";
obj2.Items= list4;
obj2.Volume = 1L;
obj2.Weight = 1L;
obj1.PackageInfo= obj2;
CainiaoWaybillIiInnerUpdateRequest.UserInfoDtoDomain obj6 = new CainiaoWaybillIiInnerUpdateRequest.UserInfoDtoDomain();
CainiaoWaybillIiInnerUpdateRequest.AddressDtoDomain obj7 = new CainiaoWaybillIiInnerUpdateRequest.AddressDtoDomain();
obj7.City = "杭州市";
obj7.Detail = "西溪园区";
obj7.District = "余杭区";
obj7.Province = "浙江省";
obj7.Town = "文一西路";
obj6.Address= obj7;
obj6.Mobile = "132432323";
obj6.Name = "Foo";
obj6.Phone = "05712323241";
obj6.Oaid = "abcdefghijklmn";
obj6.Caid = "abcdefghijklmn";
obj1.Recipient= obj6;
CainiaoWaybillIiInnerUpdateRequest.UserInfoDtoDomain obj8 = new CainiaoWaybillIiInnerUpdateRequest.UserInfoDtoDomain();
obj8.Mobile = "1352353325";
obj8.Name = "Foo";
obj8.Phone = "05714232523";
obj1.Sender= obj8;
obj1.TemplateUrl = "http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id=1001";
obj1.WaybillCode = "9890000160004";
obj1.ObjectId = "x";
req.ParamWaybillCloudPrintUpdateRequest_ = obj1;
CainiaoWaybillIiInnerUpdateRequest.ClientInfoForTopDtoDomain obj9 = new CainiaoWaybillIiInnerUpdateRequest.ClientInfoForTopDtoDomain();
obj9.AppName = "waybill";
req.ParamClientInfoForTop_ = obj9;
CainiaoWaybillIiInnerUpdateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoWaybillIiInnerUpdateRequest;
$req->setSellerId("3892269560");
$param_waybill_cloud_print_update_request = new WaybillCloudPrintUpdateRequest;
$param_waybill_cloud_print_update_request->cp_code="POSTB";
$param_waybill_cloud_print_update_request->logistics_services="{     \"SVC-COD\": {         \"value\": \"200\"     } }";
$package_info = new PackageInfoDto;
$items = new Item;
$items->count="1";
$items->name="鞋子";
$package_info->items = $items;
$package_info->volume="1";
$package_info->weight="1";
$param_waybill_cloud_print_update_request->package_info = $package_info;
$recipient = new UserInfoDto;
$address = new AddressDto;
$address->city="杭州市";
$address->detail="西溪园区";
$address->district="余杭区";
$address->province="浙江省";
$address->town="文一西路";
$recipient->address = $address;
$recipient->mobile="132432323";
$recipient->name="Foo";
$recipient->phone="05712323241";
$recipient->oaid="abcdefghijklmn";
$recipient->caid="abcdefghijklmn";
$param_waybill_cloud_print_update_request->recipient = $recipient;
$sender = new UserInfoDto;
$sender->mobile="1352353325";
$sender->name="Foo";
$sender->phone="05714232523";
$param_waybill_cloud_print_update_request->sender = $sender;
$param_waybill_cloud_print_update_request->template_url="http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id=1001";
$param_waybill_cloud_print_update_request->waybill_code="9890000160004";
$param_waybill_cloud_print_update_request->object_id="x";
$req->setParamWaybillCloudPrintUpdateRequest(json_encode($param_waybill_cloud_print_update_request));
$param_client_info_for_top = new ClientInfoForTopDto;
$param_client_info_for_top->app_name="waybill";
$req->setParamClientInfoForTop(json_encode($param_client_info_for_top));
$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.waybill.ii.inner.update' \
-d 'partner_id=apidoc' \
-d 'sign=2D915FFF7DCA324E51CCE728B934FF3C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+14%3A09%3A43' \
-d 'v=2.0' \
-d 'param_client_info_for_top=null' \
-d 'param_waybill_cloud_print_update_request=null' \
-d 'seller_id=3892269560'

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

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

req.seller_id=3892269560
req.param_waybill_cloud_print_update_request=""
req.param_client_info_for_top=""
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.waybill.ii.inner.update");
add_param(pRequest,"seller_id","3892269560");
add_param(pRequest,"param_waybill_cloud_print_update_request","数据结构JSON示例");
add_param(pRequest,"param_client_info_for_top","数据结构JSON示例");
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.waybill.ii.inner.update', {
	'seller_id':'3892269560',
	'param_waybill_cloud_print_update_request':'数据结构JSON示例',
	'param_client_info_for_top':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_waybill_ii_inner_update_response>
    <print_data>x</print_data>
    <waybill_code>x</waybill_code>
</cainiao_waybill_ii_inner_update_response>

{
    "cainiao_waybill_ii_inner_update_response":{
        "print_data":"x",
        "waybill_code":"x"
    }
}

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"
	}
}

错误码	错误描述	解决方案
waybillcode is invalid or not exist	通过传入的快递公司编码和面单号，没能查询到面单存在记录。	查看入参是否错误。
package item count must be greate than zero	包裹商品数量必须大于零	检查入参
isp.QUERY_UNSHIPPED_DETAIL_BY_WAYBILL_CODE_AND_CP_ID_ERROR	未查询到面单信息	检查入参，确定面单是否合法
system default error	系统繁忙	联系电子面单开发
waybill service cannot open	该快递公司面单服务暂不开放	确定cpCode传的是否正确
province of consigneeAddress can not be null	收货人地址省份信息不能为空	检查入参
isp.operate db error	系统繁忙	联系电子面单开发
waybillCode can not be null	面单号为空	检查入参
isp.WAYBILL_APPLY_FULLUPDATE_ERROR	更新失败	联系电子面单开发同学
subscribe service not found	订购关系不存在	更新面单号时，要确保您和网点之间的订购关系还存续。
update doesnt allow add or remove logistics services	更新面单号时，不允许新增或删除物流服务，只能修改物流服务的属性。	如果需要新增或修改，请取消面单号后重新获取。
templateURL error	云打印模板传参错误	请使用合法的云打印模板url
phone of consignee too long	收件人电话超长	请检查入参
mobile of consignee too long	收件人手机号过长	请检查入参
consignee_address_province_too_long	收件人省份过长	请检查入参
cpcode or cpId can not both be null	快递公司编码不能为空	请检查入参
consignee_address_town_too_long	收件人地址街道部分过长	请检查入参
isv.oaid-invalid	无效的OAID	根据错误消息中的tid列表，调用taobao.trade.fullinfo.get获取最新的OAID。错误消息格式类似"参数oaid无效，tid:123,456,789"。

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

开放平台

电子面单API

cainiao.waybill.ii.inner.update (电子面单云打印更新接口（内部）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ