淘宝开放平台

请求地址：

环境	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	可选	13788889999		商家联系方式
guo_guo_package_info_list	GuoGuoPackageInfo []	必须		最大列表长度：20	需要下单的订单详情
└ item_id String 可选 138_small_b 服务商品id，不填时按照菜鸟内部规则路由 receiver BusinessCustomer 必须收件人信息 └ area_id String 可选 330100 地址库编码，可不填 └ full_address_detail String 必须浙江省杭州市西湖区文一西路西溪首座小邮局地址详情 └ name String 必须张三姓名 └ mobile String 必须 15677777777 电话 └ item_title String 必须毛巾包裹内容名称 sender BusinessCustomer 必须寄件人信息 └ area_id String 可选 330100 地址库编码，可不填 └ full_address_detail String 必须浙江省杭州市西湖区文一西路西溪首座小邮局地址详情 └ name String 必须张三姓名 └ mobile String 必须 15677777777 电话 └ package_id String 必须 2417711425ppp 需要外部保证订单号不重复，否则下单会被幂等 └ weight Number 可选 1000 包裹预计重量，单位：克
store_name	String	可选	三福西溪银泰店		商家可能会有很多个店铺。可以不填
store_id	String	可选	233		商家自己给店铺的id，可不填
can_print	Boolean	可选	false	默认值：false	商家是否自己具备打印能力。false代表商家无打印能力，需要小件员打印

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data_list TdInterResult [] [] 返回列表 data CreateOrderResponse {} 批量下单，单个下单结果 └ mail_no String 4303682041232 运单号 └ cp_code String YUNDA cpCode └ td_order_id Number 2093611542817215 裹裹寄件单号 └ got_code String 9765 取件码 └ package_id String 2417711425ppp 下单时传进来标识包裹的订单号，在包裹中返回 └ print_data String 1234567 电子面单加密信息 └ check_package_code String 2 对货码 courier_info CourierInfo demo 小件员信息 └ cp_code String YUNDA 小件员所属Cp └ cp_name String 韵达快递公司名称 └ phone_number String 13788888888 小件员电话 └ name String 李四小件员姓名 └ courier_type String 小件员类型全职/兼职 └ success Boolean true 单个订单是否下单成功 └ identity String 2093611542817215 这是外部传进来的用于下单的单号 └ status_message String 业务异常错误描述 └ status_code String Business_error 错误码 └ success Boolean true 是否操作成功 └ status_message String 系统错误错误描述，如果不能使用服务，会在这里提示错误信息 └ retry Boolean false 是否需要重试 └ status_code String SYS_ERROIR 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessOrderCreateRequest req = new CainiaoPickupBusinessOrderCreateRequest();
req.setBizType("GuoGuoSMB");
req.setMobile("13788889999");
List<CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfo> list2 = new ArrayList<CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfo>();
CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfo obj3 = new CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfo();
list2.add(obj3);
obj3.setItemId("138_small_b");
CainiaoPickupBusinessOrderCreateRequest.BusinessCustomer obj5 = new CainiaoPickupBusinessOrderCreateRequest.BusinessCustomer();
obj5.setAreaId("330100");
obj5.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
obj5.setName("张三");
obj5.setMobile("15677777777");
list4.setReceiver(obj5);
obj3.setItemTitle("毛巾");
CainiaoPickupBusinessOrderCreateRequest.BusinessCustomer obj7 = new CainiaoPickupBusinessOrderCreateRequest.BusinessCustomer();
obj7.setAreaId("330100");
obj7.setFullAddressDetail("浙江省杭州市西湖区文一西路西溪首座小邮局");
obj7.setName("张三");
obj7.setMobile("15677777777");
list6.setSender(obj7);
obj3.setPackageId("2417711425ppp");
obj3.setWeight(1000L);
req.setGuoGuoPackageInfoList(list2);
req.setStoreName("三福西溪银泰店");
req.setStoreId("233");
req.setCanPrint(false);
CainiaoPickupBusinessOrderCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessOrderCreateRequest req = new CainiaoPickupBusinessOrderCreateRequest();
req.BizType = "GuoGuoSMB";
req.Mobile = "13788889999";
List<CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfoDomain> list2 = new List<CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfoDomain>();
CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfoDomain obj3 = new CainiaoPickupBusinessOrderCreateRequest.GuoGuoPackageInfoDomain();
list2.Add(obj3);
obj3.ItemId = "138_small_b";
CainiaoPickupBusinessOrderCreateRequest.BusinessCustomerDomain obj4 = new CainiaoPickupBusinessOrderCreateRequest.BusinessCustomerDomain();
obj4.AreaId = "330100";
obj4.FullAddressDetail = "浙江省杭州市西湖区文一西路西溪首座小邮局";
obj4.Name = "张三";
obj4.Mobile = "15677777777";
obj3.Receiver= obj4;
obj3.ItemTitle = "毛巾";
CainiaoPickupBusinessOrderCreateRequest.BusinessCustomerDomain obj5 = new CainiaoPickupBusinessOrderCreateRequest.BusinessCustomerDomain();
obj5.AreaId = "330100";
obj5.FullAddressDetail = "浙江省杭州市西湖区文一西路西溪首座小邮局";
obj5.Name = "张三";
obj5.Mobile = "15677777777";
obj3.Sender= obj5;
obj3.PackageId = "2417711425ppp";
obj3.Weight = 1000L;
req.GuoGuoPackageInfoList_ = list2;
req.StoreName = "三福西溪银泰店";
req.StoreId = "233";
req.CanPrint = false;
CainiaoPickupBusinessOrderCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessOrderCreateRequest;
$req->setBizType("GuoGuoSMB");
$req->setMobile("13788889999");
$guo_guo_package_info_list = new GuoGuoPackageInfo;
$guo_guo_package_info_list->item_id="138_small_b";
$receiver = new BusinessCustomer;
$receiver->area_id="330100";
$receiver->full_address_detail="浙江省杭州市西湖区文一西路西溪首座小邮局";
$receiver->name="张三";
$receiver->mobile="15677777777";
$guo_guo_package_info_list->receiver = $receiver;
$guo_guo_package_info_list->item_title="毛巾";
$sender = new BusinessCustomer;
$sender->area_id="330100";
$sender->full_address_detail="浙江省杭州市西湖区文一西路西溪首座小邮局";
$sender->name="张三";
$sender->mobile="15677777777";
$guo_guo_package_info_list->sender = $sender;
$guo_guo_package_info_list->package_id="2417711425ppp";
$guo_guo_package_info_list->weight="1000";
$req->setGuoGuoPackageInfoList(json_encode($guo_guo_package_info_list));
$req->setStoreName("三福西溪银泰店");
$req->setStoreId("233");
$req->setCanPrint("false");
$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.order.create' \
-d 'partner_id=apidoc' \
-d 'session=0d48ce9d-cc83-431d-a8a8-65f1741f23be' \
-d 'sign=141A881E853D97AB5CEAB52DAB39464A' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+18%3A51%3A37' \
-d 'v=2.0' \
-d 'biz_type=GuoGuoSMB' \
-d 'can_print=false' \
-d 'guo_guo_package_info_list=null' \
-d 'mobile=13788889999' \
-d 'store_id=233' \
-d 'store_name=%E4%B8%89%E7%A6%8F%E8%A5%BF%E6%BA%AA%E9%93%B6%E6%B3%B0%E5%BA%97'

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

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

req.biz_type="GuoGuoSMB"
req.mobile="13788889999"
req.guo_guo_package_info_list=""
req.store_name="三福西溪银泰店"
req.store_id="233"
req.can_print=false
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.order.create");
add_param(pRequest,"biz_type","GuoGuoSMB");
add_param(pRequest,"mobile","13788889999");
add_param(pRequest,"guo_guo_package_info_list","数据结构JSON示例");
add_param(pRequest,"store_name","三福西溪银泰店");
add_param(pRequest,"store_id","233");
add_param(pRequest,"can_print","false");
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.order.create', {
	'biz_type':'GuoGuoSMB',
	'mobile':'13788889999',
	'guo_guo_package_info_list':'数据结构JSON示例',
	'store_name':'三福西溪银泰店',
	'store_id':'233',
	'can_print':'false'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_order_create_response>
    <result>
        <data_list>
            <td_inter_result>
                <data>
                    <mail_no>4303682041232</mail_no>
                    <cp_code>YUNDA</cp_code>
                    <td_order_id>2093611542817215</td_order_id>
                    <got_code>9765</got_code>
                    <package_id>2417711425ppp</package_id>
                    <print_data>1234567</print_data>
                    <check_package_code>2</check_package_code>
                    <courier_info>
                        <cp_code>YUNDA</cp_code>
                        <cp_name>韵达</cp_name>
                        <phone_number>13788888888</phone_number>
                        <name>李四</name>
                        <courier_type>小件员类型</courier_type>
                    </courier_info>
                </data>
                <success>true</success>
                <identity>2093611542817215</identity>
                <status_message>业务异常</status_message>
                <status_code>Business_error</status_code>
            </td_inter_result>
        </data_list>
        <success>true</success>
        <status_message>系统错误</status_message>
        <retry>false</retry>
        <status_code>SYS_ERROIR</status_code>
    </result>
</cainiao_pickup_business_order_create_response>

{
    "cainiao_pickup_business_order_create_response":{
        "result":{
            "data_list":{
                "td_inter_result":[
                    {
                        "data":{
                            "mail_no":"4303682041232",
                            "cp_code":"YUNDA",
                            "td_order_id":2093611542817215,
                            "got_code":"9765",
                            "package_id":"2417711425ppp",
                            "print_data":"1234567",
                            "check_package_code":"2",
                            "courier_info":{
                                "cp_code":"YUNDA",
                                "cp_name":"韵达",
                                "phone_number":"13788888888",
                                "name":"李四",
                                "courier_type":"小件员类型"
                            }
                        },
                        "success":true,
                        "identity":"2093611542817215",
                        "status_message":"业务异常",
                        "status_code":"Business_error"
                    }
                ]
            },
            "success":true,
            "status_message":"系统错误",
            "retry":false,
            "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.order.create (菜鸟商家寄件下单(不发货))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ