淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	String	必须	1	下单用户userid
order_id	String	必须	1	订单ID
open_id	String	必须	1	小件员openId
session_code	String	必须	1	小件员session
mail_no	String	必须	1	揽件号
cp_code	String	必须	1	CPCode

名称	类型	示例值	描述
data	ResponseDto	{}	响应信息
└ error_code String demo 错误码 └ error_msg String demo 错误信息 order_info OrderInfo {} 订单信息 └ added_price String demo 用户加价 └ apply_order_time Date 2015-11-27 15:47:23 抢单时间 └ create_time Date 2015-11-27 15:47:23 创建时间 └ has_finished Boolean false 订单是否已完成 └ order_id String demo 订单号 order_service_info OrderServiceInfo 服务信息 └ remark String demo 备注 └ service_id Number 123 服务id └ service_name String demo 服务名 └ service_price String demo 价钱 └ service_show_title String demo 标题 └ service_time String demo 时间 └ service_type String demo 类型 └ order_status Number demo 订单状态 └ order_status_desc String demo 订单状态描述 └ order_type Number demo 订单类型 └ package_cp_name String demo 包裹承运CP名称 └ package_detail String demo 包裹详细描述 └ package_image_url String demo 包裹相关的图片地址 └ package_mail_no String demo 包裹运单号 └ package_type String demo 包裹类型 └ pay_state Number 123 支付状态 └ price String 123 价钱 └ punishment String demo 菜鸟惩罚 └ real_price String demo 订单真实价格 receiver CustomInfo 接收者 └ address String demo 地址 └ area_id String demo 区域id └ area_name String demo 区 └ avatar_url String demo 头像 └ city_name String demo 市 └ name String demo 名字 └ phone String demo 手机号 └ prov_name String demo 省 └ zip_code String demo 邮编 └ receiver_address String demo 收件人地址 └ receiver_area String demo 收件人区域id └ reward String demo 补贴 └ reward_desc String demo 补贴原因 sender CustomInfo 寄件人 └ address String demo 地址 └ area_id String demo 区域id └ area_name String demo 区 └ avatar_url String demo 头像 └ city_name String demo 市 └ name String demo 寄件人名字 └ phone String demo 手机号 └ prov_name String demo 省 └ zip_code String demo 邮编 └ sender_id String id 发件人id └ source_address String demo 地址 └ submit_mailno_time Date 2015-11-27 15:47:23 回传运单时间 └ take_package_time Date 2015-11-27 15:47:23 取件时间 └ time_type Number 123 时间类型 0 代表承诺半小时, 1代表承诺两小时 └ user_id String demo 用户id └ show_reward Boolean true 是否显示补贴 └ success Boolean false 成功与否
is_success	Boolean	true	成功与否

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoGraborderSubmitmailnowithcpcodeRequest req = new CainiaoGuoguoGraborderSubmitmailnowithcpcodeRequest();
req.setUserId("1");
req.setOrderId("1");
req.setOpenId("1");
req.setSessionCode("1");
req.setMailNo("1");
req.setCpCode("1");
CainiaoGuoguoGraborderSubmitmailnowithcpcodeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoGraborderSubmitmailnowithcpcodeRequest req = new CainiaoGuoguoGraborderSubmitmailnowithcpcodeRequest();
req.UserId = "1";
req.OrderId = "1";
req.OpenId = "1";
req.SessionCode = "1";
req.MailNo = "1";
req.CpCode = "1";
CainiaoGuoguoGraborderSubmitmailnowithcpcodeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoGraborderSubmitmailnowithcpcodeRequest;
$req->setUserId("1");
$req->setOrderId("1");
$req->setOpenId("1");
$req->setSessionCode("1");
$req->setMailNo("1");
$req->setCpCode("1");
$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.graborder.submitmailnowithcpcode' \
-d 'partner_id=apidoc' \
-d 'sign=558C833261AFAE6AA7994B251A8F48C8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A54%3A00' \
-d 'v=2.0' \
-d 'cp_code=1' \
-d 'mail_no=1' \
-d 'open_id=1' \
-d 'order_id=1' \
-d 'session_code=1' \
-d 'user_id=1'

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

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

req.user_id="1"
req.order_id="1"
req.open_id="1"
req.session_code="1"
req.mail_no="1"
req.cp_code="1"
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.graborder.submitmailnowithcpcode");
add_param(pRequest,"user_id","1");
add_param(pRequest,"order_id","1");
add_param(pRequest,"open_id","1");
add_param(pRequest,"session_code","1");
add_param(pRequest,"mail_no","1");
add_param(pRequest,"cp_code","1");
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.graborder.submitmailnowithcpcode', {
	'user_id':'1',
	'order_id':'1',
	'open_id':'1',
	'session_code':'1',
	'mail_no':'1',
	'cp_code':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_graborder_submitmailnowithcpcode_response>
    <data>
        <error_code>demo</error_code>
        <error_msg>demo</error_msg>
        <order_info>
            <added_price>demo</added_price>
            <apply_order_time>2015-11-27 15:47:23</apply_order_time>
            <create_time>2015-11-27 15:47:23</create_time>
            <has_finished>false</has_finished>
            <order_id>demo</order_id>
            <order_service_info>
                <remark>demo</remark>
                <service_id>123</service_id>
                <service_name>demo</service_name>
                <service_price>demo</service_price>
                <service_show_title>demo</service_show_title>
                <service_time>demo</service_time>
                <service_type>demo</service_type>
            </order_service_info>
            <order_status>demo</order_status>
            <order_status_desc>demo</order_status_desc>
            <order_type>demo</order_type>
            <package_cp_name>demo</package_cp_name>
            <package_detail>demo</package_detail>
            <package_image_url>demo</package_image_url>
            <package_mail_no>demo</package_mail_no>
            <package_type>demo</package_type>
            <pay_state>123</pay_state>
            <price>123</price>
            <punishment>demo</punishment>
            <real_price>demo</real_price>
            <receiver>
                <address>demo</address>
                <area_id>demo</area_id>
                <area_name>demo</area_name>
                <avatar_url>demo</avatar_url>
                <city_name>demo</city_name>
                <name>demo</name>
                <phone>demo</phone>
                <prov_name>demo</prov_name>
                <zip_code>demo</zip_code>
            </receiver>
            <receiver_address>demo</receiver_address>
            <receiver_area>demo</receiver_area>
            <reward>demo</reward>
            <reward_desc>demo</reward_desc>
            <sender>
                <address>demo</address>
                <area_id>demo</area_id>
                <area_name>demo</area_name>
                <avatar_url>demo</avatar_url>
                <city_name>demo</city_name>
                <name>demo</name>
                <phone>demo</phone>
                <prov_name>demo</prov_name>
                <zip_code>demo</zip_code>
            </sender>
            <sender_id>id</sender_id>
            <source_address>demo</source_address>
            <submit_mailno_time>2015-11-27 15:47:23</submit_mailno_time>
            <take_package_time>2015-11-27 15:47:23</take_package_time>
            <time_type>123</time_type>
            <user_id>demo</user_id>
            <show_reward>true</show_reward>
        </order_info>
        <success>false</success>
    </data>
    <is_success>true</is_success>
</cainiao_guoguo_graborder_submitmailnowithcpcode_response>

{
    "cainiao_guoguo_graborder_submitmailnowithcpcode_response":{
        "data":{
            "error_code":"demo",
            "error_msg":"demo",
            "order_info":{
                "added_price":"demo",
                "apply_order_time":"2015-11-27 15:47:23",
                "create_time":"2015-11-27 15:47:23",
                "has_finished":false,
                "order_id":"demo",
                "order_service_info":{
                    "remark":"demo",
                    "service_id":123,
                    "service_name":"demo",
                    "service_price":"demo",
                    "service_show_title":"demo",
                    "service_time":"demo",
                    "service_type":"demo"
                },
                "order_status":demo,
                "order_status_desc":"demo",
                "order_type":demo,
                "package_cp_name":"demo",
                "package_detail":"demo",
                "package_image_url":"demo",
                "package_mail_no":"demo",
                "package_type":"demo",
                "pay_state":123,
                "price":"123",
                "punishment":"demo",
                "real_price":"demo",
                "receiver":{
                    "address":"demo",
                    "area_id":"demo",
                    "area_name":"demo",
                    "avatar_url":"demo",
                    "city_name":"demo",
                    "name":"demo",
                    "phone":"demo",
                    "prov_name":"demo",
                    "zip_code":"demo"
                },
                "receiver_address":"demo",
                "receiver_area":"demo",
                "reward":"demo",
                "reward_desc":"demo",
                "sender":{
                    "address":"demo",
                    "area_id":"demo",
                    "area_name":"demo",
                    "avatar_url":"demo",
                    "city_name":"demo",
                    "name":"demo",
                    "phone":"demo",
                    "prov_name":"demo",
                    "zip_code":"demo"
                },
                "sender_id":"id",
                "source_address":"demo",
                "submit_mailno_time":"2015-11-27 15:47:23",
                "take_package_time":"2015-11-27 15:47:23",
                "time_type":123,
                "user_id":"demo",
                "show_reward":true
            },
            "success":false
        },
        "is_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.guoguo.graborder.submitmailnowithcpcode (揽件v2)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ