请登录后查看
ListIssuedPartnerCoupons
查询已发放的优惠券
合作伙伴可以查询已发放的优惠券列表。
伙伴登录伙伴中心,进入“客户业务** **> 代金券管理”,选择“已发放代金券”页签,即可查询已发放的代金券。
伙伴登录伙伴中心,进入“客户业务 > 现金券管理”,选择“已发放现金券”页签,即可查询已发放的现金券。
说明:
- 只可查到失效时间在12个月内的代金/现金劵。
- 在API只可以查询代售子客户已发放的代金/现金劵,在伙伴中心可以查询代售和顾问销售已发放的代金/现金劵,对比一致性时需要注意关联模式是否一致。
该接口只能给合作伙伴使用,调用的时候必须传递合作伙伴的AK/SK或者Token。
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
X-Auth-Token | string | header | 是 | 合作伙伴Token调用 |
indirect_partner_id | string | query | 否 | 云经销商ID。获取方法请参见查询云经销商列表。华为云总经销商(一级经销商)查询云经销商发放给子客户的优惠券时,需要携带该参数;否则只能查询发放给自己子客户的优惠券。 |
limit | integer | query | 否 | 查询的每页数量。默认值为10。 |
offset | integer | query | 否 | 偏移量,从0开始。默认值为0。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 |
expire_time_end | string | query | 否 | 失效时间(结束)。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 | query | 否 | 失效时间(开始)。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 | query | 否 | 生效时间(结束)。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 | query | 否 | 生效时间(开始)。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 | query | 否 | 创建时间(结束)。UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出创建时间小于这个时间的记录。此参数不携带或携带值为空时,不作为筛选条件。 |
create_time_begin | string | query | 否 | 创建时间(开始)。UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。输入这个条件,会查询出创建时间大于这个时间的记录。此参数不携带或携带值为空时,不作为筛选条件。 |
status | integer | query | 否 | 客户优惠券实例状态:1:未激活2:可使用3:已使用4:已过期5:已回收此参数不携带或携带值为空或携带值为null时,不作为筛选条件。 |
coupon_type | integer | query | 否 | 优惠券类型。1:代金券4:现金券此参数不携带或携带值为空或携带值为null时,不作为筛选条件。 |
order_id | string | query | 否 | 订单ID。此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 |
customer_id | string | query | 否 | 客户账号ID。您可以调用查询客户列表接口获取customer_id。此参数不携带或携带值为空时,不作为筛选条件;携带值为空串或携带值为null时,作为筛选条件。 |
coupon_id | string | query | 否 | 优惠券ID。此参数不携带或携带值为空时,不作为筛选条件;携带值为null时,作为筛选条件;不支持携带值为空串。 |
查询已发放的优惠券响应
| 名称 | 类型 | 描述 |
|---|---|---|
total_count | integer | 总数。 |
user_coupons | Array of IQueryUserPartnerCouponsResultV2 objects | 发放的优惠券记录。 具体请参见表2。 |
| 名称 | 类型 | 描述 |
|---|---|---|
coupon_id | string | 优惠券ID。 |
status | integer | 优惠券状态: 1:未激活2:可使用3:已使用4:已过期5:已回收 |
customer_id | string | 客户账号ID。 |
coupon_type | integer | 优惠券类别: 1:代金券4:现金券 |
measure_id | integer | 优惠券面额单位。 1:元。 |
face_value | number | 优惠券面值。 |
effective_time | string | 生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
expire_time | string | 失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。 |
order_id | string | 订单ID。 |
promotion_plan_id | string | 促销计划ID。 |
promotion_plan_name | string | 促销计划名称。 |
promotion_plan_desc | string | 促销计划描述。 |
media_type | integer | 介质类型。 1:电子券2:纸质券 |
fetch_method | integer | 获取方式。 1:线上领取2:线上兑换3:线上发放4:线下获取5:事件赠送 |
use_limits | Array of ICouponUseLimitInfoV2 objects | 优惠券限制。 具体请参见表3。 |
active_time | string | 优惠券的激活时间。 |
last_used_time | string | 优惠券的使用时间。 |
promotion_id | string | 促销活动ID。 |
create_time | string | 优惠券的创建时间。 |
balance | number | 优惠券余额。 |
lock_order_id | string | 锁定优惠券的订单ID。 如果为老版本优惠券,该值为空。 |
is_frozen | string | 优惠券是否冻结。 0:否1:是 可用优惠券接口返回时不包括冻结状态的优惠券。 |
| 名称 | 类型 | 描述 |
|---|---|---|
use_limiti_info_id | string | 使用限制ID,主键。 |
limit_key | string | 折扣限制,key的取值请参考表4。 |
value1 | string | value1。 |
value2 | string | value2。 |
value_unit | string | value单位。 |
limit_type | string | 限制类型。 |
promotion_plan_id | string | 促销计划ID。 |
|CBC.0100:输入参数校验失败parameter error|
"GET https://bss.myhuaweicloud.com/v2/promotions/benefits/partner-coupons?coupon_id=CP190912081601OJDA&customer_id=CS19040119281JMYC&order_id=promotionPlanId5322584&coupon_type=1&status=1&create_time_begin=2017-12-17T10:32:02Z&create_time_end=2017-12-17T10:32:02Z&effective_time_begin=2017-12-17T10:32:02Z&effective_time_end=2017-12-17T10:32:02Z&expire_time_begin=2017-12-17T10:32:02Z&expire_time_end=2017-12-17T10:32:02Z&offset=0&limit=10&indirect_partner_id=5c2ec3bd80c9462aad432f5566e9feb1"查询已发放的优惠券响应
"total_count": 1,
"user_coupons": [
{
"coupon_id": "CP200518080955A7LU",
"status": 2,
"customer_id": "051b9c187500d5340f0cc00f45000440",
"coupon_type": 1,
"measure_id": 1,
"face_value": 1.11,
"effective_time": "2020-04-08T08:53:05Z",
"expire_time": "2021-04-30T15:59:59Z",
"order_id": null,
"promotion_plan_id": null,
"promotion_plan_name": "华为云产品代金券",
"promotion_plan_desc": null,
"media_type": null,
"fetch_method": null,
"use_limits": [
{
"use_limiti_info_id": null,
"limit_key": "simultaneousUseWithPromotionProduct",
"value1": "1",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "cycleType",
"value1": "1|2|5",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "cycleNum",
"value1": "2,1,3||",
"value2": null,
"value_unit": null,
"limit_type": "in",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "couponClass",
"value1": "0",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "simultaneousUseWithDiscountCoupon",
"value1": "1",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "simultaneousUseWithPromotionDiscount",
"value1": "1",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "usageTimes",
"value1": "0",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": null,
"limit_key": "simultaneousUseWithEmpowerDiscount",
"value1": "1",
"value2": null,
"value_unit": null,
"limit_type": "=",
"promotion_plan_id": null
},
{
"use_limiti_info_id": "CP200518080955A7LU",
"limit_key": "serviceTypeBlackList",
"value1": "hws.service.type.webscan,hws.service.type.cpts6",
"value2": null,
"value_unit": null,
"limit_type": null,
"promotion_plan_id": null
}
],
"active_time": "2020-05-18T08:09:55Z",
"last_used_time": null,
"promotion_id": null,
"create_time": "2020-05-18T08:09:55Z",
"balance": 1.11,
"lock_order_id": "",
"is_frozen": "0"
}
]
}