淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
app_context_param	AppContextParam	可选			客户端信息
└ app_battery String 可选 45 电池用电量 └ device_type String 可选 ios app是android还是ios └ loc_accuracy String 可选 23 小件员-定位时间 └ loc_auth String 可选 true gps-定位权限授予 └ loc_lat String 可选 123.22 小件员-所在的纬度 └ loc_lng String 可选 123.22 小件员-所在的经度 └ loc_open String 可选 true gps-定位是否打开,GPS定位开启 └ loc_succ String 可选 true gps-定位是否成功 └ loc_time Number 可选 123 小件员-定位时间 └ loc_type String 可选 gps 小件员-定位方式 └ pkg_id String 可选 fsdfId 对应包裹侠的包id └ pkg_name String 可选 fsdf.sdf 对应包裹侠的包名 └ sdk_version String 可选 6.0.1 sdk的版本号
execute_user_list	ExecuteUserDto []	必须		最大列表长度：20	账号list
└ execute_user_id Number 可选 0 参数executeUserId └ execute_user_type String 可选 foo 参数executeUserType
personal_session	String	必须	dsdf324234234324		个人账号sessionCode不能为空
personal_user_id	Number	必须	324234234324		个人账号ID不能为空
task_order_id	Number	必须	1042423423		履行任务单ID不能为空
dpatch_env	String	可选	123		环境变量

名称	类型	示例值	描述
data	OperBillDetailDto		参数data
└ added_price String 23 寄件人加价 └ adjust_fee String -11.11 调价金额 └ cash_pay_tips String 现金支付提示文案现金支付提示文案 └ continued_step_heavy String 23 续重单元重量 └ continued_step_price String 23 续重单元价格 └ continued_total_price String 23 货品续重总价格 └ coupon_actrual_price String 23 优惠券实际抵扣金额 └ continued_total_heavy String 23 货品续重重量 └ goods_height String 300 高,单位厘米 └ goods_length String 200 长,单位厘米 └ goods_weight String 11.11 商品重量 └ goods_width String 10 宽,单位厘米 └ got_code String 3001 取件码 └ insurance_fee String 11.11 保价费 └ is_check_bill Boolean true 是否已经核价 └ is_open_order_bill Boolean true 是否开启订单账单核价功能 └ must_bill Boolean true 是不是必须要核价 └ order_insured_value String 11.11 订单声明价 └ order_status String 40 订单状态 └ order_total_price String 11.11 账单应付价额 └ pay_money String 104.1 用户支付金额 └ pay_state Number 1 支付状态 └ pay_state_desc String 已支付支付状态描述 └ pay_status Number 1 支付状态,0未支付,1线上支付,2线下支付 └ pay_with_hode_desc String 天猫平台代扣代扣显示文案 └ payment_q_r_code String dsffd.sdaf. 支付二维码 └ real_price String 23 真实原价 └ receiver_prov String 浙江账单收件人省 └ require_order_id Number 1042423499 需求单ID不能为空 └ sender_city String 杭州账单寄件人市 └ show_cash_pay Boolean true 是否显示现金支付 └ show_edit_bill Boolean true 是否可以修改账单 └ start_price String 23 首重价格 └ start_weight String 11 首重重量 └ status_code String 已回单订单状态描述 └ status_desc String 已回单状态描述 └ task_order_id Number 301231231232 履行任务单id └ tech_service_fee String 30.01 技术服务费 └ trade_id Number 1042423499 交易单ID └ volume_to_weight_rate_json String {"default":6000} 体积转化成重量的比率,平方厘米 / rate = kg └ pay_way String asdfdsf 支付方式 └ can_share_link Boolean true 是否可分享 └ user_pay_code String 支付编码 └ cp_adjust Boolean 是否属于到付件调价场景 └ package_fee String 1.9 包装费
status_code	String	PARAMS_CANNOT_BE_NULL	错误码
status_message	String	参数不能为空	错误描述
is_success	Boolean	true	是否成功
trace_id	String	dfsdf	traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilBilldetailRequest req = new CainiaoGuoguoFulfilBilldetailRequest();
CainiaoGuoguoFulfilBilldetailRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilBilldetailRequest.AppContextParam();
obj1.setAppBattery("45");
obj1.setDeviceType("ios");
obj1.setLocAccuracy("23");
obj1.setLocAuth("true");
obj1.setLocLat("123.22");
obj1.setLocLng("123.22");
obj1.setLocOpen("true");
obj1.setLocSucc("true");
obj1.setLocTime(123L);
obj1.setLocType("gps");
obj1.setPkgId("fsdfId");
obj1.setPkgName("fsdf.sdf");
obj1.setSdkVersion("6.0.1");
req.setAppContextParam(obj1);
List<CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDto();
list3.add(obj4);
obj4.setExecuteUserId(0L);
obj4.setExecuteUserType("foo");
req.setExecuteUserList(list3);
req.setPersonalSession("dsdf324234234324");
req.setPersonalUserId(324234234324L);
req.setTaskOrderId(1042423423L);
req.setDpatchEnv("123");
CainiaoGuoguoFulfilBilldetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoFulfilBilldetailRequest req = new CainiaoGuoguoFulfilBilldetailRequest();
CainiaoGuoguoFulfilBilldetailRequest.AppContextParamDomain obj1 = new CainiaoGuoguoFulfilBilldetailRequest.AppContextParamDomain();
obj1.AppBattery = "45";
obj1.DeviceType = "ios";
obj1.LocAccuracy = "23";
obj1.LocAuth = "true";
obj1.LocLat = "123.22";
obj1.LocLng = "123.22";
obj1.LocOpen = "true";
obj1.LocSucc = "true";
obj1.LocTime = 123L;
obj1.LocType = "gps";
obj1.PkgId = "fsdfId";
obj1.PkgName = "fsdf.sdf";
obj1.SdkVersion = "6.0.1";
req.AppContextParam_ = obj1;
List<CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDtoDomain> list3 = new List<CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDtoDomain>();
CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDtoDomain obj4 = new CainiaoGuoguoFulfilBilldetailRequest.ExecuteUserDtoDomain();
list3.Add(obj4);
obj4.ExecuteUserId = 0L;
obj4.ExecuteUserType = "foo";
req.ExecuteUserList_ = list3;
req.PersonalSession = "dsdf324234234324";
req.PersonalUserId = 324234234324L;
req.TaskOrderId = 1042423423L;
req.DpatchEnv = "123";
CainiaoGuoguoFulfilBilldetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoFulfilBilldetailRequest;
$app_context_param = new AppContextParam;
$app_context_param->app_battery="45";
$app_context_param->device_type="ios";
$app_context_param->loc_accuracy="23";
$app_context_param->loc_auth="true";
$app_context_param->loc_lat="123.22";
$app_context_param->loc_lng="123.22";
$app_context_param->loc_open="true";
$app_context_param->loc_succ="true";
$app_context_param->loc_time="123";
$app_context_param->loc_type="gps";
$app_context_param->pkg_id="fsdfId";
$app_context_param->pkg_name="fsdf.sdf";
$app_context_param->sdk_version="6.0.1";
$req->setAppContextParam(json_encode($app_context_param));
$execute_user_list = new ExecuteUserDto;
$execute_user_list->execute_user_id="0";
$execute_user_list->execute_user_type="foo";
$req->setExecuteUserList(json_encode($execute_user_list));
$req->setPersonalSession("dsdf324234234324");
$req->setPersonalUserId("324234234324");
$req->setTaskOrderId("1042423423");
$req->setDpatchEnv("123");
$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.fulfil.billdetail' \
-d 'partner_id=apidoc' \
-d 'sign=0CEAFF010769A45D8179792C1D34E210' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A45%3A17' \
-d 'v=2.0' \
-d 'app_context_param=null' \
-d 'dpatch_env=123' \
-d 'execute_user_list=null' \
-d 'personal_session=dsdf324234234324' \
-d 'personal_user_id=324234234324' \
-d 'task_order_id=1042423423'

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

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

req.app_context_param=""
req.execute_user_list=""
req.personal_session="dsdf324234234324"
req.personal_user_id=324234234324
req.task_order_id=1042423423
req.dpatch_env="123"
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.fulfil.billdetail");
add_param(pRequest,"app_context_param","数据结构JSON示例");
add_param(pRequest,"execute_user_list","数据结构JSON示例");
add_param(pRequest,"personal_session","dsdf324234234324");
add_param(pRequest,"personal_user_id","324234234324");
add_param(pRequest,"task_order_id","1042423423");
add_param(pRequest,"dpatch_env","123");
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.fulfil.billdetail', {
	'app_context_param':'数据结构JSON示例',
	'execute_user_list':'数据结构JSON示例',
	'personal_session':'dsdf324234234324',
	'personal_user_id':'324234234324',
	'task_order_id':'1042423423',
	'dpatch_env':'123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_fulfil_billdetail_response>
    <data>
        <added_price>23</added_price>
        <adjust_fee>-11.11</adjust_fee>
        <cash_pay_tips>现金支付提示文案</cash_pay_tips>
        <continued_step_heavy>23</continued_step_heavy>
        <continued_step_price>23</continued_step_price>
        <continued_total_price>23</continued_total_price>
        <coupon_actrual_price>23</coupon_actrual_price>
        <continued_total_heavy>23</continued_total_heavy>
        <goods_height>300</goods_height>
        <goods_length>200</goods_length>
        <goods_weight>11.11</goods_weight>
        <goods_width>10</goods_width>
        <got_code>3001</got_code>
        <insurance_fee>11.11</insurance_fee>
        <is_check_bill>true</is_check_bill>
        <is_open_order_bill>true</is_open_order_bill>
        <must_bill>true</must_bill>
        <order_insured_value>11.11</order_insured_value>
        <order_status>40</order_status>
        <order_total_price>11.11</order_total_price>
        <pay_money>104.1</pay_money>
        <pay_state>1</pay_state>
        <pay_state_desc>已支付</pay_state_desc>
        <pay_status>1</pay_status>
        <pay_with_hode_desc>天猫平台代扣</pay_with_hode_desc>
        <payment_q_r_code>dsffd.sdaf.</payment_q_r_code>
        <real_price>23</real_price>
        <receiver_prov>浙江</receiver_prov>
        <require_order_id>1042423499</require_order_id>
        <sender_city>杭州</sender_city>
        <show_cash_pay>true</show_cash_pay>
        <show_edit_bill>true</show_edit_bill>
        <start_price>23</start_price>
        <start_weight>11</start_weight>
        <status_code>已回单</status_code>
        <status_desc>已回单</status_desc>
        <task_order_id>301231231232</task_order_id>
        <tech_service_fee>30.01</tech_service_fee>
        <trade_id>1042423499</trade_id>
        <volume_to_weight_rate_json>{&quot;default&quot;:6000}</volume_to_weight_rate_json>
        <pay_way>asdfdsf</pay_way>
        <can_share_link>true</can_share_link>
        <user_pay_code></user_pay_code>
        <cp_adjust></cp_adjust>
        <package_fee>1.9</package_fee>
    </data>
    <status_code>PARAMS_CANNOT_BE_NULL</status_code>
    <status_message>参数不能为空</status_message>
    <is_success>true</is_success>
    <trace_id>dfsdf</trace_id>
</cainiao_guoguo_fulfil_billdetail_response>

{
    "cainiao_guoguo_fulfil_billdetail_response":{
        "data":{
            "added_price":"23",
            "adjust_fee":"-11.11",
            "cash_pay_tips":"现金支付提示文案",
            "continued_step_heavy":"23",
            "continued_step_price":"23",
            "continued_total_price":"23",
            "coupon_actrual_price":"23",
            "continued_total_heavy":"23",
            "goods_height":"300",
            "goods_length":"200",
            "goods_weight":"11.11",
            "goods_width":"10",
            "got_code":"3001",
            "insurance_fee":"11.11",
            "is_check_bill":true,
            "is_open_order_bill":true,
            "must_bill":true,
            "order_insured_value":"11.11",
            "order_status":"40",
            "order_total_price":"11.11",
            "pay_money":"104.1",
            "pay_state":1,
            "pay_state_desc":"已支付",
            "pay_status":1,
            "pay_with_hode_desc":"天猫平台代扣",
            "payment_q_r_code":"dsffd.sdaf.",
            "real_price":"23",
            "receiver_prov":"浙江",
            "require_order_id":1042423499,
            "sender_city":"杭州",
            "show_cash_pay":true,
            "show_edit_bill":true,
            "start_price":"23",
            "start_weight":"11",
            "status_code":"已回单",
            "status_desc":"已回单",
            "task_order_id":301231231232,
            "tech_service_fee":"30.01",
            "trade_id":1042423499,
            "volume_to_weight_rate_json":"{\"default\":6000}",
            "pay_way":"asdfdsf",
            "can_share_link":true,
            "user_pay_code":"",
            "cp_adjust":,
            "package_fee":"1.9"
        },
        "status_code":"PARAMS_CANNOT_BE_NULL",
        "status_message":"参数不能为空",
        "is_success":true,
        "trace_id":"dfsdf"
    }
}

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.fulfil.billdetail (快递员账单详情getBillDetailInfo)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ