淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_d_m_s_rebate_balance_detail_query_request	DmsRebateBalanceDetailQueryRequest	可选			入参
└ category String 可选 TIANMAOJINGLINGCHENGPIN category └ customer_code String 可选 XX 客户编码 └ operator String 可选 XXX 操作人 └ out_customer_code String 可选 XXX 外部客户编码 └ page_no Number 可选 1 分页起始 └ page_size Number 可选 2 分页结束 └ request_id String 可选 XXXX 请求id └ tenant String 可选 ailab 租户

名称	类型	示例值	描述
result	DataResult	xxx	返回对象封装
└ code String foo 参数code data KeyValueDto [] xxx 返回列表 └ available_amount Number 1 可用金额 └ end_time Date 111 结束日期 └ freeze_amount Number 1 冻结金额 └ gmt_create Date 11 创建日期 └ id Number 1 id └ rebate_amount Number 1 返利金额 rebate_use_product_list DmsProductSeriesDto [] 可用产品线 └ product_id Number xx 产品线id └ product_name String xx 产品线名称 └ start_time Date 1 开始时间 └ msg String foo 参数msg └ pending Boolean false 是否阻塞 └ success Boolean false 是否正常 └ total Number 1 总个数 └ trace_id String xxx traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaGscDmsAgentRebateBalanceDetailGetRequest req = new AlibabaGscDmsAgentRebateBalanceDetailGetRequest();
AlibabaGscDmsAgentRebateBalanceDetailGetRequest.DmsRebateBalanceDetailQueryRequest obj1 = new AlibabaGscDmsAgentRebateBalanceDetailGetRequest.DmsRebateBalanceDetailQueryRequest();
obj1.setCategory("TIANMAOJINGLINGCHENGPIN");
obj1.setCustomerCode("XX");
obj1.setOperator("XXX");
obj1.setOutCustomerCode("XXX");
obj1.setPageNo(1L);
obj1.setPageSize(2L);
obj1.setRequestId("XXXX");
obj1.setTenant("ailab");
req.setParamDMSRebateBalanceDetailQueryRequest(obj1);
AlibabaGscDmsAgentRebateBalanceDetailGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaGscDmsAgentRebateBalanceDetailGetRequest req = new AlibabaGscDmsAgentRebateBalanceDetailGetRequest();
AlibabaGscDmsAgentRebateBalanceDetailGetRequest.DmsRebateBalanceDetailQueryRequestDomain obj1 = new AlibabaGscDmsAgentRebateBalanceDetailGetRequest.DmsRebateBalanceDetailQueryRequestDomain();
obj1.Category = "TIANMAOJINGLINGCHENGPIN";
obj1.CustomerCode = "XX";
obj1.Operator = "XXX";
obj1.OutCustomerCode = "XXX";
obj1.PageNo = 1L;
obj1.PageSize = 2L;
obj1.RequestId = "XXXX";
obj1.Tenant = "ailab";
req.ParamDMSRebateBalanceDetailQueryRequest_ = obj1;
AlibabaGscDmsAgentRebateBalanceDetailGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaGscDmsAgentRebateBalanceDetailGetRequest;
$param_d_m_s_rebate_balance_detail_query_request = new DmsRebateBalanceDetailQueryRequest;
$param_d_m_s_rebate_balance_detail_query_request->category="TIANMAOJINGLINGCHENGPIN";
$param_d_m_s_rebate_balance_detail_query_request->customer_code="XX";
$param_d_m_s_rebate_balance_detail_query_request->operator="XXX";
$param_d_m_s_rebate_balance_detail_query_request->out_customer_code="XXX";
$param_d_m_s_rebate_balance_detail_query_request->page_no="1";
$param_d_m_s_rebate_balance_detail_query_request->page_size="2";
$param_d_m_s_rebate_balance_detail_query_request->request_id="XXXX";
$param_d_m_s_rebate_balance_detail_query_request->tenant="ailab";
$req->setParamDMSRebateBalanceDetailQueryRequest(json_encode($param_d_m_s_rebate_balance_detail_query_request));
$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=alibaba.gsc.dms.agent.rebate.balance.detail.get' \
-d 'partner_id=apidoc' \
-d 'sign=6FF37D1E6133F677858A3DA23AB795E3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-19+09%3A45%3A46' \
-d 'v=2.0' \
-d 'param_d_m_s_rebate_balance_detail_query_request=null'

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

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

req.param_d_m_s_rebate_balance_detail_query_request=""
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,"alibaba.gsc.dms.agent.rebate.balance.detail.get");
add_param(pRequest,"param_d_m_s_rebate_balance_detail_query_request","数据结构JSON示例");
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('alibaba.gsc.dms.agent.rebate.balance.detail.get', {
	'param_d_m_s_rebate_balance_detail_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_gsc_dms_agent_rebate_balance_detail_get_response>
    <result>
        <code>foo</code>
        <data>
            <key_value_dto>
                <available_amount>1</available_amount>
                <end_time>111</end_time>
                <freeze_amount>1</freeze_amount>
                <gmt_create>11</gmt_create>
                <id>1</id>
                <rebate_amount>1</rebate_amount>
                <rebate_use_product_list>
                    <dms_product_series_dto>
                        <product_id>xx</product_id>
                        <product_name>xx</product_name>
                    </dms_product_series_dto>
                </rebate_use_product_list>
                <start_time>1</start_time>
            </key_value_dto>
        </data>
        <msg>foo</msg>
        <pending>false</pending>
        <success>false</success>
        <total>1</total>
        <trace_id>xxx</trace_id>
    </result>
</alibaba_gsc_dms_agent_rebate_balance_detail_get_response>

{
    "alibaba_gsc_dms_agent_rebate_balance_detail_get_response":{
        "result":{
            "code":"foo",
            "data":{
                "key_value_dto":[
                    {
                        "available_amount":1,
                        "end_time":"111",
                        "freeze_amount":1,
                        "gmt_create":"11",
                        "id":1,
                        "rebate_amount":1,
                        "rebate_use_product_list":{
                            "dms_product_series_dto":[
                                {
                                    "product_id":xx,
                                    "product_name":"xx"
                                }
                            ]
                        },
                        "start_time":"1"
                    }
                ]
            },
            "msg":"foo",
            "pending":false,
            "success":false,
            "total":1,
            "trace_id":"xxx"
        }
    }
}

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.gsc.dms.agent.rebate.balance.detail.get (查询返利余额明细)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ