alipay.marketing.voucher.templatedetail.query(查询模板详情) 在线调试(沙箱环境)

查询模板的详细信息,包含准实时的汇总信息

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.voucher.templatedetail.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
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必选 32 券模板ID 20140601000730010040000000EB

响应参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必填 32 券模板ID 20140601000730010040000000EB
voucher_type String 必填 16 券类型。可枚举,暂时只支持代金券(FIX_VOUCHER)、无资金单品代金券(ITEM_CASHLESS_FIX_VOUCHER)、无资金单品折扣券(ITEM_CASHLESS_DISCOUNT_VOUCHER)、无资金单品特价券(ITEM_CASHLESS_SPE_VOUCHER) fix
voucher_name String 必填 32 券名称 四川移动5元代金券
publish_start_time Date 必填 19 发放开始时间,格式为:yyyy-MM-dd HH:mm:ss 2017-01-01 00:00:01
publish_end_time Date 必填 19 发放结束时间,格式为:yyyy-MM-dd HH:mm:ss 2017-01-29 23:59:59
status String 必填 1 模板状态,可枚举。分别为‘草稿’(I)、‘生效’(S)、‘删除’(D)和‘过期’(E) E
voucher_valid_period String 必填 128 券有效期。有两种类型:绝对时间和相对时间。使用JSON字符串表示。绝对时间有3个key:type、start、end,type取值固定为"ABSOLUTE",start和end分别表示券生效时间和失效时间,格式为yyyy-MM-dd HH:mm:ss。绝对时间示例:{"type": "ABSOLUTE", "start": "2017-01-10 00:00:00", "end": "2017-01-13 23:59:59"}。相对时间有3个key:type、duration、unit,type取值固定为"RELATIVE",duration表示从发券时间开始到往后推duration个单位时间为止作为券的使用有效期,unit表示有效时间单位,有效时间单位可枚举:MINUTE, HOUR, DAY。示例:{"type": "RELATIVE", "duration": 1 , "unit": "DAY" },如果此刻发券,那么该券从现在开始生效1(duration)天(unit)后失效。 {"type": "ABSOLUTE", "start": "2017-01-10 00:00:00", "end": "2017-01-13 23:59:59"}
floor_amount Price 必填 10 最低额度。券的最低使用门槛金额,只有订单金额大于等于最低额度时券才能使用。币种为人民币,单位为元。该数值不小于0,小数点以后最多保留两位。 50.0
voucher_description String 必填 256 券使用说明 1. xxxxx 2. xxxxx 3. xxxxx
amount Price 必填 10 面额。每张代金券可以抵扣的金额。币种为人民币,单位为元。该数值不小于0,小数点以后最多两位。当券类型为无资金单品券(ITEM_CASHLESS_FIX_VOUCHER、ITEM_CASHLESS_DISCOUNT_VOUCHER、ITEM_CASHLESS_SPE_VOUCHER)时,暂不支持查询本参数,出参为0 8.8
voucher_quantity Number 必填 10 拟发行券的数量。单位为张。该数值是大于0的整数。 1000000
total_amount Price 必填 10 总金额面额。币种为人民币,单位为元。该数值不小于0,小数点以后最多两位。仅代金券有效。当券类型为无资金单品券(ITEM_CASHLESS_FIX_VOUCHER、ITEM_CASHLESS_DISCOUNT_VOUCHER、ITEM_CASHLESS_SPE_VOUCHER)时,暂不支持查询本参数,出参为0 8800000
publish_count Number 必填 10 已发放张数。单位为张。该数值是大于0的整数。 500
publish_amount Price 必填 10 已发放总金额。币种为人民币,单位为元。该数值不小于0,小数点以后最多两位。 4400
used_count Number 必填 10 已使用张数。单位为张。该数值是大于0的整数。 20
used_amount Price 必填 10 已使用总金额。币种为人民币,单位为元。该数值不小于0,小数点以后最多两位。 176
recycle_amount Price 选填 10 退回金额。币种为人民币,单位为元。该数值不小于0,小数点以后最多两位。 8799824

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingVoucherTemplatedetailQueryRequest request = new AlipayMarketingVoucherTemplatedetailQueryRequest();
request.setBizContent("{" +
"\"template_id\":\"20140601000730010040000000EB\"" +
"  }");
AlipayMarketingVoucherTemplatedetailQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_voucher_templatedetail_query_response": {
        "code": "10000",
        "msg": "Success",
        "template_id": "20140601000730010040000000EB",
        "voucher_type": "fix",
        "voucher_name": "四川移动5元代金券",
        "publish_start_time": "2017-01-01 00:00:01",
        "publish_end_time": "2017-01-29 23:59:59",
        "status": "E",
        "voucher_valid_period": "{\"type\": \"ABSOLUTE\", \"start\": \"2017-01-10 00:00:00\", \"end\": \"2017-01-13 23:59:59\"}",
        "floor_amount": 50,
        "voucher_description": "1. xxxxx\r\n2. xxxxx\r\n3. xxxxx",
        "amount": 8.8,
        "voucher_quantity": 1000000,
        "total_amount": 8800000,
        "publish_count": 500,
        "publish_amount": 4400,
        "used_count": 20,
        "used_amount": 176,
        "recycle_amount": 8799824
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TEMPLATE_NOT_EXIST 模板不存在 请仔细确认查询的模板ID是否存在
PERMISSION_DENIED 没有查询模板权限 只能查询自己创建的模板
INVALID_PARAMETER 参数有误 检查请求参数格式与接口文档是否匹配
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
onlineServer