淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
cpa_bill_query_params	CpaBillQueryParams	可选			入参
└ bill_state Number 可选 0 0待发放 1待到账 2已到账 3已失效 page_request PageRequest 可选分页入参 └ page_size Number 必须 20 每页多少最多20 └ page_num Number 必须 1 页码 └ start_time Number 可选 1736842511787 查询开始时间 └ end_time Number 可选 1736842511787 查询结束时间

名称	类型	示例值	描述
result	IdleAffiliatePageResult		result
result CpaBillDTO [] result └ amount String 2.4 佣金 └ amount_calculation_formula String 4元*0.6 佣金计算公式 └ state_text String UN_ACCOUNTED stateText └ create_time Date 1724396198817 createTime └ campaign_id String 6 活动id └ bill_id String 2ctHAHEb9qAT6iCKZO6I8uirfY+5xmHpHKYXmoMGTws= 佣金单id(加密的) └ update_time Date 1724779638443 updateTime └ comment String 推荐用户注册佣金备注 └ state Number 1 0待发放 1待到账 2已到账 3已失效 └ sub_publisher_id String 123456 二级推广者id 服务商转链时传入，明细会透传 └ invitee_id String 123456 被邀请者id └ extend_info String {"userL1Label":"U2"} 拓展信息可获取用户标签等信息 └ display_error_msg String 错误信息描述错误信息描述 └ next_page Boolean true nextPage └ success Boolean true success └ err_code String AFFILIATE_COMMON_ERROR 错误码 └ err_msg String 错误信息错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest req = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest();
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.CpaBillQueryParams obj1 = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.CpaBillQueryParams();
obj1.setBillState(0L);
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.PageRequest obj2 = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.PageRequest();
obj2.setPageSize(20L);
obj2.setPageNum(1L);
obj1.setPageRequest(obj2);
obj1.setStartTime(1736842511787L);
obj1.setEndTime(1736842511787L);
req.setCpaBillQueryParams(obj1);
AlibabaIdleAffiliateCpaIncomeDetailsQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest req = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest();
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.CpaBillQueryParamsDomain obj1 = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.CpaBillQueryParamsDomain();
obj1.BillState = 0L;
AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.PageRequestDomain obj2 = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest.PageRequestDomain();
obj2.PageSize = 20L;
obj2.PageNum = 1L;
obj1.PageRequest= obj2;
obj1.StartTime = 1736842511787L;
obj1.EndTime = 1736842511787L;
req.CpaBillQueryParams_ = obj1;
AlibabaIdleAffiliateCpaIncomeDetailsQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIdleAffiliateCpaIncomeDetailsQueryRequest;
$cpa_bill_query_params = new CpaBillQueryParams;
$cpa_bill_query_params->bill_state="0";
$page_request = new PageRequest;
$page_request->page_size="20";
$page_request->page_num="1";
$cpa_bill_query_params->page_request = $page_request;
$cpa_bill_query_params->start_time="1736842511787";
$cpa_bill_query_params->end_time="1736842511787";
$req->setCpaBillQueryParams(json_encode($cpa_bill_query_params));
$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.idle.affiliate.cpa.income.details.query' \
-d 'partner_id=apidoc' \
-d 'session=416d2c53-87b3-4366-92f3-9247dc6af04a' \
-d 'sign=2A2FD155AEF7C2E4913A04D6D0AB42E3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-13+18%3A33%3A15' \
-d 'v=2.0' \
-d 'cpa_bill_query_params=null'

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

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

req.cpa_bill_query_params="数据结构示例JSON格式"
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.idle.affiliate.cpa.income.details.query");
add_param(pRequest,"cpa_bill_query_params","数据结构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.idle.affiliate.cpa.income.details.query', {
	'cpa_bill_query_params':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_idle_affiliate_cpa_income_details_query_response>
    <result>
        <result>
            <cpa_bill_d_t_o>
                <amount>2.4</amount>
                <amount_calculation_formula>4元*0.6</amount_calculation_formula>
                <state_text>UN_ACCOUNTED</state_text>
                <create_time>1724396198817</create_time>
                <campaign_id>6</campaign_id>
                <bill_id>2ctHAHEb9qAT6iCKZO6I8uirfY+5xmHpHKYXmoMGTws=</bill_id>
                <update_time>1724779638443</update_time>
                <comment>推荐用户注册</comment>
                <state>1</state>
                <sub_publisher_id>123456</sub_publisher_id>
                <invitee_id>123456</invitee_id>
                <extend_info>{&quot;userL1Label&quot;:&quot;U2&quot;}</extend_info>
            </cpa_bill_d_t_o>
        </result>
        <display_error_msg>错误信息描述</display_error_msg>
        <next_page>true</next_page>
        <success>true</success>
        <err_code>AFFILIATE_COMMON_ERROR</err_code>
        <err_msg>错误信息</err_msg>
    </result>
</alibaba_idle_affiliate_cpa_income_details_query_response>

{
    "alibaba_idle_affiliate_cpa_income_details_query_response":{
        "result":{
            "result":{
                "cpa_bill_d_t_o":[
                    {
                        "amount":"2.4",
                        "amount_calculation_formula":"4元*0.6",
                        "state_text":"UN_ACCOUNTED",
                        "create_time":"1724396198817",
                        "campaign_id":"6",
                        "bill_id":"2ctHAHEb9qAT6iCKZO6I8uirfY+5xmHpHKYXmoMGTws=",
                        "update_time":"1724779638443",
                        "comment":"推荐用户注册",
                        "state":1,
                        "sub_publisher_id":"123456",
                        "invitee_id":"123456",
                        "extend_info":"{\"userL1Label\":\"U2\"}"
                    }
                ]
            },
            "display_error_msg":"错误信息描述",
            "next_page":true,
            "success":true,
            "err_code":"AFFILIATE_COMMON_ERROR",
            "err_msg":"错误信息"
        }
    }
}

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

开放平台

闲客联盟

alibaba.idle.affiliate.cpa.income.details.query (闲鱼联盟-cpa佣金明细查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ