查询已发放的代金券额度
功能介绍
华为云总经销商(一级经销商)可以查看发放给云经销商(二级经销商)的代金券额度列表。
一级经销商登录伙伴中心,进入“客户业务 > 代金券管理”,选择“已发放代金券额度”可查看代金券额度列表。
调用该接口之前,需通过客户经理联系华为运营人员,为合作伙伴设置代金券发放额度。
接口约束
该接口只允许使用华为云总经销商的AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/partners/issued-coupon-quotas
参数说明请参见下表。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
quota_id |
否 |
String |
最大长度:64 |
云经销商的代金券额度ID。获取方法请参见查询优惠券额度。 此参数不携带或携带值为空时,不作为筛选条件。 |
indirect_partner_id |
否 |
String |
最大长度:64 |
云经销商ID。获取方法请参见查询云经销商列表。 如果需要查询云经销商伙伴的代金券额度,必须携带该字段。除此之外,此参数不做处理。 |
parent_quota_id |
否 |
String |
最大长度:64 |
父额度ID,即华为云总经销商用于发放给云经销商代金券额度的额度ID。 此参数不携带时,不作为筛选条件;携带值为空或携带值为空串时,作为筛选条件。 |
offset |
否 |
Integer |
[0-最大整数] |
偏移量,从0开始。默认值为0。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 |
limit |
否 |
Integer |
[1-100] |
每次查询记录数。默认值为10。 |
请求消息
请求参数
无。
请求示例
GET https://bss.myhuaweicloud.com/v2/partners/issued-coupon-quotas?quota_id=2020061902584509&indirect_partner_id=05bad7a90700d5bf0ff6c00ae40d0ca0&parent_quota_id=2020010206413502&offset=0&limit=10 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。具体请参见状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度:1000 |
错误描述信息。只有失败才会返回这个参数。 |
total_count |
Integer |
- |
查询的记录总数。 |
quotas |
List<IssuedCouponQuota> |
- |
额度记录列表。 具体请参见表2。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
quota_id |
String |
最大长度:64 |
已发放的代金券额度ID。 |
quota_type |
Integer |
- |
额度类型: 0:代金券额度 |
create_time |
String |
最大长度:20 |
创建时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
last_update_time |
String |
最大长度:20 |
最后一次更新时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
quota_value |
BigDecimal |
- |
代金券额度的值,精确到小数点后2位。 |
quota_status |
Integer |
- |
代金券额度的状态:
|
balance |
BigDecimal |
- |
剩余的代金券额度,精确到小数点后2位。 |
measure_id |
Integer |
- |
代金券额度的单位。 1:元。 |
currency |
String |
最大长度:4 |
币种。 CNY:人民币 |
effective_time |
String |
最大长度:20 |
生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
expire_time |
String |
最大长度:20 |
失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
limit_infos |
List<QuotaLimitInfo> |
- |
代金券额度上的限制属性,具体参见表3。 |
indirect_partner_id |
String |
最大长度:64 |
云经销商ID。 |
indirect_partner_account_name |
String |
最大长度:64 |
云经销商账号名。 |
indirect_partner_name |
String |
最大长度:256 |
云经销商名称。 |
parent_quota_id |
String |
最大长度:64 |
父额度ID,即华为云总经销商用于发放给云经销商代金券额度的额度ID。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
limit_key |
String |
最大长度:128 |
属性key值。 |
limit_values |
List<LimitValue> |
最大个数:1000 |
属性值,具体参见表4。 |
key值 |
含义 |
value1说明 |
value2说明 |
备注 |
---|---|---|---|---|
accumulativeConsumption |
关联前历史消费额度 |
数字 |
- |
代金券额度 |
chargeScene |
计费场景 |
适用周期类型和计费模式:
|
该值为空表示不限制 包周期-年:1/2/3 包周期-月:/1/2/3/4/5/6/7/8/9/10/11/12 |
代金券额度,现金券额度 |
serviceTypeWhiteList |
云服务类型白名单 |
云服务类型限制白名单。支持多个,此处为云服务类型编码。 当取值为空时,表示不限制云服务类型。 您可以调用查询云服务类型列表接口获取。 |
- |
代金券额度,现金券额度 |
productWhiteList |
产品白名单 |
产品限制白名单。支持多个,此处为产品ID。 当取值为空时,表示不限制产品。 |
- |
代金券额度,现金券额度 |
serviceTypeBlackList |
云服务类型黑名单 |
云服务类型限制白名单。支持多个,此处为云服务类型编码。 当取值为空时,表示不限制云服务类型。 您可以调用查询云服务类型列表接口获取。 |
- |
代金券额度,现金券额度 |
productBlackList |
产品黑名单 |
产品限制黑名单。支持多个,此处为产品ID。 当取值为空时,表示不限制产品。 |
- |
代金券额度 |
subscribeType |
订购类型 |
取值为:
|
- |
现金券额度 |
maxDeductionRatio |
最大支付比例 |
(0-1] |
- |
现金券额度 |
simultaneousUseWithPromotionProduct |
是否和促销组合产品同享 |
|
- |
代金券额度 |
simultaneousUseWithPromotionDiscount |
是否和促销折扣同享 |
|
- |
代金券额度 |
simultaneousUseWithDiscountCoupon |
是否和折扣券同享 |
|
- |
代金券额度 |
simultaneousUseWithEmpowerDiscount |
是否和折扣共享 |
代金券是否可以和授权折扣同享,该折扣仅包含伙伴折扣和商务折扣:
|
- |
代金券额度,现金券额度 |
associationType |
关联类型 |
子客户类型。
默认不限制 |
- |
代金券额度,现金券额度 |
isFirstAssociated |
首次关联开关 |
首次关联开关,默认0。 |
- |
代金券额度 |
minBaseValueRatio |
优惠券使用比例限制 |
优惠券使用比例限制(最小门槛值百分比)。 |
- |
代金券额度 |
canSetValidTime |
优惠券有效期可调整 |
伙伴发放优惠券时,是否可调整券的有效期。
默认:0(不可设置) |
- |
代金券额度,现金券额度 |
响应示例
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "quotas": [ { "quota_id": "2020061902584509", "quota_type": 0, "create_time": "2020-06-19T02:58:54Z", "last_update_time": "2020-06-19T02:59:25Z", "quota_value": 0.01, "quota_status": 6, "balance": 0.01, "measure_id": 1, "currency": "CNY", "effective_time": "2020-01-01T16:00:00Z", "expire_time": "2020-12-31T15:59:59Z", "limit_infos": [ { "limit_key": "associationType", "limit_values": [ { "value1": "3", "value2": null } ] }, { "limit_key": "couponFaceValueMax", "limit_values": [ { "value1": "-1.00", "value2": null } ] }, { "limit_key": "couponFaceValueMin", "limit_values": [ { "value1": "-1.00", "value2": null } ] }, { "limit_key": "couponNumMax", "limit_values": [ { "value1": "-1", "value2": null } ] }, { "limit_key": "couponSummaryValueMax", "limit_values": [ { "value1": "-1.00", "value2": null } ] }, { "limit_key": "isFirstAssociated", "limit_values": [ { "value1": "0", "value2": null } ] }, { "limit_key": "minBaseValueRatio", "limit_values": [ { "value1": "-1", "value2": null } ] }, { "limit_key": "minConsumeDiscount", "limit_values": [ { "value1": "-1.00000", "value2": null } ] }, { "limit_key": "simultaneousUseWithEmpowerDiscount", "limit_values": [ { "value1": "0", "value2": null } ] }, { "limit_key": "canSetValidTime", "limit_values": [ { "value1": "0", "value2": null } ] }, { "limit_key": "simultaneousUseWithDiscountCoupon", "limit_values": [ { "value1": "0", "value2": null } ] }, { "limit_key": "chargeScene", "limit_values": [ { "value1": "1", "value2": "1" }, { "value1": "5", "value2": "-1" }, { "value1": "2", "value2": "-1" } ] }, { "limit_key": "simultaneousUseWithPromotionDiscount", "limit_values": [ { "value1": "0", "value2": null } ] }, { "limit_key": "simultaneousUseWithPromotionProduct", "limit_values": [ { "value1": "0", "value2": null } ] } ], "indirect_partner_id": "05bad7a90700d5bf0ff6c00ae40d0ca0", "indirect_partner_account_name": "d_1945", "indirect_partner_name": "Partner1945", "parent_quota_id": "2020010206413502" } ] }