淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
detail_request	BillDetailQueryRequest	必须			请求对象
└ current Number 可选 1 查询的页码，从1开始 └ page_size Number 可选 20 页大小 └ store_id String 可选 A001 经营店ID └ bill_start_date Number 可选 20210102 账单起始时间: yyyyMMdd └ bill_end_date Number 可选 20210102 账单结束时间: yyyyMMdd

名称	类型	示例值	描述
api_result	ApiPageResults	result	结果
└ page_index Number 1 当前页码 └ page_size Number 20 页码大小 └ page_count Number 2 总页数 └ total Number 212 总记录数 model BillDetailDTO [] list 结果集 └ merchant_code String CSWZW 商家编码 └ store_id String A001 经营店ID └ order_from String 3 渠道 └ settle_biz_id String S11100022334 明细单据唯一结算标识 └ bill_date String 20210102 账单日期 └ settle_amount BigDecimal 100 商家应收金额，正号代表收入，负号代表支出 └ sku_amount BigDecimal 100 商品总金额 └ charge_base_amount BigDecimal 100 计费基数 └ package_amount BigDecimal 100 商户应收包装费总额，正号代表收入，负号代表支出 └ send_amount BigDecimal 100 商户应收总运费，正号代表收入，负号代表支出 └ merchant_subsidy_amount BigDecimal 100 商户补贴总金额，正负号存在渠道差异 └ plat_subsidy_amount BigDecimal 100 平台营销补贴费用，正号代表收入，负号代表支出 └ brand_subsidy_amount BigDecimal 100 品牌营销补贴费用，正号代表收入，负号代表支出 └ agent_subsidy_amount BigDecimal 100 代理商营销补贴费用，正号代表收入，负号代表支出 └ channel_commission_amount BigDecimal 100 技术服务费，正号代表收入，负号代表支出 └ base_logistics_amount BigDecimal 100 基础物流费，正号代表收入，负号代表支出 └ added_value_amount BigDecimal 100 增值服务费，正号代表收入，负号代表支出 └ other_fee_amount BigDecimal 100 其它服务费，正号代表收入，负号代表支出 └ handle_fee_amount BigDecimal 100 手续费，正号代表收入，负号代表支出 └ extend_info String {} 其它费用 └ type String 1 账单类型 └ channel_order_id String 11223344550 渠道订单号 └ platform_voucher_subsidy_fee BigDecimal 100 平台红包补贴 └ merchant_voucher_subsidy_fee BigDecimal 10 商家承担红包补贴费用 └ plat_package_fee BigDecimal 10 平台包装费 └ user_pay_amount BigDecimal 60 用户实付金额 └ success Boolean true 是否成功 └ err_msg String 系统异常错误描述 └ err_code String SYS_ERROR 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTclsAelophyBillDetailQueryRequest req = new AlibabaTclsAelophyBillDetailQueryRequest();
AlibabaTclsAelophyBillDetailQueryRequest.BillDetailQueryRequest obj1 = new AlibabaTclsAelophyBillDetailQueryRequest.BillDetailQueryRequest();
obj1.setCurrent(1L);
obj1.setPageSize(20L);
obj1.setStoreId("A001");
obj1.setBillStartDate(20210102L);
obj1.setBillEndDate(20210102L);
req.setDetailRequest(obj1);
AlibabaTclsAelophyBillDetailQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTclsAelophyBillDetailQueryRequest req = new AlibabaTclsAelophyBillDetailQueryRequest();
AlibabaTclsAelophyBillDetailQueryRequest.BillDetailQueryRequestDomain obj1 = new AlibabaTclsAelophyBillDetailQueryRequest.BillDetailQueryRequestDomain();
obj1.Current = 1L;
obj1.PageSize = 20L;
obj1.StoreId = "A001";
obj1.BillStartDate = 20210102L;
obj1.BillEndDate = 20210102L;
req.DetailRequest_ = obj1;
AlibabaTclsAelophyBillDetailQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTclsAelophyBillDetailQueryRequest;
$detail_request = new BillDetailQueryRequest;
$detail_request->current="1";
$detail_request->page_size="20";
$detail_request->store_id="A001";
$detail_request->bill_start_date="20210102";
$detail_request->bill_end_date="20210102";
$req->setDetailRequest(json_encode($detail_request));
$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=alibaba.tcls.aelophy.bill.detail.query' \
-d 'partner_id=apidoc' \
-d 'session=ac420d0c-2830-4de2-8ed7-46b67c3b1445' \
-d 'sign=6C8ADE1394374D9CB19F76816E444453' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+14%3A49%3A09' \
-d 'v=2.0' \
-d 'detail_request=request'

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

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

req.detail_request="request"
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,"alibaba.tcls.aelophy.bill.detail.query");
add_param(pRequest,"detail_request","数据结构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('alibaba.tcls.aelophy.bill.detail.query', {
	'detail_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tcls_aelophy_bill_detail_query_response>
    <api_result>
        <page_index>1</page_index>
        <page_size>20</page_size>
        <page_count>2</page_count>
        <total>212</total>
        <model>
            <bill_detail_d_t_o>
                <merchant_code>CSWZW</merchant_code>
                <store_id>A001</store_id>
                <order_from>3</order_from>
                <settle_biz_id>S11100022334</settle_biz_id>
                <bill_date>20210102</bill_date>
                <settle_amount>100</settle_amount>
                <sku_amount>100</sku_amount>
                <charge_base_amount>100</charge_base_amount>
                <package_amount>100</package_amount>
                <send_amount>100</send_amount>
                <merchant_subsidy_amount>100</merchant_subsidy_amount>
                <plat_subsidy_amount>100</plat_subsidy_amount>
                <brand_subsidy_amount>100</brand_subsidy_amount>
                <agent_subsidy_amount>100</agent_subsidy_amount>
                <channel_commission_amount>100</channel_commission_amount>
                <base_logistics_amount>100</base_logistics_amount>
                <added_value_amount>100</added_value_amount>
                <other_fee_amount>100</other_fee_amount>
                <handle_fee_amount>100</handle_fee_amount>
                <extend_info>{}</extend_info>
                <type>1</type>
                <channel_order_id>11223344550</channel_order_id>
                <platform_voucher_subsidy_fee>100</platform_voucher_subsidy_fee>
                <merchant_voucher_subsidy_fee>10</merchant_voucher_subsidy_fee>
                <plat_package_fee>10</plat_package_fee>
                <user_pay_amount>60</user_pay_amount>
            </bill_detail_d_t_o>
        </model>
        <success>true</success>
        <err_msg>系统异常</err_msg>
        <err_code>SYS_ERROR</err_code>
    </api_result>
</alibaba_tcls_aelophy_bill_detail_query_response>

{
    "alibaba_tcls_aelophy_bill_detail_query_response":{
        "api_result":{
            "page_index":1,
            "page_size":20,
            "page_count":2,
            "total":212,
            "model":{
                "bill_detail_d_t_o":[
                    {
                        "merchant_code":"CSWZW",
                        "store_id":"A001",
                        "order_from":"3",
                        "settle_biz_id":"S11100022334",
                        "bill_date":"20210102",
                        "settle_amount":"100",
                        "sku_amount":"100",
                        "charge_base_amount":"100",
                        "package_amount":"100",
                        "send_amount":"100",
                        "merchant_subsidy_amount":"100",
                        "plat_subsidy_amount":"100",
                        "brand_subsidy_amount":"100",
                        "agent_subsidy_amount":"100",
                        "channel_commission_amount":"100",
                        "base_logistics_amount":"100",
                        "added_value_amount":"100",
                        "other_fee_amount":"100",
                        "handle_fee_amount":"100",
                        "extend_info":"{}",
                        "type":"1",
                        "channel_order_id":"11223344550",
                        "platform_voucher_subsidy_fee":"100",
                        "merchant_voucher_subsidy_fee":"10",
                        "plat_package_fee":"10",
                        "user_pay_amount":"60"
                    }
                ]
            },
            "success":true,
            "err_msg":"系统异常",
            "err_code":"SYS_ERROR"
        }
    }
}

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

alibaba.tcls.aelophy.bill.detail.query (账单明细接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ