淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
pay_time_start	Date	可选	2023-01-01 00:00:00		提现开始时间（与截止时间成对使用）
pay_time_end	Date	可选	2023-01-01 00:00:00		提现截止时间
bill_time_end	Date	可选	2023-01-01 00:00:00		流水截止时间
page_size	Number	必须	20	默认值：20	分页大小
bill_time_start	Date	可选	2023-01-01 00:00:00		流水开始时间（与截止时间配对使用）
page_num	Number	必须	1	默认值：1	分页页码

名称	类型	示例值	描述
ret_msg	String	null	错误信息
ret_code	String	null	错误码
is_success	Boolean	true	是否成功
obj	PagedResult		分页数据
└ page_index Number 1 页码 data_list BillList [] 分页数据 └ pay_time Date 2023-01-01 00:00:00 提现时间 └ sum_refund_amount BigDecimal 0 总退款金额 └ pay_trade_no String 20230515103711010008120009659309 支付宝提现流水号 fee_list FeeList [] [] 工单费用清单 └ fee_amount BigDecimal 62 费用金额 └ src_order_id String x 费用来源单号，仅增加费用、退款有值 └ fee_title String 送装服务费费用描述 └ fee_name String 服务费费用名称 └ gmt_create Date 2023-01-01 00:00:00 费用产生时间 └ workcard_id Number 735572457 工单ID └ sum_add_amount BigDecimal 0 总增加费用金额 └ bill_time Date 2023-01-01 00:00:00 费用产生时间 └ pay_amount BigDecimal 62 提现金额 └ fc_amount BigDecimal 62 分成金额 └ platform_commission_rate BigDecimal 0 抽佣比例 └ sum_service_amount BigDecimal 62 总服务费用金额 └ pay_trade_notice String （天猫三方平台）服务商服务费（提现）{20230515} 提现支付宝备注 └ page_size Number 20 分页大小 └ total_page_count Number 4 总页数 └ total_count Number 73 总条数 └ data_count Number 20 本页条数 └ empty Boolean false 本页是否为空数据

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallServiceSettlementFbBillQueryRequest req = new TmallServiceSettlementFbBillQueryRequest();
req.setPayTimeStart(StringUtils.parseDateTime("2023-01-01 00:00:00"));
req.setPayTimeEnd(StringUtils.parseDateTime("2023-01-01 00:00:00"));
req.setBillTimeEnd(StringUtils.parseDateTime("2023-01-01 00:00:00"));
req.setPageSize(20L);
req.setBillTimeStart(StringUtils.parseDateTime("2023-01-01 00:00:00"));
req.setPageNum(1L);
TmallServiceSettlementFbBillQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallServiceSettlementFbBillQueryRequest req = new TmallServiceSettlementFbBillQueryRequest();
req.PayTimeStart = DateTime.Parse("2023-01-01 00:00:00");
req.PayTimeEnd = DateTime.Parse("2023-01-01 00:00:00");
req.BillTimeEnd = DateTime.Parse("2023-01-01 00:00:00");
req.PageSize = 20L;
req.BillTimeStart = DateTime.Parse("2023-01-01 00:00:00");
req.PageNum = 1L;
TmallServiceSettlementFbBillQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallServiceSettlementFbBillQueryRequest;
$req->setPayTimeStart("2023-01-01 00:00:00");
$req->setPayTimeEnd("2023-01-01 00:00:00");
$req->setBillTimeEnd("2023-01-01 00:00:00");
$req->setPageSize("20");
$req->setBillTimeStart("2023-01-01 00:00:00");
$req->setPageNum("1");
$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=tmall.service.settlement.fb.bill.query' \
-d 'partner_id=apidoc' \
-d 'session=fa7532b7-ba2d-4fa9-b89b-afa3a6f30ef1' \
-d 'sign=FD3C83533E3EF5100F593DCD27E74B68' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A50%3A39' \
-d 'v=2.0' \
-d 'bill_time_end=2023-01-01+00%3A00%3A00' \
-d 'bill_time_start=2023-01-01+00%3A00%3A00' \
-d 'page_num=1' \
-d 'page_size=20' \
-d 'pay_time_end=2023-01-01+00%3A00%3A00' \
-d 'pay_time_start=2023-01-01+00%3A00%3A00'

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

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

req.pay_time_start="2023-01-01 00:00:00"
req.pay_time_end="2023-01-01 00:00:00"
req.bill_time_end="2023-01-01 00:00:00"
req.page_size=20
req.bill_time_start="2023-01-01 00:00:00"
req.page_num=1
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,"tmall.service.settlement.fb.bill.query");
add_param(pRequest,"pay_time_start","2023-01-01 00:00:00");
add_param(pRequest,"pay_time_end","2023-01-01 00:00:00");
add_param(pRequest,"bill_time_end","2023-01-01 00:00:00");
add_param(pRequest,"page_size","20");
add_param(pRequest,"bill_time_start","2023-01-01 00:00:00");
add_param(pRequest,"page_num","1");
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('tmall.service.settlement.fb.bill.query', {
	'pay_time_start':'2023-01-01 00:00:00',
	'pay_time_end':'2023-01-01 00:00:00',
	'bill_time_end':'2023-01-01 00:00:00',
	'page_size':'20',
	'bill_time_start':'2023-01-01 00:00:00',
	'page_num':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_service_settlement_fb_bill_query_response>
    <ret_msg>null</ret_msg>
    <ret_code>null</ret_code>
    <is_success>true</is_success>
    <obj>
        <page_index>1</page_index>
        <data_list>
            <bill_list>
                <pay_time>2023-01-01 00:00:00</pay_time>
                <sum_refund_amount>0</sum_refund_amount>
                <pay_trade_no>20230515103711010008120009659309</pay_trade_no>
                <fee_list>
                    <fee_list>
                        <fee_amount>62</fee_amount>
                        <src_order_id>x</src_order_id>
                        <fee_title>送装服务费</fee_title>
                        <fee_name>服务费</fee_name>
                        <gmt_create>2023-01-01 00:00:00</gmt_create>
                    </fee_list>
                </fee_list>
                <workcard_id>735572457</workcard_id>
                <sum_add_amount>0</sum_add_amount>
                <bill_time>2023-01-01 00:00:00</bill_time>
                <pay_amount>62</pay_amount>
                <fc_amount>62</fc_amount>
                <platform_commission_rate>0</platform_commission_rate>
                <sum_service_amount>62</sum_service_amount>
                <pay_trade_notice>（天猫三方平台）服务商服务费（提现）{20230515}</pay_trade_notice>
            </bill_list>
        </data_list>
        <page_size>20</page_size>
        <total_page_count>4</total_page_count>
        <total_count>73</total_count>
        <data_count>20</data_count>
        <empty>false</empty>
    </obj>
</tmall_service_settlement_fb_bill_query_response>

{
    "tmall_service_settlement_fb_bill_query_response":{
        "ret_msg":"null",
        "ret_code":"null",
        "is_success":true,
        "obj":{
            "page_index":1,
            "data_list":{
                "bill_list":[
                    {
                        "pay_time":"2023-01-01 00:00:00",
                        "sum_refund_amount":"0",
                        "pay_trade_no":"20230515103711010008120009659309",
                        "fee_list":{
                            "fee_list":[
                                {
                                    "fee_amount":"62",
                                    "src_order_id":"x",
                                    "fee_title":"送装服务费",
                                    "fee_name":"服务费",
                                    "gmt_create":"2023-01-01 00:00:00"
                                }
                            ]
                        },
                        "workcard_id":735572457,
                        "sum_add_amount":"0",
                        "bill_time":"2023-01-01 00:00:00",
                        "pay_amount":"62",
                        "fc_amount":"62",
                        "platform_commission_rate":"0",
                        "sum_service_amount":"62",
                        "pay_trade_notice":"（天猫三方平台）服务商服务费（提现）{20230515}"
                    }
                ]
            },
            "page_size":20,
            "total_page_count":4,
            "total_count":73,
            "data_count":20,
            "empty":false
        }
    }
}

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下载

开放平台

天猫服务平台

tmall.service.settlement.fb.bill.query (服务商工单结算对账查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ