查询优惠券列表

功能介绍

客户在伙伴销售平台查询优惠券信息。

注意事项：

该接口只能查询自身的优惠券列表信息，合作伙伴平台查询客户的优惠券列表，须先置换成客户Token。

该接口即将下线，“查询优惠券列表”接口请参考查询优惠券列表。

URI

GET /v1.0/{domain_id}/common/promotion-mgr/coupons

参数说明请参见下表。

表1 路径参数
参数	是否必选	取值范围	描述
domain_id	是	最大长度：64	客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。

表2 查询参数
参数	是否必选	参数类型	取值范围	描述
coupon_id	否	String	最大长度：64	优惠券ID。
order_id	否	String	最大长度：64	订单ID。
promotion_plan_id	否	String	最大长度：64	促销计划ID。
coupon_type	否	Integer	[1-3]	优惠券类型： 1：代金券 2：折扣券 3：产品券
status	否	Integer	[1-4]	客户优惠券实例状态： 1：未激活 2：待使用 3：已使用 4：已过期
active_start_time	否	String	最大长度：64	激活时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。
active_end_time	否	String	最大长度：64	结束时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。其中，HH范围是0～23，mm和ss范围是0～59。
page_no	是	Integer	[1-2147483647]	当前页。
page_size	是	Integer	[1-100]	每页数量。
coupons_scope	否	Integer	[1-2]	优惠券的范围： 1：仅华为优惠券 2：仅合作伙伴促销券
bp_id	否	String	最大长度：64	合作伙伴ID。只有coupons-scope为2的时候，该字段必填，否则该字段不论是否填写都忽略。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/common/promotion-mgr/coupons?page_no=1&page_size=10 HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数	参数类型	取值范围	描述
error_code	String	最大长度：16	状态码。具体请参见状态码。
error_msg	String	最大长度：1024	错误描述信息。
count	Integer	-	符合查询条件的总条数。
user_coupons	List<IQueryUserCouponsResult>	-	优惠券记录。具体请参见表3。

表3 IQueryUserCouponsResult
参数	是否必选	参数类型	描述
coupon_id	否	String	优惠券实例ID。
coupon_code	否	String	优惠券编码。
status	否	Integer	优惠券状态： 1：未激活 2：待使用 3：已使用 4：已过期 5：已回收
customer_id	否	String	客户ID。
coupon_type	否	Integer	优惠券类型： 1：代金券 2：折扣券 3：产品券
measure_id	否	Integer	度量单位。 1：元
face_value	否	Number	优惠券金额。
valid_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。
plan_name	否	String	促销计划名称。
plan_desc	否	String	促销计划描述。
media_type	否	Integer	介质类型。
fetch_method	否	Integer	获取方式： 1：线上领取 2：线上兑换 3：线上发放 4：线下获取 5：事件赠送
use_limits	否	List<ICouponUseLimitInfo>	优惠券使用限制。具体请参见表4。
business_entity_id	否	String	该优惠券所属的运营实体。如果是华为云发放的优惠券，该值为0。否则就是合作伙伴发放的优惠券。
active_time	否	String	激活时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。
reserve_time	否	String	使用时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。
promotion_id	否	String	促销ID。
create_time	否	String	创建时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如“2019-05-06T08:05:01Z”。
coupon_version	否	Integer	优惠券版本： 1：老版本，老版本优惠券只能使用一次； 2：新版本，新版本优惠券可以反复使用。
balance	否	Number	余额。如果为老版本优惠券，该值为空。
lock_order_id	否	String	锁定优惠券的订单ID。如果为老版本优惠券，该值为空。
coupon_usage	否	String	优惠券用途。
is_frozen	否	String	优惠券是否冻结： 0：否 1：是可用优惠券接口返回时不包括冻结状态的优惠券。
currency	否	String	币种，目前固定位CNY。
extend_param1	否	String	扩展字段。

表4 ICouponUseLimitInfo
参数	是否必选	参数类型	描述
use_limiti_info_id	否	String	使用限制ID，主键。
limit_key	否	String	折扣限制，key的取值请参考表5。
value1	否	String	value1。
value2	否	String	value2。
value_unit	否	String	value单位。
limit_type	否	String	限制类型。
promotion_plan_id	否	String	促销计划ID。

表5 ICouponUseLimitInfo的limit_key要求
key值	含义	说明
baseValue	订单金额	value1中保存订单金额下限，value2中保存订单金额上限。
serviceType	云服务类型	只有value1有效，具体的云服务类型请调用查询云服务类型列表接口获取。
regionCode	区域编码	value2中保存区域名称，value1中保存区域编码。
productId	产品ID	可以多值，英文逗号分隔。
subscribeType	订购类型	只有value1有效。
firstOrderInService	首次购买限制	只有value1有效。
cycleNum	周期数量	只有value1有效。
cycleType	适用周期类型	0：包年/包月-不限 1：包年/包月-年 2：包年/包月-月 3：包年/包月-天 4：包年/包月-小时 5：按需 6：通用
simultaneousUseWithEmpowerDiscount	代金券是否可以和授权折扣同享	0：否 1：是

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

{
  "count": 1,
  "error_code": "CBC.0000",
  "error_msg": "success",
  "user_coupons": [
    {
      "status": 4,
      "balance": null,
      "currency": "CNY",
      "coupon_id": "CP004015DB23A272B4",
      "coupon_code": null,
      "customer_id": "34c23a88d69e4b6aa041c8191b8a2c13",
      "coupon_type": 1,
      "measure_id": 1,
      "face_value": 110,
      "valid_time": "2017-08-05T11:49:02Z",
      "expire_time": "2017-08-13T11:49:02Z",
      "order_id": null,
      "promotion_plan_id": "PCP17080519451621417XDD3B1B17JCV",
      "plan_name": "无限制计划0805",
      "plan_desc": "无限制计划0805",
      "media_type": 1,
      "fetch_method": 3,
      "use_limits": [
        {
          "value1": "1",
          "value2": null,
          "use_limiti_info_id": "CU1707312158414111T2BFC00ZML55F",
          "limit_key": "firstOrderInService",
          "value_unit": null,
          "limit_type": "=",
          "promotion_plan_id": "COT002015D98F110030"
        },
        {
          "value1": "0",
          "value2": null,
          "use_limiti_info_id": "CU170731215841411130QGVF1DNHBSL",
          "limit_key": "usageTimes",
          "value_unit": null,
          "limit_type": "=",
          "promotion_plan_id": "COT002015D98F110030"
        },
        {
          "value1": "0",
          "value2": null,
          "use_limiti_info_id": "CU1707312158414110B4D95J0EJLYEI",
          "limit_key": "cycleType",
          "value_unit": null,
          "limit_type": "=",
          "promotion_plan_id": "COT002015D98F110030"
        }
      ],
      "business_entity_id": "1",
      "active_time": "2017-08-05T11:49:02Z",
      "reserve_time": null,
      "promotion_id": "P1708051947373111IGWA780UTTMTD",
      "create_time": "2017-08-05T11:49:02Z",
      "coupon_version": 2,
      "lock_order_id": null,
      "coupon_usage": "1707200902160840KPIITJ03CA3HV",
      "is_frozen": "0",
      "extend_param1": null
    }
  ]
}

状态码

状态码	描述
CBC.0000	成功。
CBC.0100	参数错误。
CBC.0151	访问拒绝。
CBC.5001	非合作伙伴。
CBC.0999	其他错误。

父主题： 管理优惠券

上一篇：管理优惠券

下一篇：查询优惠券额度

查询优惠券列表

功能介绍

URI

请求消息

响应消息

状态码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？