koubei.marketing.campaign.user.asset.query(用户口碑优惠资产查询接口) 在线调试(沙箱环境)

用户口碑优惠资产查询接口: 查询基于用户维度的资产列表数据,可以指定门店或者查询商户下的优惠资产

公共参数

请求地址

环境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 344 商户请求参数的签名串,详见签名 详见示例
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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
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 可选 1e+08 单品id中间用“,”分隔 1234,7272,2828
ext_info String 可选 4096 扩展字段信息,通过map存储的json串 {"key":"value"}

请求示例

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("调用失败");
}

响应示例

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

异常示例

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

业务错误码

公共错误码

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