# 查询优惠券的发放回收记录-ListPartnerCouponsRecord #### 功能介绍 合作伙伴可查看给客户发放和回收优惠券的操作记录。 合作伙伴登录伙伴中心查看、导出代金券操作日志请参见[这里](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435103.html)。 #### 接口约束 该接口只允许使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListPartnerCouponsRecord)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 操作员账号调用当前API需经过授权，您可以通过伙伴中心为操作员赋予相应权限项来完成授权。有关如何为角色授权的详细信息，请参见[为组织人员分配权限](https://support.huaweicloud.com/usermanual-bpconsole/zh-cn_topic_0072435164.html)。 接口对应的权限项如下： | 权限项 | 权限项名称 | |:---|:---| | BPC_ITEM_SUBCUSTSERV_030102 | 销售-客户-券管理-代金券额度-查看操作记录 | #### URI GET /v2/promotions/benefits/partner-coupons/records/query 参数说明请参见下表。 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | operation_types | 否 | List\ | 最大个数：8 | 操作类型。 - 1：发放 - 2：手动回收 - 3：解绑自动回收 - 4：过期回收 - 5：退订回收 - 6：退款充值撤销 - 7：建立关联回收 - 8：切换关联模式自动回收 - 9：云经销商转移 此参数不携带时，不作为筛选条件；携带值为空列表时，作为筛选条件。 | | quota_id | 否 | String | 最大长度：64 | 额度ID。 请从"[查询优惠券额度-ListQuotaCoupons](https://support.huaweicloud.com/api-bpconsole/zh-cn_topic_0091566753.html)"接口的响应参数中获取。 此参数不携带或携带值为空时，不作为筛选条件；携带值为空串时，作为筛选条件。 | | quota_type | 否 | Integer | - | 额度类型。 - 0：代金券额度 - 1：现金券额度 此参数不携带或携带值为空时，不作为筛选条件。 | | coupon_ids | 否 | List\ | 最大个数：100 | 代金券ID列表。 请从"[发放优惠券-CreatePartnerCoupons](https://support.huaweicloud.com/api-bpconsole/mp_02002.html)"接口的响应参数中获取。 此参数不携带时，不作为筛选条件；携带值为空列表时，作为筛选条件。 | | customer_id | 否 | String | 最大长度：64 | 客户账号ID。您可以调用[查询客户列表-ListSubCustomers](https://support.huaweicloud.com/api-bpconsole/mc_00021.html)接口获取customer_id。 此参数不携带或携带值为空时，不作为筛选条件。 | | operation_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。 输入这个条件，会查询出操作时间大于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 | | operation_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。 输入这个条件，会查询出操作时间小于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 | | result | 否 | String | 最大长度：64 | 操作结果。 - 0：成功 - -1：失败（非0的记录） 此参数不携带或携带值为非枚举值时，不作为筛选条件。 | | offset | 否 | Integer | \[0-最大整数\] | 偏移量，从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。 | | indirect_partner_id | 否 | String | 最大长度：64 | 云经销商ID。获取方法请参见[查询云经销商列表](https://support.huaweicloud.com/api-bpconsole/espp_00003.html)。 华为云总经销商（一级经销商）查询云经销商发放给子客户的优惠券发放记录时，需要携带该参数。 | #### 请求消息 请求参数 无。 请求示例 ``` GET https://bss.myhuaweicloud.com/v2/promotions/benefits/partner-coupons/records/query?operation_types=1"a_id=CS19040119281JMYC"a_type=1&coupon_ids=CP180117115414HB5I&customer_id=1&operation_time_begin=2017-12-17T10:32:02Z&operation_time_end=2017-12-17T10:32:02Z&result=0&offset=0&limit=10&indirect_partner_id=5c2ec3bd80c9462aad432f5566e9feb1 HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 响应参数 | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：16 | 状态码。 具体请参见[状态码]。 | | error_msg | String | 最大长度：1024 | 错误描述信息。 | | total_count | Integer | - | 查询记录总数。 | | records | List\ | - | 日志记录列表。 具体请参见[表2]。 | 表2CouponRecordV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 该记录的ID。 | | operation_type | String | 操作类型。 - 1：发放 - 2：手动回收 - 3：解绑自动回收 - 4：过期回收 - 5：退订回收 - 6：退款充值撤销 - 7：建立关联回收 - 8：切换关联模式自动回收 - 9：云经销商转移 | | quota_id | String | 额度ID。 | | quota_type | Integer | 额度类型。 - 0：代金券额度 - 1：现金券额度 | | coupon_id | String | 代金券ID。 | | customer_id | String | 客户账号ID。 | | operation_amount | BigDecimal | 操作的面额值。单位：元。 发放时，等于面额值；回收时，指每次回收的具体值。 | | operation_time | String | 操作时间。 | | result | String | 操作结果。 - 0：成功 - -1：失败 | | remark | String | 操作记录中的备注。 | 响应示例 ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 2141, "records": [ { "id": "WCw34WJX2cx9jydKBJv", "operation_type": "1", "quota_id": "2020061902124506", "quota_type": 0, "coupon_id": "CP200619021225J7JJ", "customer_id": "068a6d2762fb42288536b6ba57d1ffae", "operation_amount": 19.01, "operation_time": "2020-06-19T02:12:26Z", "result": "0", "remark": null }, { "id": "tmxlGvcbSeTKphVksVQ", "operation_type": "2", "quota_id": "20190703022342029", "quota_type": 0, "coupon_id": "CP2006150657196F0M", "customer_id": "068a6d2762fb42288536b6ba57d1ffae", "operation_amount": 0.02, "operation_time": "2020-06-15T06:57:35Z", "result": "0", "remark": null }, { "id": "PXfd0d6VVSXzeKThP7o", "operation_type": "1", "quota_id": "20190703022342029", "quota_type": 0, "coupon_id": "CP2006150657196F0M", "customer_id": "068a6d2762fb42288536b6ba57d1ffae", "operation_amount": 0.02, "operation_time": "2020-06-15T06:57:20Z", "result": "0", "remark": "" } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 400 | CBC.99000037 | 您没有操作该云经销商的权限。 | | 403 | CBC.0151 | 访问拒绝。 | | 500 | CBC.0999 | 其他错误。 |