淘宝开放平台

请求地址：

环境	HTTPS请求地址
正式环境	https://openapi.alipay.com/gateway.do

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	koubei.marketing.campaign.user.asset.query
format	String	否	40	仅支持JSON	JSON
charset	String	是	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	String	是	10	商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2	RSA2
sign	String	是	256	商户请求参数的签名串，详见签名	详见示例
timestamp	String	是	19	发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"	2014-07-24 03:07:50
version	String	是	3	调用的接口版本，固定为：1.0	1.0
auth_token	String	是	40	针对用户授权接口，获取用户相关数据时，用于标识用户授权关系。详见用户信息授权
app_auth_token	String	否	40	详见应用授权概述
biz_content	String	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

参数	类型	是否必填	最大长度	描述	示例值
scope	String	必须	32	查询范围:用户所有资产(USER_ALL_ASSET)，用户指定商户可用资产(USER_MERCHANT_ASSET),用户指定门店可用资产（USER_SHOP_ASSET）;指定USER_SHOP_ASSET必须传递shopid	USER_ALL_ASSET
shop_id	String	特殊可选	28	门店id，如果查询范围是门店，门店id不能为空	2016101800077000000019201464
page_num	Number	必须	5	页码	1
page_size	Number	必须	2	每页显示数目(最大查询50)	50

参数	类型	是否必填	最大长度	描述	示例值
code	String	是	-	网关返回码,详见文档	40004
msg	String	是	-	网关返回码描述,详见文档	Business Failed
sub_code	String	否	-	业务返回码,详见文档	ACQ.TRADE_HAS_SUCCESS
sub_msg	String	否	-	业务返回码描述,详见文档	交易已被支付
sign	String	是	-	签名,详见文档	DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

参数	类型	是否必填	最大长度	描述	示例值
voucher_asset_num	Number	选填	10	券资产数量	100
voucher_asset_list	VoucherDetailInfo []	选填	-	券资产详情信息
└ asset_id String 必填 256 资产id 201703250007300156220007T4UT └ voucher_type String 必填 32 券类型(ALIPAY_FIX_VOUCHER:全场券；ALIPAY_ITEM_VOUCHER：单品券,KOUBEI_BUY_EXCHANGE_VOUCHER:兑换券) ALIPAY_FIX_VOUCHER └ voucher_desc String 必填 256 全资产描述 5元代金券 └ use_condition String 必填 4096 券使用条件满20元可用 └ effect_time String 必填 256 资产生效时间 2017-01-01 00:00:00 └ invalid_time String 必填 256 资产过期时间 2017-07-01 00:00:00 time_rules UseTime [] 选填 4096 可用时段条款 └ dimension String 选填 32 券可用时段时间维度，目前支持周(W) W └ values String 选填 64 券可用时间维度值周维度的取值范围1-7(周一至周日)，多个可用时段用逗号分隔如"1,3,5"，对应周一，周三，周五可用 1,3,5 └ times String 选填 1024 券可用时间段可用时间段起止时间用逗号分隔，多个时间段之间用^分隔如, "16:00:00,20:00:00^21:00:00,22:00:00"表示16点至20点，21点至22点可用时间段不可重叠 16:00:00,20:00:00^21:00:00,22:00:00 forbbiden_time ForbbidenTime 选填 4096 不可用时间段（只支持到天） └ days String 选填 1024 不可用日期区间，仅支持到天不可用区间起止日期用逗号分隔，多个区间之间用^分隔如"2016-05-01,2016-05-03^2016-10-01,2016-10-07"表示2016年5月1日至5月3日，10月1日至10月7日券不可用 2016-03-03,2016-03-08^2016-10-01,2016-10-01 └ sku_codes String 选填 100000000 单品id中间用“,”分隔 1234,7272,2828 └ ext_info String 选填 4096 扩展字段信息，通过map存储的json串 {"key":"value"}

JAVA
.NET
PHP
HTTP请求源码

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignUserAssetQueryRequest request = new KoubeiMarketingCampaignUserAssetQueryRequest();
request.setBizContent("{" +
"\"scope\":\"USER_ALL_ASSET\"," +
"\"shop_id\":\"2016101800077000000019201464\"," +
"\"page_num\":1," +
"\"page_size\":50" +
"}");
KoubeiMarketingCampaignUserAssetQueryResponse response = alipayClient.execute(request,accessToken);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
KoubeiMarketingCampaignUserAssetQueryRequest  request= new KoubeiMarketingCampaignUserAssetQueryRequest() ;
request.BizContent="{" +
"\"scope\":\"USER_ALL_ASSET\"," +
"\"shop_id\":\"2016101800077000000019201464\"," +
"\"page_num\":1," +
"\"page_size\":50" +
"}";
KoubeiMarketingCampaignUserAssetQueryResponse response=client.execute(request,accessToken);
Console.WriteLine(response.Body);

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车，一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥，一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new KoubeiMarketingCampaignUserAssetQueryRequest ();
$request->setBizContent("{" .
"\"scope\":\"USER_ALL_ASSET\"," .
"\"shop_id\":\"2016101800077000000019201464\"," .
"\"page_num\":1," .
"\"page_size\":50" .
"}");
$result = $aop->execute ( $request , $accessToken ); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=koubei.marketing.campaign.user.asset.query&app_id=4225&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&auth_token=20130319e9b8d53d09034da8998caefa756c4006&biz_content=
  {
"scope":"USER_ALL_ASSET",
"shop_id":"2016101800077000000019201464",
"page_num":1,
"page_size":50
  }

//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

JSON示例

{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_marketing_campaign_user_asset_query_response":{
		"msg":"Success",
		"code":"10000",
		"voucher_asset_list":[
			{
				"time_rules":[
					{
						"times":"16:00:00,20:00:00^21:00:00,22:00:00",
						"values":"1,3,5",
						"dimension":"W"
					}
				],
				"voucher_type":"ALIPAY_FIX_VOUCHER",
				"voucher_desc":"5元代金券",
				"use_condition":"满20元可用",
				"invalid_time":"2017-07-01 00:00:00",
				"forbbiden_time":{
					"days":"2016-03-03,2016-03-08^2016-10-01,2016-10-01"
				},
				"asset_id":"201703250007300156220007T4UT",
				"sku_codes":"1234,7272,2828",
				"ext_info":"{\"key\":\"value\"}",
				"effect_time":"2017-01-01 00:00:00"
			}
		],
		"voucher_asset_num":100
	}
}

JSON示例

{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_marketing_campaign_user_asset_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

错误码	错误描述	解决方案
SYSTEM_ERROR	系统繁忙	稍后重试
INVALID_PARAMETER	参数有误	修改参数后重试
BIZ_ERROR	业务异常	用户授权TOKEN无效，稍后重试
SYSTEM_ERROR	系统繁忙	稍后重试
INVALID_PARAMETER	参数有误	检查参数后重试

公共错误码

营销API

koubei.marketing.campaign.user.asset.query (用户口碑优惠资产查询接口)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码