合作伙伴中心-查询已发放的优惠券:URI
下载合作伙伴中心用户手册完整版
URI
GET /v2/promotions/benefits/partner-coupons
参数说明请参见下表。
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
coupon_id |
否 |
String |
最大长度：64 |
优惠券ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
|
customer_id |
否 |
String |
最大长度：64 |
客户账号ID。您可以调用查询客户列表接口获取customer_id。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
|
order_id |
否 |
String |
最大长度：64 |
订单ID。 此参数不携带或携带值为空时，不作为筛选条件；携带值为null时，作为筛选条件；不支持携带值为空串。 |
|
coupon_type |
否 |
Integer |
- |
优惠券类型。
此参数不携带或携带值为空或携带值为null时，不作为筛选条件。 |
|
status |
否 |
Integer |
- |
客户优惠券实例状态：
此参数不携带或携带值为空或携带值为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。 输入这个条件，会查询出创建时间大于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 输入这个条件，会查询出创建时间小于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 输入这个条件，会查询出生效时间大于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 输入这个条件，会查询出生效时间小于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 输入这个条件，会查询出失效时间大于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 输入这个条件，会查询出失效时间小于这个时间的记录。 此参数不携带或携带值为空时，不作为筛选条件。 |
|
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。 |
|
indirect_partner_id |
否 |
String |
最大长度：64 |
云经销商ID。获取方法请参见查询云经销商列表。 华为云总经销商（一级经销商）查询云经销商发放给子客户的优惠券时，需要携带该参数；除此之外，此参数不做处理。否则只能查询发放给自己子客户的优惠券。 |
