查询优惠券额度
接口约束
- 该接口只能给合作伙伴使用，调用的时候必须传递合作伙伴的AK/SK或者Token。
- 调用该接口之前，需通过客户经理联系华为运营人员，为合作伙伴设置优惠券发放额度。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/partners/coupon-quotas/query
请求消息
请求参数
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
quota_type |
否 |
Integer |
- |
优惠券额度的类型。
此参数不携带或携带值为空串或携带值为null时，默认值为“0：代金券额度”。 |
quota_ids |
否 |
List<String> |
最大个数：50 |
优惠券额度ID列表。 此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件。 |
quota_status_list |
否 |
List<Integer> |
最大个数：5 |
优惠券额度状态列表。
此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件。 |
create_time_begin |
否 |
String |
最大长度：20 |
创建时间（开始）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出创建时间大于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
create_time_end |
否 |
String |
最大长度：20 |
创建时间（结束）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出创建时间小于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
effective_time_begin |
否 |
String |
最大长度：20 |
生效时间（开始）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出生效时间大于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件；不支持携带值为空串。 |
effective_time_end |
否 |
String |
最大长度：20 |
生效时间（结束）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出生效时间小于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件。不支持携带值为空串。 |
expire_time_begin |
否 |
String |
最大长度：20 |
失效时间（开始）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出失效时间大于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件。不支持携带值为空串。 |
expire_time_end |
否 |
String |
最大长度：20 |
失效时间（结束）。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 其中，HH范围是0～23，mm和ss范围是0～59。 输入这个条件，会查询出失效时间小于这个时间的记录。 此参数不携带或携带值为null时，不作为筛选条件。不支持携带值为空串。 |
offset |
否 |
Integer |
[0-2147483646] |
偏移量，从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。 此参数不携带时，取默认值10；不支持携带值为空串或携带值为null。 |
indirect_partner_id |
否 |
String |
最大值：64 |
云经销商（二级经销商）ID。 华为云总经销商（一级经销商）查询云经销商的优惠券额度时，需要携带该参数；否则只能查询自己的优惠券额度。 |
请求示例
POST https://bss.myhuaweicloud.com/v2/partners/coupon-quotas/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "quota_type": 1, "create_time_begin": "2017-12-17T10:32:02Z", "create_time_end": "2222-12-17T10:32:02Z", "effective_time_begin": "2019-05-06T08:05:01Z", "effective_time_end": "2222-05-06T08:05:01Z", "expire_time_begin": "2019-05-06T08:05:01Z", "expire_time_end": "2222-05-06T08:05:01Z", "offset": 0, "limit": 10 }
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
error_code |
String |
最大长度：20 |
状态码。具体请参见状态码。只有失败才会返回这个参数。 |
error_msg |
String |
最大长度：1000 |
错误描述信息。只有失败才会返回这个参数。 |
total_count |
Integer |
- |
查询总数。 |
quotas |
List<CouponQuotaV2> |
- |
额度记录列表。 具体请参见表1。 |
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
quota_id |
String |
最大长度：64 |
优惠券额度ID。 |
quota_type |
Integer |
- |
优惠券额度的类型：
|
create_time |
String |
最大长度：64 |
创建时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。 |
last_update_time |
String |
最大长度：64 |
最后一次更新时间。 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> |
- |
优惠券额度上的限制属性，具体参见表2。 |
key值 |
含义 |
value1说明 |
value2说明 |
备注 |
|---|---|---|---|---|
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": 3,
"quotas": [
{
"quota_id": "2020040206297606",
"quota_type": 1,
"create_time": "2020-04-02T06:29:47Z",
"last_update_time": "2020-04-02T06:29:47Z",
"quota_value": 2000.0,
"quota_status": 0,
"balance": 2000.0,
"measure_id": 1,
"currency": "CNY",
"effective_time": "2020-04-01T00:00:00Z",
"expire_time": "2021-03-31T15:59:59Z",
"limit_infos": [
{
"limit_key": "associationType",
"limit_values": [
{
"value1": "3",
"value2": null
}
]
},
{
"limit_key": "isOnlyForStrictSelected",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "simultaneousUseWithEmpowerDiscount",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "chargeScene",
"limit_values": [
{
"value1": "6",
"value2": null
}
]
}
]
},
{
"quota_id": "2020040206177605",
"quota_type": 1,
"create_time": "2020-04-02T06:17:03Z",
"last_update_time": "2020-04-02T06:17:03Z",
"quota_value": 2000.0,
"quota_status": 0,
"balance": 2000.0,
"measure_id": 1,
"currency": "CNY",
"effective_time": "2020-04-01T00:00:00Z",
"expire_time": "2021-03-31T15:59:59Z",
"limit_infos": [
{
"limit_key": "associationType",
"limit_values": [
{
"value1": "3",
"value2": null
}
]
},
{
"limit_key": "isOnlyForStrictSelected",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "simultaneousUseWithEmpowerDiscount",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "chargeScene",
"limit_values": [
{
"value1": "6",
"value2": null
}
]
}
]
},
{
"quota_id": "2020040206167604",
"quota_type": 1,
"create_time": "2020-04-02T06:16:14Z",
"last_update_time": "2020-04-02T06:16:14Z",
"quota_value": 10000.03,
"quota_status": 0,
"balance": 10000.03,
"measure_id": 1,
"currency": "CNY",
"effective_time": "2020-04-01T00:00:00Z",
"expire_time": "2021-03-31T15:59:59Z",
"limit_infos": [
{
"limit_key": "associationType",
"limit_values": [
{
"value1": "3",
"value2": null
}
]
},
{
"limit_key": "isOnlyForStrictSelected",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "simultaneousUseWithEmpowerDiscount",
"limit_values": [
{
"value1": "1",
"value2": null
}
]
},
{
"limit_key": "chargeScene",
"limit_values": [
{
"value1": "6",
"value2": null
}
]
}
]
}
]
}
