阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_real_owner_id	String	必须	13578343		在平台下单模式下，该笔订单的真正拥有者，比如某商家通过ISV下单，这里需要输入该商家的唯一标示。该字段必须输入，并且保证正确，否则在后面的处理过程中会出错。
order_real_owner_mobile	String	必须	13817747777		在平台下单模式下，该笔订单的真正拥有者的联系信息，在一些订单出现异常时，需要联系该订单的owner
order_real_contact_id	String	可选	13578343	默认值：13578343	订单的联系人信息，比如订单出现异常时，菜鸟平台跟哪个联系人联系。该字段的场景是： * ISV代替某一个商家账号(该商家账号可能是商家的BOSS)进行下单，当订单出现异常时，可以联系商家的客服支持人员
order_real_contact_mobile	String	可选	13817747777	默认值：13817747777	订单的联系人信息，比如订单出现异常时，菜鸟平台跟哪个联系人联系。ISV代替某一个商家账号(该商家账号可能是商家的BOSS)进行下单，当订单出现异常时，可以联系商家的客服支持人员；如果该信息没有填写，则会采用order_real_owner_mobile的信息
param_list	GuoGuoPackageInfo []	必须		最大列表长度：30	寄件列表，一次最多30个
└ item_title String 必须华为手机商品的名称 └ package_id String 必须包裹号该下单批次中，唯一的ID receiver BusinessCustomer 可选收件人信息 └ area_id String 必须 311200 收件人的区号 └ full_address_detail String 必须浙江省杭州市网商路699号收件人的详细地址，必须携带省市区 └ mobile String 必须 13817747777 收件人的联系方式 └ name String 必须张三收件人姓名 sender BusinessCustomer 必须寄件人的信息 └ area_id String 必须 311200 寄件人的区号 └ full_address_detail String 必须浙江省杭州市网商路966号寄件人的详细地址，必须携带省市区 └ mobile String 必须 13817747777 寄件人的联系方式 └ name String 必须李四寄件人的姓名 └ weight Number 可选 1000 包裹预估重量 └ coupon_id String 可选 1000 优惠券ID
param_business_property	BusinessProperty	必须			业务控制信息
└ print_by_owner Boolean 可选 false 面单是否由用户自己打印，如果该值设置为true，则面单由商家自己打印；如果该值设置为false，则面单由小件员上门时打印。如果不填写，则意味由小件员上门打印 └ privacy_on Boolean 可选 false 是否采用隐私寄件功能，如果采用隐私寄件，则会对一些敏感信息在面单上隐藏 value_services ValueService [] 可选增值服务 └ value String 可选 yes 增值服务值 └ key String 可选 gift_package 增值服务类型

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	下单结果
data_list TdInterResult [] [] 下单结果 data CreateOrderResponse {} 下单结果 └ check_package_code String 1356 对货码 └ print_data String {} 电子面单加密信息 └ got_code String 13579 取件码 └ td_order_id Number 323123123123123123 裹裹订单编号 └ mail_no String 123123123123123 运单号（对总取号不为空，对私取号为空） └ cp_code String 123123123 运单号的cpCode courier_info CourierInfo {} 返回对象 └ name String 张三小件员名称 └ cp_name String 韵达快递小件员所在公司 └ phone_number String 13817747777 小件员手机号 └ identity String 1111111111 批量查询时会有区分每个独立个体的标识，如裹裹订单id、运单号等 └ status_message String 系统错误错误信息 └ status_code String error 错误code └ success Boolean true 是否成功 └ retry Boolean false 是否重试 └ status_code String error 错误code └ status_message String 系统错误错误信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessPlatformCallguoguoRequest req = new CainiaoPickupBusinessPlatformCallguoguoRequest();
req.setOrderRealOwnerId("13578343");
req.setOrderRealOwnerMobile("13817747777");
req.setOrderRealContactId("13578343");
req.setOrderRealContactMobile("13817747777");
List<CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfo> list2 = new ArrayList<CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfo>();
CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfo obj3 = new CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfo();
list2.add(obj3);
obj3.setItemTitle("华为手机");
obj3.setPackageId("包裹号");
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomer obj5 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomer();
obj5.setAreaId("311200");
obj5.setFullAddressDetail("浙江省杭州市网商路699号");
obj5.setMobile("13817747777");
obj5.setName("张三");
list4.setReceiver(obj5);
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomer obj7 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomer();
obj7.setAreaId("311200");
obj7.setFullAddressDetail("浙江省杭州市网商路966号");
obj7.setMobile("13817747777");
obj7.setName("李四");
list6.setSender(obj7);
obj3.setWeight(1000L);
obj3.setCouponId("1000");
req.setParamList(list2);
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessProperty obj8 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessProperty();
obj8.setPrintByOwner(false);
obj8.setPrivacyOn(false);
List<CainiaoPickupBusinessPlatformCallguoguoRequest.ValueService> list10 = new ArrayList<CainiaoPickupBusinessPlatformCallguoguoRequest.ValueService>();
CainiaoPickupBusinessPlatformCallguoguoRequest.ValueService obj11 = new CainiaoPickupBusinessPlatformCallguoguoRequest.ValueService();
list10.add(obj11);
obj11.setValue("yes");
obj11.setKey("gift_package");
obj8.setValueServices(list10);
req.setParamBusinessProperty(obj8);
CainiaoPickupBusinessPlatformCallguoguoResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessPlatformCallguoguoRequest req = new CainiaoPickupBusinessPlatformCallguoguoRequest();
req.OrderRealOwnerId = "13578343";
req.OrderRealOwnerMobile = "13817747777";
req.OrderRealContactId = "13578343";
req.OrderRealContactMobile = "13817747777";
List<CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfoDomain> list2 = new List<CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfoDomain>();
CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfoDomain obj3 = new CainiaoPickupBusinessPlatformCallguoguoRequest.GuoGuoPackageInfoDomain();
list2.Add(obj3);
obj3.ItemTitle = "华为手机";
obj3.PackageId = "包裹号";
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomerDomain obj4 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomerDomain();
obj4.AreaId = "311200";
obj4.FullAddressDetail = "浙江省杭州市网商路699号";
obj4.Mobile = "13817747777";
obj4.Name = "张三";
obj3.Receiver= obj4;
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomerDomain obj5 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessCustomerDomain();
obj5.AreaId = "311200";
obj5.FullAddressDetail = "浙江省杭州市网商路966号";
obj5.Mobile = "13817747777";
obj5.Name = "李四";
obj3.Sender= obj5;
obj3.Weight = 1000L;
obj3.CouponId = "1000";
req.ParamList_ = list2;
CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessPropertyDomain obj6 = new CainiaoPickupBusinessPlatformCallguoguoRequest.BusinessPropertyDomain();
obj6.PrintByOwner = false;
obj6.PrivacyOn = false;
List<CainiaoPickupBusinessPlatformCallguoguoRequest.ValueServiceDomain> list8 = new List<CainiaoPickupBusinessPlatformCallguoguoRequest.ValueServiceDomain>();
CainiaoPickupBusinessPlatformCallguoguoRequest.ValueServiceDomain obj9 = new CainiaoPickupBusinessPlatformCallguoguoRequest.ValueServiceDomain();
list8.Add(obj9);
obj9.Value = "yes";
obj9.Key = "gift_package";
obj6.ValueServices= list8;
req.ParamBusinessProperty_ = obj6;
CainiaoPickupBusinessPlatformCallguoguoResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessPlatformCallguoguoRequest;
$req->setOrderRealOwnerId("13578343");
$req->setOrderRealOwnerMobile("13817747777");
$req->setOrderRealContactId("13578343");
$req->setOrderRealContactMobile("13817747777");
$param_list = new GuoGuoPackageInfo;
$param_list->item_title="华为手机";
$param_list->package_id="包裹号";
$receiver = new BusinessCustomer;
$receiver->area_id="311200";
$receiver->full_address_detail="浙江省杭州市网商路699号";
$receiver->mobile="13817747777";
$receiver->name="张三";
$param_list->receiver = $receiver;
$sender = new BusinessCustomer;
$sender->area_id="311200";
$sender->full_address_detail="浙江省杭州市网商路966号";
$sender->mobile="13817747777";
$sender->name="李四";
$param_list->sender = $sender;
$param_list->weight="1000";
$param_list->coupon_id="1000";
$req->setParamList(json_encode($param_list));
$param_business_property = new BusinessProperty;
$param_business_property->print_by_owner="false";
$param_business_property->privacy_on="false";
$value_services = new ValueService;
$value_services->value="yes";
$value_services->key="gift_package";
$param_business_property->value_services = $value_services;
$req->setParamBusinessProperty(json_encode($param_business_property));
$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.platform.callguoguo' \
-d 'partner_id=apidoc' \
-d 'session=0d11cfd4-603c-4ba2-b672-a1d8b8037c71' \
-d 'sign=502DF76CB47A633385A35B171BE1DA0A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+10%3A12%3A20' \
-d 'v=2.0' \
-d 'order_real_contact_id=13578343' \
-d 'order_real_contact_mobile=13817747777' \
-d 'order_real_owner_id=13578343' \
-d 'order_real_owner_mobile=13817747777' \
-d 'param_business_property=null' \
-d 'param_list=null'

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

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

req.order_real_owner_id="13578343"
req.order_real_owner_mobile="13817747777"
req.order_real_contact_id="13578343"
req.order_real_contact_mobile="13817747777"
req.param_list=""
req.param_business_property=""
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.platform.callguoguo");
add_param(pRequest,"order_real_owner_id","13578343");
add_param(pRequest,"order_real_owner_mobile","13817747777");
add_param(pRequest,"order_real_contact_id","13578343");
add_param(pRequest,"order_real_contact_mobile","13817747777");
add_param(pRequest,"param_list","数据结构JSON示例");
add_param(pRequest,"param_business_property","数据结构JSON示例");
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.platform.callguoguo', {
	'order_real_owner_id':'13578343',
	'order_real_owner_mobile':'13817747777',
	'order_real_contact_id':'13578343',
	'order_real_contact_mobile':'13817747777',
	'param_list':'数据结构JSON示例',
	'param_business_property':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_platform_callguoguo_response>
    <result>
        <data_list>
            <td_inter_result>
                <data>
                    <check_package_code>1356</check_package_code>
                    <print_data>{}</print_data>
                    <got_code>13579</got_code>
                    <td_order_id>323123123123123123</td_order_id>
                    <mail_no>123123123123123</mail_no>
                    <cp_code>123123123</cp_code>
                    <courier_info>
                        <name>张三</name>
                        <cp_name>韵达快递</cp_name>
                        <phone_number>13817747777</phone_number>
                    </courier_info>
                </data>
                <identity>1111111111</identity>
                <status_message>系统错误</status_message>
                <status_code>error</status_code>
                <success>true</success>
            </td_inter_result>
        </data_list>
        <retry>false</retry>
        <status_code>error</status_code>
        <status_message>系统错误</status_message>
        <success>true</success>
    </result>
</cainiao_pickup_business_platform_callguoguo_response>

{
    "cainiao_pickup_business_platform_callguoguo_response":{
        "result":{
            "data_list":{
                "td_inter_result":[
                    {
                        "data":{
                            "check_package_code":"1356",
                            "print_data":"{}",
                            "got_code":"13579",
                            "td_order_id":323123123123123123,
                            "mail_no":"123123123123123",
                            "cp_code":"123123123",
                            "courier_info":{
                                "name":"张三",
                                "cp_name":"韵达快递",
                                "phone_number":"13817747777"
                            }
                        },
                        "identity":"1111111111",
                        "status_message":"系统错误",
                        "status_code":"error",
                        "success":true
                    }
                ]
            },
            "retry":false,
            "status_code":"error",
            "status_message":"系统错误",
            "success":true
        }
    }
}

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.pickup.business.platform.callguoguo (菜鸟商家寄件代理下寄件单并呼叫裹裹运力)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈