淘宝开放平台

请求地址：

环境	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_contract_instance_request	CreateContractInstanceRequest	可选			调用入参
└ out_object_id String 可选 A1001 外部合同id，全局唯一 └ purchaser_id Number 可选 1001 采购者id └ purchaser_name String 可选采购者名称采购者名称 └ title String 可选合同名称合同名称 └ creator String 可选创建人创建人 └ creator_id Number 可选 1001 创建人id contract_template CreateContractTemplateRequest 可选合同模版 coupon_config_list Couponconfiglist [] 可选提货券配置列表 └ view_total_amount String 可选 1 提货券面额，单位：元，用于展示 └ view_amount String 可选 1 提货券面额，单位：元，用于展示 └ use_total_amount Number 可选 100 提货券总金额（单位：分） └ count Number 可选 1 面额相应数量 └ use_amount Number 可选 100 提货券面额（单位：分） └ second_sign_day String 可选乙方签约日期-日乙方签约日期-日 └ second_sign_month String 可选乙方签约日期-月乙方签约日期-月 └ second_sign_year String 可选乙方签约日期-年乙方签约日期-年 └ second_legal_person String 可选乙方法人乙方法人 └ first_sign_day String 可选甲方签约日期-日甲方签约日期-日 └ first_sign_month String 可选甲方签约日期-月甲方签约日期-月 └ first_sign_year String 可选甲方签约日期-年甲方签约日期-年 └ first_legal_person String 可选甲方法人甲方法人 └ second_account_no String 可选乙方银行账号乙方银行账号 └ second_bank_name String 可选乙方开户行乙方开户行 └ second_account_name String 可选乙方账户名称乙方账户名称 └ first_account_no String 可选甲方银行账号甲方银行账号 └ first_bank_name String 可选甲方开户行甲方开户行 └ first_account_name String 可选甲方账户名称甲方账户名称 └ discount String 可选甲方为提供乙方的折扣数甲方为提供乙方的折扣数 └ pay_time_out_day String 可选乙方支付甲方款项超时天数乙方支付甲方款项超时天数 └ invoice_type_simple_name String 可选发票类型简写发票类型简写 └ bond String 可选保证金（单位：元）保证金（单位：元） └ max_credit_amount String 可选最高赊销额度（单位：元）最高赊销额度（单位：元） └ contract_end_day String 可选合同有效期结束时间-日合同有效期结束时间-日 └ contract_end_month String 可选合同有效期结束时间-月合同有效期结束时间-月 └ contract_end_year String 可选合同有效期结束时间-年合同有效期结束时间-年 └ contract_start_day String 可选合同有效期开始时间-日合同有效期开始时间-日 └ contract_start_month String 可选合同有效期开始时间-月合同有效期开始时间-月 └ contract_start_year String 可选合同有效期开始时间-年合同有效期开始时间-年 └ coupon_end_day String 可选券使用的结束时间-日券使用的结束时间-日 └ coupon_end_month String 可选券使用的结束时间-月券使用的结束时间-月 └ coupon_end_year String 可选券使用的结束时间-年券使用的结束时间-年 └ coupon_start_day String 可选券使用的开始时间-日券使用的开始时间-日 └ coupon_start_month String 可选券使用的开始时间-月券使用的开始时间-月 └ coupon_start_year String 可选券使用的开始时间-年券使用的开始时间-年 └ poi_detail_address String 可选门店详细地址门店详细地址 └ poi_street String 可选门店所在街道门店所在街道 └ poi_area String 可选门店所在区门店所在区 └ poi_city String 可选门店所在市门店所在市 └ not_provider_item_infos String [] 可选 1 不提供的商品信息，传入格式同providerItemInfos └ provider_item_infos String [] 可选 2 提供的商品信息，需要传入一个String的List，每个字符串描述一个商品 └ poi_name String 可选大润发超市名称大润发超市名称 └ second_company_address String 可选乙方公司地址乙方公司地址 └ second_company_name String 可选乙方公司名称乙方公司名称 └ first_company_address String 可选甲方公司地址甲方公司地址 └ first_company_name String 可选甲方公司名称甲方公司名称

名称	类型	示例值	描述
result	ApiResult		返回结果
└ model Number 100001 合同ID └ err_code String SUCCESS 错误码 └ err_msg String 成功错误码说明 └ success Boolean ture 是否调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkCouponContractCreateRequest req = new AlibabaWdkCouponContractCreateRequest();
AlibabaWdkCouponContractCreateRequest.CreateContractInstanceRequest obj1 = new AlibabaWdkCouponContractCreateRequest.CreateContractInstanceRequest();
obj1.setOutObjectId("A1001");
obj1.setPurchaserId(1001L);
obj1.setPurchaserName("采购者名称");
obj1.setTitle("合同名称");
obj1.setCreator("创建人");
obj1.setCreatorId(1001L);
AlibabaWdkCouponContractCreateRequest.CreateContractTemplateRequest obj2 = new AlibabaWdkCouponContractCreateRequest.CreateContractTemplateRequest();
List<AlibabaWdkCouponContractCreateRequest.Couponconfiglist> list4 = new ArrayList<AlibabaWdkCouponContractCreateRequest.Couponconfiglist>();
AlibabaWdkCouponContractCreateRequest.Couponconfiglist obj5 = new AlibabaWdkCouponContractCreateRequest.Couponconfiglist();
list4.add(obj5);
obj5.setViewTotalAmount("1");
obj5.setViewAmount("1");
obj5.setUseTotalAmount(100L);
obj5.setCount(1L);
obj5.setUseAmount(100L);
obj2.setCouponConfigList(list4);
obj2.setSecondSignDay("乙方签约日期-日");
obj2.setSecondSignMonth("乙方签约日期-月");
obj2.setSecondSignYear("乙方签约日期-年");
obj2.setSecondLegalPerson("乙方法人");
obj2.setFirstSignDay("甲方签约日期-日");
obj2.setFirstSignMonth("甲方签约日期-月");
obj2.setFirstSignYear("甲方签约日期-年");
obj2.setFirstLegalPerson("甲方法人");
obj2.setSecondAccountNo("乙方银行账号");
obj2.setSecondBankName("乙方开户行");
obj2.setSecondAccountName("乙方账户名称");
obj2.setFirstAccountNo("甲方银行账号");
obj2.setFirstBankName("甲方开户行");
obj2.setFirstAccountName("甲方账户名称");
obj2.setDiscount("甲方为提供乙方的折扣数");
obj2.setPayTimeOutDay("乙方支付甲方款项超时天数");
obj2.setInvoiceTypeSimpleName("发票类型简写");
obj2.setBond("保证金（单位：元）");
obj2.setMaxCreditAmount("最高赊销额度（单位：元）");
obj2.setContractEndDay("合同有效期结束时间-日");
obj2.setContractEndMonth("合同有效期结束时间-月");
obj2.setContractEndYear("合同有效期结束时间-年");
obj2.setContractStartDay("合同有效期开始时间-日");
obj2.setContractStartMonth("合同有效期开始时间-月");
obj2.setContractStartYear("合同有效期开始时间-年");
obj2.setCouponEndDay("券使用的结束时间-日");
obj2.setCouponEndMonth("券使用的结束时间-月");
obj2.setCouponEndYear("券使用的结束时间-年");
obj2.setCouponStartDay("券使用的开始时间-日");
obj2.setCouponStartMonth("券使用的开始时间-月");
obj2.setCouponStartYear("券使用的开始时间-年");
obj2.setPoiDetailAddress("门店详细地址");
obj2.setPoiStreet("门店所在街道");
obj2.setPoiArea("门店所在区");
obj2.setPoiCity("门店所在市");
obj2.setNotProviderItemInfos("1");
obj2.setProviderItemInfos("2");
obj2.setPoiName("大润发超市名称");
obj2.setSecondCompanyAddress("乙方公司地址");
obj2.setSecondCompanyName("乙方公司名称");
obj2.setFirstCompanyAddress("甲方公司地址");
obj2.setFirstCompanyName("甲方公司名称");
obj1.setContractTemplate(obj2);
req.setCreateContractInstanceRequest(obj1);
AlibabaWdkCouponContractCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkCouponContractCreateRequest req = new AlibabaWdkCouponContractCreateRequest();
AlibabaWdkCouponContractCreateRequest.CreateContractInstanceRequestDomain obj1 = new AlibabaWdkCouponContractCreateRequest.CreateContractInstanceRequestDomain();
obj1.OutObjectId = "A1001";
obj1.PurchaserId = 1001L;
obj1.PurchaserName = "采购者名称";
obj1.Title = "合同名称";
obj1.Creator = "创建人";
obj1.CreatorId = 1001L;
AlibabaWdkCouponContractCreateRequest.CreateContractTemplateRequestDomain obj2 = new AlibabaWdkCouponContractCreateRequest.CreateContractTemplateRequestDomain();
List<AlibabaWdkCouponContractCreateRequest.CouponconfiglistDomain> list4 = new List<AlibabaWdkCouponContractCreateRequest.CouponconfiglistDomain>();
AlibabaWdkCouponContractCreateRequest.CouponconfiglistDomain obj5 = new AlibabaWdkCouponContractCreateRequest.CouponconfiglistDomain();
list4.Add(obj5);
obj5.ViewTotalAmount = "1";
obj5.ViewAmount = "1";
obj5.UseTotalAmount = 100L;
obj5.Count = 1L;
obj5.UseAmount = 100L;
obj2.CouponConfigList= list4;
obj2.SecondSignDay = "乙方签约日期-日";
obj2.SecondSignMonth = "乙方签约日期-月";
obj2.SecondSignYear = "乙方签约日期-年";
obj2.SecondLegalPerson = "乙方法人";
obj2.FirstSignDay = "甲方签约日期-日";
obj2.FirstSignMonth = "甲方签约日期-月";
obj2.FirstSignYear = "甲方签约日期-年";
obj2.FirstLegalPerson = "甲方法人";
obj2.SecondAccountNo = "乙方银行账号";
obj2.SecondBankName = "乙方开户行";
obj2.SecondAccountName = "乙方账户名称";
obj2.FirstAccountNo = "甲方银行账号";
obj2.FirstBankName = "甲方开户行";
obj2.FirstAccountName = "甲方账户名称";
obj2.Discount = "甲方为提供乙方的折扣数";
obj2.PayTimeOutDay = "乙方支付甲方款项超时天数";
obj2.InvoiceTypeSimpleName = "发票类型简写";
obj2.Bond = "保证金（单位：元）";
obj2.MaxCreditAmount = "最高赊销额度（单位：元）";
obj2.ContractEndDay = "合同有效期结束时间-日";
obj2.ContractEndMonth = "合同有效期结束时间-月";
obj2.ContractEndYear = "合同有效期结束时间-年";
obj2.ContractStartDay = "合同有效期开始时间-日";
obj2.ContractStartMonth = "合同有效期开始时间-月";
obj2.ContractStartYear = "合同有效期开始时间-年";
obj2.CouponEndDay = "券使用的结束时间-日";
obj2.CouponEndMonth = "券使用的结束时间-月";
obj2.CouponEndYear = "券使用的结束时间-年";
obj2.CouponStartDay = "券使用的开始时间-日";
obj2.CouponStartMonth = "券使用的开始时间-月";
obj2.CouponStartYear = "券使用的开始时间-年";
obj2.PoiDetailAddress = "门店详细地址";
obj2.PoiStreet = "门店所在街道";
obj2.PoiArea = "门店所在区";
obj2.PoiCity = "门店所在市";
obj2.NotProviderItemInfos = "1";
obj2.ProviderItemInfos = "2";
obj2.PoiName = "大润发超市名称";
obj2.SecondCompanyAddress = "乙方公司地址";
obj2.SecondCompanyName = "乙方公司名称";
obj2.FirstCompanyAddress = "甲方公司地址";
obj2.FirstCompanyName = "甲方公司名称";
obj1.ContractTemplate= obj2;
req.CreateContractInstanceRequest_ = obj1;
AlibabaWdkCouponContractCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkCouponContractCreateRequest;
$create_contract_instance_request = new CreateContractInstanceRequest;
$create_contract_instance_request->out_object_id="A1001";
$create_contract_instance_request->purchaser_id="1001";
$create_contract_instance_request->purchaser_name="采购者名称";
$create_contract_instance_request->title="合同名称";
$create_contract_instance_request->creator="创建人";
$create_contract_instance_request->creator_id="1001";
$contract_template = new CreateContractTemplateRequest;
$coupon_config_list = new Couponconfiglist;
$coupon_config_list->view_total_amount="1";
$coupon_config_list->view_amount="1";
$coupon_config_list->use_total_amount="100";
$coupon_config_list->count="1";
$coupon_config_list->use_amount="100";
$contract_template->coupon_config_list = $coupon_config_list;
$contract_template->second_sign_day="乙方签约日期-日";
$contract_template->second_sign_month="乙方签约日期-月";
$contract_template->second_sign_year="乙方签约日期-年";
$contract_template->second_legal_person="乙方法人";
$contract_template->first_sign_day="甲方签约日期-日";
$contract_template->first_sign_month="甲方签约日期-月";
$contract_template->first_sign_year="甲方签约日期-年";
$contract_template->first_legal_person="甲方法人";
$contract_template->second_account_no="乙方银行账号";
$contract_template->second_bank_name="乙方开户行";
$contract_template->second_account_name="乙方账户名称";
$contract_template->first_account_no="甲方银行账号";
$contract_template->first_bank_name="甲方开户行";
$contract_template->first_account_name="甲方账户名称";
$contract_template->discount="甲方为提供乙方的折扣数";
$contract_template->pay_time_out_day="乙方支付甲方款项超时天数";
$contract_template->invoice_type_simple_name="发票类型简写";
$contract_template->bond="保证金（单位：元）";
$contract_template->max_credit_amount="最高赊销额度（单位：元）";
$contract_template->contract_end_day="合同有效期结束时间-日";
$contract_template->contract_end_month="合同有效期结束时间-月";
$contract_template->contract_end_year="合同有效期结束时间-年";
$contract_template->contract_start_day="合同有效期开始时间-日";
$contract_template->contract_start_month="合同有效期开始时间-月";
$contract_template->contract_start_year="合同有效期开始时间-年";
$contract_template->coupon_end_day="券使用的结束时间-日";
$contract_template->coupon_end_month="券使用的结束时间-月";
$contract_template->coupon_end_year="券使用的结束时间-年";
$contract_template->coupon_start_day="券使用的开始时间-日";
$contract_template->coupon_start_month="券使用的开始时间-月";
$contract_template->coupon_start_year="券使用的开始时间-年";
$contract_template->poi_detail_address="门店详细地址";
$contract_template->poi_street="门店所在街道";
$contract_template->poi_area="门店所在区";
$contract_template->poi_city="门店所在市";
$contract_template->not_provider_item_infos="1";
$contract_template->provider_item_infos="2";
$contract_template->poi_name="大润发超市名称";
$contract_template->second_company_address="乙方公司地址";
$contract_template->second_company_name="乙方公司名称";
$contract_template->first_company_address="甲方公司地址";
$contract_template->first_company_name="甲方公司名称";
$create_contract_instance_request->contract_template = $contract_template;
$req->setCreateContractInstanceRequest(json_encode($create_contract_instance_request));
$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.wdk.coupon.contract.create' \
-d 'partner_id=apidoc' \
-d 'session=6391b8e3-8e8c-4bd6-9f05-391c07949932' \
-d 'sign=BE48FB692D32A739D41CF4EA64E86031' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+14%3A56%3A27' \
-d 'v=2.0' \
-d 'create_contract_instance_request=null'

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

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

req.create_contract_instance_request=""
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.wdk.coupon.contract.create");
add_param(pRequest,"create_contract_instance_request","数据结构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.wdk.coupon.contract.create', {
	'create_contract_instance_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_coupon_contract_create_response>
    <result>
        <model>100001</model>
        <err_code>SUCCESS</err_code>
        <err_msg>成功</err_msg>
        <success>ture</success>
    </result>
</alibaba_wdk_coupon_contract_create_response>

{
    "alibaba_wdk_coupon_contract_create_response":{
        "result":{
            "model":100001,
            "err_code":"SUCCESS",
            "err_msg":"成功",
            "success":ture
        }
    }
}

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.wdk.coupon.contract.create (营销券合同创建接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ