阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
supplier_id	Number	必须	1003242342342	供应商ID
gmt_create_left	String	可选	2021-08-01 10:00:00	日期左区间
page_num	Number	必须	1	页码
page_size	Number	必须	100	页面大小
gmt_create_right	String	可选	2021-08-01 11:00:00	日期右区间

名称	类型	示例值	描述
result	JkPageResult	无	结果
└ total_page Number 100 总页数 └ total_rows Number 10000 总行数 └ page_num Number 1 页码 └ page_size Number 100 页面大小 └ has_next Boolean false 是否有下一页 modules Module [] 返回结果返回结果 └ biz_date String 222 业务日期 └ sub_order_id String 222 子订单号 └ sc_item_name String 22 货品名称 └ sc_item_id Number 22 货品ID └ spec String 22 规格 └ barcode String 222 条码 └ quantity Number 222 数量 └ real_amount String 222 真实金额 └ purchase_order_no String 222 采购单号 └ order_id String 134234 主订单id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSettlementQueryRequest req = new AlibabaAlihealthSettlementQueryRequest();
req.setSupplierId(1003242342342L);
req.setGmtCreateLeft("2021-08-01 10:00:00");
req.setPageNum(1L);
req.setPageSize(100L);
req.setGmtCreateRight("2021-08-01 11:00:00");
AlibabaAlihealthSettlementQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSettlementQueryRequest req = new AlibabaAlihealthSettlementQueryRequest();
req.SupplierId = 1003242342342L;
req.GmtCreateLeft = "2021-08-01 10:00:00";
req.PageNum = 1L;
req.PageSize = 100L;
req.GmtCreateRight = "2021-08-01 11:00:00";
AlibabaAlihealthSettlementQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSettlementQueryRequest;
$req->setSupplierId("1003242342342");
$req->setGmtCreateLeft("2021-08-01 10:00:00");
$req->setPageNum("1");
$req->setPageSize("100");
$req->setGmtCreateRight("2021-08-01 11:00:00");
$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.alihealth.settlement.query' \
-d 'partner_id=apidoc' \
-d 'session=8fae2fd9-b563-4ed8-8aef-c68be04bbe3d' \
-d 'sign=E39A6600905058C2E0AF956D884D89EA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+14%3A20%3A38' \
-d 'v=2.0' \
-d 'gmt_create_left=2021-08-01+10%3A00%3A00' \
-d 'gmt_create_right=2021-08-01+11%3A00%3A00' \
-d 'page_num=1' \
-d 'page_size=100' \
-d 'supplier_id=1003242342342'

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

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

req.supplier_id=1003242342342
req.gmt_create_left="2021-08-01 10:00:00"
req.page_num=1
req.page_size=100
req.gmt_create_right="2021-08-01 11:00:00"
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.alihealth.settlement.query");
add_param(pRequest,"supplier_id","1003242342342");
add_param(pRequest,"gmt_create_left","2021-08-01 10:00:00");
add_param(pRequest,"page_num","1");
add_param(pRequest,"page_size","100");
add_param(pRequest,"gmt_create_right","2021-08-01 11:00:00");
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.alihealth.settlement.query', {
	'supplier_id':'1003242342342',
	'gmt_create_left':'2021-08-01 10:00:00',
	'page_num':'1',
	'page_size':'100',
	'gmt_create_right':'2021-08-01 11:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_settlement_query_response>
    <result>
        <total_page>100</total_page>
        <total_rows>10000</total_rows>
        <page_num>1</page_num>
        <page_size>100</page_size>
        <has_next>false</has_next>
        <modules>
            <module>
                <biz_date>222</biz_date>
                <sub_order_id>222</sub_order_id>
                <sc_item_name>22</sc_item_name>
                <sc_item_id>22</sc_item_id>
                <spec>22</spec>
                <barcode>222</barcode>
                <quantity>222</quantity>
                <real_amount>222</real_amount>
                <purchase_order_no>222</purchase_order_no>
                <order_id>134234</order_id>
            </module>
        </modules>
    </result>
</alibaba_alihealth_settlement_query_response>

{
    "alibaba_alihealth_settlement_query_response":{
        "result":{
            "total_page":100,
            "total_rows":10000,
            "page_num":1,
            "page_size":100,
            "has_next":false,
            "modules":{
                "module":[
                    {
                        "biz_date":"222",
                        "sub_order_id":"222",
                        "sc_item_name":"22",
                        "sc_item_id":22,
                        "spec":"22",
                        "barcode":"222",
                        "quantity":222,
                        "real_amount":"222",
                        "purchase_order_no":"222",
                        "order_id":"134234"
                    }
                ]
            }
        }
    }
}

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.alihealth.settlement.query (直发供应商查询对账单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈