淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
biz_type	String	可选	GuoGuoSMB	默认值：GuoGuoSMB	业务场景
mobile	String	可选	13777777777		电话
guo_guo_package_info	GuoGuoPackageInfo []	必须		最大列表长度：30	包裹信息，最多传30个
└ item_id String 可选 3000000083 服务商品 receiver BusinessCustomer 必须收件人 └ area_id String 可选 300100 地址码 └ full_address_detail String 必须浙江省杭州市西湖区西溪首座小邮局详细地址 └ name String 必须张三姓名 └ mobile String 必须 1555555555 电话 encrypted_customer_info EncryptedCustomerInfo 可选淘宝加密字段（如果无法取到明文的收件人信息，可以本字段代替，否则勿使用本字段。若本字段下属2个字段都不为空，则取解密后的地址为收件人地址。否则此字段无效，依然取上面的full_address_detail等信息为收件人信息。若下属2个字段都不为空但有误，会下单失败） └ taobao_order_id String 可选 123 淘宝订单ID └ oaid String 可选 adqeq34 淘宝加密后的收件人信息ID └ item_title String 必须华为手机商品名称 sender BusinessCustomer 必须寄件人 └ area_id String 可选 300100 地址码 └ full_address_detail String 必须浙江省杭州市西湖区西溪首座小邮局地址 └ name String 必须李四姓名 └ mobile String 必须 199999999 电话 └ package_id String 必须 13321 包裹订单号 └ weight Number 可选 1000 重量：克
store_name	String	可选	门店名称		门店名称
store_id	String	可选	1		门店id
can_print	Boolean	可选	false	默认值：false	商家是否有打印能力
privacy_on	Boolean	可选	false	默认值：false	是否采用隐私寄件
value_services	ValueService []	可选		最大列表长度：999	扩展字段，暂时先不要用
└ value String 可选 yes 增值服务值 └ key String 可选 gift_package 增值服务类型

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data_list TdInterResult [] {} 返回对象 data CreateOrderResponseV2 {} 返回对象 └ cp_code String YUNDA cpCode └ mail_no String 4303703525933 运单号 └ td_order_id String 2111280025266095 菜鸟订单号 └ got_code String 1316 取件码 └ print_data String sss 加密后的电子面单信息 └ check_package_code String 2 对货码 courier_info CourierInfo {} 小件员信息 └ phone_number String 95546 电话 └ cp_name String 韵达快递 cp名称 └ name String 菜鸟指定快递员姓名 └ success Boolean true 是否成功 └ identity String 11111xxx 包裹订单号 └ status_message String 系统错误错误描述 └ status_code String SYS_ERROIR 错误码 └ 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);
CainiaoPickupBusinessCallguoguoRequest req = new CainiaoPickupBusinessCallguoguoRequest();
req.setBizType("GuoGuoSMB");
req.setMobile("13777777777");
List<CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfo> list2 = new ArrayList<CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfo>();
CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfo obj3 = new CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfo();
list2.add(obj3);
obj3.setItemId("3000000083");
CainiaoPickupBusinessCallguoguoRequest.BusinessCustomer obj5 = new CainiaoPickupBusinessCallguoguoRequest.BusinessCustomer();
obj5.setAreaId("300100");
obj5.setFullAddressDetail("浙江省杭州市西湖区西溪首座小邮局");
obj5.setName("张三");
obj5.setMobile("1555555555");
CainiaoPickupBusinessCallguoguoRequest.EncryptedCustomerInfo obj6 = new CainiaoPickupBusinessCallguoguoRequest.EncryptedCustomerInfo();
obj6.setTaobaoOrderId("123");
obj6.setOaid("adqeq34");
obj5.setEncryptedCustomerInfo(obj6);
list4.setReceiver(obj5);
obj3.setItemTitle("华为手机");
CainiaoPickupBusinessCallguoguoRequest.BusinessCustomer obj8 = new CainiaoPickupBusinessCallguoguoRequest.BusinessCustomer();
obj8.setAreaId("300100");
obj8.setFullAddressDetail("浙江省杭州市西湖区西溪首座小邮局");
obj8.setName("李四");
obj8.setMobile("199999999");
list7.setSender(obj8);
obj3.setPackageId("13321");
obj3.setWeight(1000L);
req.setGuoGuoPackageInfo(list2);
req.setStoreName("门店名称");
req.setStoreId("1");
req.setCanPrint(false);
req.setPrivacyOn(false);
List<CainiaoPickupBusinessCallguoguoRequest.ValueService> list10 = new ArrayList<CainiaoPickupBusinessCallguoguoRequest.ValueService>();
CainiaoPickupBusinessCallguoguoRequest.ValueService obj11 = new CainiaoPickupBusinessCallguoguoRequest.ValueService();
list10.add(obj11);
obj11.setValue("yes");
obj11.setKey("gift_package");
req.setValueServices(list10);
CainiaoPickupBusinessCallguoguoResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessCallguoguoRequest req = new CainiaoPickupBusinessCallguoguoRequest();
req.BizType = "GuoGuoSMB";
req.Mobile = "13777777777";
List<CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfoDomain> list2 = new List<CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfoDomain>();
CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfoDomain obj3 = new CainiaoPickupBusinessCallguoguoRequest.GuoGuoPackageInfoDomain();
list2.Add(obj3);
obj3.ItemId = "3000000083";
CainiaoPickupBusinessCallguoguoRequest.BusinessCustomerDomain obj4 = new CainiaoPickupBusinessCallguoguoRequest.BusinessCustomerDomain();
obj4.AreaId = "300100";
obj4.FullAddressDetail = "浙江省杭州市西湖区西溪首座小邮局";
obj4.Name = "张三";
obj4.Mobile = "1555555555";
CainiaoPickupBusinessCallguoguoRequest.EncryptedCustomerInfoDomain obj5 = new CainiaoPickupBusinessCallguoguoRequest.EncryptedCustomerInfoDomain();
obj5.TaobaoOrderId = "123";
obj5.Oaid = "adqeq34";
obj4.EncryptedCustomerInfo= obj5;
obj3.Receiver= obj4;
obj3.ItemTitle = "华为手机";
CainiaoPickupBusinessCallguoguoRequest.BusinessCustomerDomain obj6 = new CainiaoPickupBusinessCallguoguoRequest.BusinessCustomerDomain();
obj6.AreaId = "300100";
obj6.FullAddressDetail = "浙江省杭州市西湖区西溪首座小邮局";
obj6.Name = "李四";
obj6.Mobile = "199999999";
obj3.Sender= obj6;
obj3.PackageId = "13321";
obj3.Weight = 1000L;
req.GuoGuoPackageInfo_ = list2;
req.StoreName = "门店名称";
req.StoreId = "1";
req.CanPrint = false;
req.PrivacyOn = false;
List<CainiaoPickupBusinessCallguoguoRequest.ValueServiceDomain> list8 = new List<CainiaoPickupBusinessCallguoguoRequest.ValueServiceDomain>();
CainiaoPickupBusinessCallguoguoRequest.ValueServiceDomain obj9 = new CainiaoPickupBusinessCallguoguoRequest.ValueServiceDomain();
list8.Add(obj9);
obj9.Value = "yes";
obj9.Key = "gift_package";
req.ValueServices_ = list8;
CainiaoPickupBusinessCallguoguoResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessCallguoguoRequest;
$req->setBizType("GuoGuoSMB");
$req->setMobile("13777777777");
$guo_guo_package_info = new GuoGuoPackageInfo;
$guo_guo_package_info->item_id="3000000083";
$receiver = new BusinessCustomer;
$receiver->area_id="300100";
$receiver->full_address_detail="浙江省杭州市西湖区西溪首座小邮局";
$receiver->name="张三";
$receiver->mobile="1555555555";
$encrypted_customer_info = new EncryptedCustomerInfo;
$encrypted_customer_info->taobao_order_id="123";
$encrypted_customer_info->oaid="adqeq34";
$receiver->encrypted_customer_info = $encrypted_customer_info;
$guo_guo_package_info->receiver = $receiver;
$guo_guo_package_info->item_title="华为手机";
$sender = new BusinessCustomer;
$sender->area_id="300100";
$sender->full_address_detail="浙江省杭州市西湖区西溪首座小邮局";
$sender->name="李四";
$sender->mobile="199999999";
$guo_guo_package_info->sender = $sender;
$guo_guo_package_info->package_id="13321";
$guo_guo_package_info->weight="1000";
$req->setGuoGuoPackageInfo(json_encode($guo_guo_package_info));
$req->setStoreName("门店名称");
$req->setStoreId("1");
$req->setCanPrint("false");
$req->setPrivacyOn("false");
$value_services = new ValueService;
$value_services->value="yes";
$value_services->key="gift_package";
$req->setValueServices(json_encode($value_services));
$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.callguoguo' \
-d 'partner_id=apidoc' \
-d 'session=ce680884-e56a-4203-b902-72121b2a0914' \
-d 'sign=AC7B105DDEF86082DE5BC90C41B81ACC' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+16%3A41%3A28' \
-d 'v=2.0' \
-d 'biz_type=GuoGuoSMB' \
-d 'can_print=false' \
-d 'guo_guo_package_info=null' \
-d 'mobile=13777777777' \
-d 'privacy_on=false' \
-d 'store_id=1' \
-d 'store_name=%E9%97%A8%E5%BA%97%E5%90%8D%E7%A7%B0' \
-d 'value_services=null'

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

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

req.biz_type="GuoGuoSMB"
req.mobile="13777777777"
req.guo_guo_package_info=""
req.store_name="门店名称"
req.store_id="1"
req.can_print=false
req.privacy_on=false
req.value_services=""
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.callguoguo");
add_param(pRequest,"biz_type","GuoGuoSMB");
add_param(pRequest,"mobile","13777777777");
add_param(pRequest,"guo_guo_package_info","数据结构JSON示例");
add_param(pRequest,"store_name","门店名称");
add_param(pRequest,"store_id","1");
add_param(pRequest,"can_print","false");
add_param(pRequest,"privacy_on","false");
add_param(pRequest,"value_services","数据结构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.callguoguo', {
	'biz_type':'GuoGuoSMB',
	'mobile':'13777777777',
	'guo_guo_package_info':'数据结构JSON示例',
	'store_name':'门店名称',
	'store_id':'1',
	'can_print':'false',
	'privacy_on':'false',
	'value_services':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_callguoguo_response>
    <result>
        <data_list>
            <td_inter_result>
                <data>
                    <cp_code>YUNDA</cp_code>
                    <mail_no>4303703525933</mail_no>
                    <td_order_id>2111280025266095</td_order_id>
                    <got_code>1316</got_code>
                    <print_data>sss</print_data>
                    <check_package_code>2</check_package_code>
                    <courier_info>
                        <phone_number>95546</phone_number>
                        <cp_name>韵达快递</cp_name>
                        <name>菜鸟指定快递员</name>
                    </courier_info>
                </data>
                <success>true</success>
                <identity>11111xxx</identity>
                <status_message>系统错误</status_message>
                <status_code>SYS_ERROIR</status_code>
            </td_inter_result>
        </data_list>
        <success>true</success>
        <retry>false</retry>
        <status_message>系统错误</status_message>
        <status_code>SYS_ERROIR</status_code>
    </result>
</cainiao_pickup_business_callguoguo_response>

{
    "cainiao_pickup_business_callguoguo_response":{
        "result":{
            "data_list":{
                "td_inter_result":[
                    {
                        "data":{
                            "cp_code":"YUNDA",
                            "mail_no":"4303703525933",
                            "td_order_id":"2111280025266095",
                            "got_code":"1316",
                            "print_data":"sss",
                            "check_package_code":"2",
                            "courier_info":{
                                "phone_number":"95546",
                                "cp_name":"韵达快递",
                                "name":"菜鸟指定快递员"
                            }
                        },
                        "success":true,
                        "identity":"11111xxx",
                        "status_message":"系统错误",
                        "status_code":"SYS_ERROIR"
                    }
                ]
            },
            "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测试工具错误码查询工具 SDK下载

物流API

cainiao.pickup.business.callguoguo (菜鸟商家寄件下单并呼叫裹裹运力)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ