淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
create_start_time	String	可选	2025-01-01	创建时间的开始日期
create_end_time	String	可选	2025-01-01	创建时间的结束日期
send_start_time	String	可选	2025-01-01	收发时间的开始日期
send_end_time	String	可选	2025-01-01	收发时间的结束日期
complete_start_time	String	可选	2025-01-01	双方签署完成时间的开始日期
complete_end_time	String	可选	2025-01-01	双方签署完成时间的结束日期
contract_name	String	可选	xx合同	合同名称
contract_type	Number	可选	1	合同类型：0质量保障协议、1销售合同、2采购合同
contract_status	Number	可选	1	合同状态：1:发起方待选章提交, 2:发起方审批中, 3:发起方审批不通过, 4:发起方待签章发送, 5:发起方签章失败, 6:发起方待发送, 7:接收方待查收, 8:接收方审批中, 9:接收方拒签, 10:接收方待签章, 11:接收方签章失败, 12:双方签署成功, 13:发起方已撤回
source	Number	可选	1	合同来源：0已方发起、1对方发起
send_ref_ent_id	String	可选	cb14553ed7654ff586b87b637ba23e2c	发件企业refentid
send_ent_name	String	可选	xx企业	发件企业名称
receive_ref_ent_id	String	可选	cb14553ed7654ff586b87b637ba23e2c	收件企业refentid
receive_ent_name	String	可选	xx企业	收件企业名称
partner_ref_ent_id	String	可选	cb14553ed7654ff586b87b637ba23e2c	往来单位的refentid
partner_ent_id	String	可选	cb14553ed7654ff586b87b637ba23e2c	往来单位的企业id
ref_ent_id	String	必须	32000000000012xxxx	企业refEntId
page	Number	必须	1	页
page_size	Number	必须	10	页

名称	类型	示例值	描述
result	ResultModel		结果
└ msg_code String SUCCESS 状态码 └ msg_info String 调用成功状态值 model Page 结果 result_list SyContractModel [] 合同列表 └ id Number 1 id └ gmt_create Date 2025-01-01 创建时间 └ contract_name String xx合同名称合同名称 └ contract_no String xx 合同编号 └ contract_type Number 1 合同类型：0, "质量保障协议", 1, "销售合同", 2, "采购合同" └ receive_ent_name String xx企业名称接受方企业名称 └ contract_source Number 1 合同来源：0己方发起， 1对方发起 └ contract_status Number 1 合同状态：1, "发起方待选章提交", 2, "发起方审批中", 3, "发起方审批不通过", 4, "发起方待签章发送", 5, "发起方签章失败", 6, "发起方待发送", 7, "接收方待查收", 8, "接收方审批中", 9, "接收方拒签", 10, "接收方待签章", 11, "接收方签章失败", 12, "双方签署成功", 13, "发起方已撤回" └ contract_status_desc String 双方签署成功合同状态描述 └ total_page Number 1 合同页数 └ expire_date String 2025-01-01 到期时间 └ send_ent_name String xx企业发件企业名称 └ complete_time Date xx 签署完成时间 └ send_time Date 2025-01-01 收发时间 └ create_person String 张三发起人 └ contract_type_desc String xx 合同类型描述 └ contract_source_desc String xx 合同来源描述 └ receive_ref_ent_id String 32000000000012xxxx 接收方企业refEntId └ receive_ent_id String 32000000000012xxxx 接收方企业entid └ send_ref_ent_id String 32000000000012xxxx 发送方企业refEntId └ send_ent_id String 32000000000012xxxx 接收方企业entid └ total_num Number 1 合同数量 └ response_success Boolean true 调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSynergySyContractListRequest req = new AlibabaAlihealthSynergySyContractListRequest();
req.setCreateStartTime("2025-01-01");
req.setCreateEndTime("2025-01-01");
req.setSendStartTime("2025-01-01");
req.setSendEndTime("2025-01-01");
req.setCompleteStartTime("2025-01-01");
req.setCompleteEndTime("2025-01-01");
req.setContractName("xx合同");
req.setContractType(1L);
req.setContractStatus(1L);
req.setSource(1L);
req.setSendRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setSendEntName("xx企业");
req.setReceiveRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setReceiveEntName("xx企业");
req.setPartnerRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setPartnerEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setRefEntId("32000000000012xxxx");
req.setPage(1L);
req.setPageSize(10L);
AlibabaAlihealthSynergySyContractListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSynergySyContractListRequest req = new AlibabaAlihealthSynergySyContractListRequest();
req.CreateStartTime = "2025-01-01";
req.CreateEndTime = "2025-01-01";
req.SendStartTime = "2025-01-01";
req.SendEndTime = "2025-01-01";
req.CompleteStartTime = "2025-01-01";
req.CompleteEndTime = "2025-01-01";
req.ContractName = "xx合同";
req.ContractType = 1L;
req.ContractStatus = 1L;
req.Source = 1L;
req.SendRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.SendEntName = "xx企业";
req.ReceiveRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.ReceiveEntName = "xx企业";
req.PartnerRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.PartnerEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.RefEntId = "32000000000012xxxx";
req.Page = 1L;
req.PageSize = 10L;
AlibabaAlihealthSynergySyContractListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSynergySyContractListRequest;
$req->setCreateStartTime("2025-01-01");
$req->setCreateEndTime("2025-01-01");
$req->setSendStartTime("2025-01-01");
$req->setSendEndTime("2025-01-01");
$req->setCompleteStartTime("2025-01-01");
$req->setCompleteEndTime("2025-01-01");
$req->setContractName("xx合同");
$req->setContractType("1");
$req->setContractStatus("1");
$req->setSource("1");
$req->setSendRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setSendEntName("xx企业");
$req->setReceiveRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setReceiveEntName("xx企业");
$req->setPartnerRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setPartnerEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setRefEntId("32000000000012xxxx");
$req->setPage("1");
$req->setPageSize("10");
$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.alihealth.synergy.sy.contract.list' \
-d 'partner_id=apidoc' \
-d 'sign=348ECD363482CA530B30CFD77D6690E2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-09-24+17%3A19%3A27' \
-d 'v=2.0' \
-d 'complete_end_time=2025-01-01' \
-d 'complete_start_time=2025-01-01' \
-d 'contract_name=xx%E5%90%88%E5%90%8C' \
-d 'contract_status=1' \
-d 'contract_type=1' \
-d 'create_end_time=2025-01-01' \
-d 'create_start_time=2025-01-01' \
-d 'page=1' \
-d 'page_size=10' \
-d 'partner_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'partner_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'receive_ent_name=xx%E4%BC%81%E4%B8%9A' \
-d 'receive_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'ref_ent_id=32000000000012xxxx' \
-d 'send_end_time=2025-01-01' \
-d 'send_ent_name=xx%E4%BC%81%E4%B8%9A' \
-d 'send_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'send_start_time=2025-01-01' \
-d 'source=1'

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

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

req.create_start_time="2025-01-01"
req.create_end_time="2025-01-01"
req.send_start_time="2025-01-01"
req.send_end_time="2025-01-01"
req.complete_start_time="2025-01-01"
req.complete_end_time="2025-01-01"
req.contract_name="xx合同"
req.contract_type=1
req.contract_status=1
req.source=1
req.send_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.send_ent_name="xx企业"
req.receive_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.receive_ent_name="xx企业"
req.partner_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.partner_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.ref_ent_id="32000000000012xxxx"
req.page=1
req.page_size=10
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.alihealth.synergy.sy.contract.list");
add_param(pRequest,"create_start_time","2025-01-01");
add_param(pRequest,"create_end_time","2025-01-01");
add_param(pRequest,"send_start_time","2025-01-01");
add_param(pRequest,"send_end_time","2025-01-01");
add_param(pRequest,"complete_start_time","2025-01-01");
add_param(pRequest,"complete_end_time","2025-01-01");
add_param(pRequest,"contract_name","xx合同");
add_param(pRequest,"contract_type","1");
add_param(pRequest,"contract_status","1");
add_param(pRequest,"source","1");
add_param(pRequest,"send_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"send_ent_name","xx企业");
add_param(pRequest,"receive_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"receive_ent_name","xx企业");
add_param(pRequest,"partner_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"partner_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"ref_ent_id","32000000000012xxxx");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
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.alihealth.synergy.sy.contract.list', {
	'create_start_time':'2025-01-01',
	'create_end_time':'2025-01-01',
	'send_start_time':'2025-01-01',
	'send_end_time':'2025-01-01',
	'complete_start_time':'2025-01-01',
	'complete_end_time':'2025-01-01',
	'contract_name':'xx合同',
	'contract_type':'1',
	'contract_status':'1',
	'source':'1',
	'send_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'send_ent_name':'xx企业',
	'receive_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'receive_ent_name':'xx企业',
	'partner_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'partner_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'ref_ent_id':'32000000000012xxxx',
	'page':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_synergy_sy_contract_list_response>
    <result>
        <msg_code>SUCCESS</msg_code>
        <msg_info>调用成功</msg_info>
        <model>
            <result_list>
                <sy_contract_model>
                    <id>1</id>
                    <gmt_create>2025-01-01</gmt_create>
                    <contract_name>xx合同名称</contract_name>
                    <contract_no>xx</contract_no>
                    <contract_type>1</contract_type>
                    <receive_ent_name>xx企业名称</receive_ent_name>
                    <contract_source>1</contract_source>
                    <contract_status>1</contract_status>
                    <contract_status_desc>双方签署成功</contract_status_desc>
                    <total_page>1</total_page>
                    <expire_date>2025-01-01</expire_date>
                    <send_ent_name>xx企业</send_ent_name>
                    <complete_time>xx</complete_time>
                    <send_time>2025-01-01</send_time>
                    <create_person>张三</create_person>
                    <contract_type_desc>xx</contract_type_desc>
                    <contract_source_desc>xx</contract_source_desc>
                    <receive_ref_ent_id>32000000000012xxxx</receive_ref_ent_id>
                    <receive_ent_id>32000000000012xxxx</receive_ent_id>
                    <send_ref_ent_id>32000000000012xxxx</send_ref_ent_id>
                    <send_ent_id>32000000000012xxxx</send_ent_id>
                </sy_contract_model>
            </result_list>
            <total_num>1</total_num>
        </model>
        <response_success>true</response_success>
    </result>
</alibaba_alihealth_synergy_sy_contract_list_response>

{
    "alibaba_alihealth_synergy_sy_contract_list_response":{
        "result":{
            "msg_code":"SUCCESS",
            "msg_info":"调用成功",
            "model":{
                "result_list":{
                    "sy_contract_model":[
                        {
                            "id":1,
                            "gmt_create":"2025-01-01",
                            "contract_name":"xx合同名称",
                            "contract_no":"xx",
                            "contract_type":1,
                            "receive_ent_name":"xx企业名称",
                            "contract_source":1,
                            "contract_status":1,
                            "contract_status_desc":"双方签署成功",
                            "total_page":1,
                            "expire_date":"2025-01-01",
                            "send_ent_name":"xx企业",
                            "complete_time":"xx",
                            "send_time":"2025-01-01",
                            "create_person":"张三",
                            "contract_type_desc":"xx",
                            "contract_source_desc":"xx",
                            "receive_ref_ent_id":"32000000000012xxxx",
                            "receive_ent_id":"32000000000012xxxx",
                            "send_ref_ent_id":"32000000000012xxxx",
                            "send_ent_id":"32000000000012xxxx"
                        }
                    ]
                },
                "total_num":1
            },
            "response_success":true
        }
    }
}

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.alihealth.synergy.sy.contract.list (电子首营合同列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ