# 查询已发放的代金券额度-ListIssuedCouponQuotas #### 功能介绍 华为云总经销商（一级经销商）可以查看发放给云经销商（二级经销商）的代金券额度列表。 一级经销商登录伙伴中心，进入"客户业务\> 代金券管理"，选择"已发放代金券额度"可查看代金券额度列表。 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) 调用该接口之前，需通过客户经理联系华为运营人员，为合作伙伴设置代金券发放额度。 #### 接口约束 该接口只允许使用华为云总经销商的AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListIssuedCouponQuotas)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 操作员账号调用当前API需经过授权，您可以通过伙伴中心为操作员赋予相应权限项来完成授权。有关如何为角色授权的详细信息，请参见[为组织人员分配权限](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435164.html)。 接口对应的权限项如下： | 权限项 | 权限项名称 | |:---|:---| | BPC_ITEM_SUBCUSTSERV_030600 | 销售-客户-券管理-已发放代金券-查询已发放列表 | #### URI GET /v2/partners/issued-coupon-quotas 参数说明请参见下表。 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | quota_id | 否 | String | 最大长度：64 | 云经销商的代金券额度ID。获取方法请参见[查询优惠券额度](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0091566753.html)。 此参数不携带或携带值为空时，不作为筛选条件。 | | indirect_partner_id | 否 | String | 最大长度：64 | 云经销商ID。获取方法请参见[查询云经销商列表](https://support.huaweicloud.com/api-bpconsole/espp_00003.html)。 如果需要查询云经销商伙伴的代金券额度，必须携带该字段。除此之外，此参数不做处理。 | | 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\ | - | 额度记录列表。 具体请参见[表2]。 | 表2IssuedCouponQuota | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | 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 | - | 代金券额度的状态： - 0：正常 - 3：失效（包括过期失效和人工设置失效） - 4：额度调整中（伙伴可以查看该额度，但不能使用该额度发放代金券） - 5：冻结 - 6：回收 | | 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\ | - | 代金券额度上的限制属性，具体参见[表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。 | 表3QuotaLimitInfo | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | limit_key | String | 最大长度：128 | 属性key值。 | | limit_values | List\ | 最大个数：1000 | 属性值，具体参见[表4]。 | 表4LimitValue | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | value1 | String | 最大长度：256 | 属性值1。 | | value2 | String | 最大长度：256 | 属性值2。 | 表5QuotaLimitInfo的limit_key要求，该参数不出现，表示不限制 | key值 | 含义 | value1说明 | value2说明 | 备注 | |:---|:---|:---|:---|:---| | accumulativeConsumption | 关联前历史消费额度 | 数字 | - | 代金券额度 | | chargeScene | 计费场景 | 适用周期类型和计费模式： - 0：包年/包月-不限 - 1：包年/包月-年 - 2：包年/包月-月 - 5：按需 - 6：通用 - 7：一次性 - 8：预留实例 | 该值为空表示不限制 **包周期-年**：1/2/3 **包周期-月**：/1/2/3/4/5/6/7/8/9/10/11/12 | 代金券额度，现金券额度 | | serviceTypeWhiteList | 云服务类型白名单 | 云服务类型限制白名单。支持多个，此处为云服务类型编码。 当取值为空时，表示不限制云服务类型。 您可以调用[查询云服务类型列表-ListServiceTypes](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0000001256679455.html)接口获取。 | - | 代金券额度，现金券额度 | | productWhiteList | 产品白名单 | 产品限制白名单。支持多个，此处为产品ID。 当取值为空时，表示不限制产品。 | - | 代金券额度，现金券额度 | | serviceTypeBlackList | 云服务类型黑名单 | 云服务类型限制白名单。支持多个，此处为云服务类型编码。 当取值为空时，表示不限制云服务类型。 您可以调用[查询云服务类型列表-ListServiceTypes](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0000001256679455.html)接口获取。 | - | 代金券额度，现金券额度 | | productBlackList | 产品黑名单 | 产品限制黑名单。支持多个，此处为产品ID。 当取值为空时，表示不限制产品。 | - | 代金券额度 | | subscribeType | 订购类型 | 取值为： - 下单：new - 续订：renew - 变更：change | - | 现金券额度 | | maxDeductionRatio | 最大支付比例 | (0-1\] | - | 现金券额度 | | simultaneousUseWithPromotionProduct | 是否和促销组合产品同享 | - 0：否 - 1：是 | - | 代金券额度 | | simultaneousUseWithPromotionDiscount | 是否和促销折扣同享 | - 0：否 - 1：是 | - | 代金券额度 | | simultaneousUseWithDiscountCoupon | 是否和折扣券同享 | - 0：否 - 1：是 | - | 代金券额度 | | simultaneousUseWithEmpowerDiscount | 是否和折扣共享 | 代金券是否可以和授权折扣同享，该折扣仅包含伙伴折扣和商务折扣： - 0：否 - 1：是 | - | 代金券额度，现金券额度 | | associationType | 关联类型 | 子客户类型。 - 1：顾问销售 - 2：代售 - 3：不限制 默认不限制 | - | 代金券额度，现金券额度 | | isFirstAssociated | 首次关联开关 | 首次关联开关，默认0。 | - | 代金券额度 | | minBaseValueRatio | 优惠券使用比例限制 | 优惠券使用比例限制（最小门槛值百分比）。 | - | 代金券额度 | | canSetValidTime | 优惠券有效期可调整 | 伙伴发放优惠券时，是否可调整券的有效期。 - 0：不可调整（保持和优惠券额度有效期相同） - 1：可调整（可以在优惠券额度有效期内选择） 默认：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" } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |