文档首页 > > API参考> 管理优惠券> 查询优惠券列表

查询优惠券列表

分享
更新时间: 2020/06/24 GMT+08:00

功能介绍

客户可以查询自身的优惠券信息。

Web UI

  1. 进入“优惠券”页面。
  2. 在代金券列表中,查看代金券余额、有效期、使用限制等信息。

    • 在列表上方的下拉框中,可选择代金券的状态,包括:可使用、已用完、已过期。

      页面默认展示的为“可使用”状态的代金券,如果您的代金券不见了,可能是代金券已用完或已过期。

    • 单击代金券的名称,可以进入代金券详情页面,查看代金券的详细信息和使用记录。

REST API

客户可以在伙伴销售平台上查询优惠券列表。

该接口可以使用客户AK/SK或者Token调用。

  1. 调试

    您可以在API Explorer中直接运行调试该接口。

  2. URI

    GET /v2/promotions/benefits/coupons

    参数说明请参见下表。

    表1 查询参数

    参数

    是否必选

    参数类型

    取值范围

    描述

    coupon_id

    String

    最大长度:64

    优惠券ID。

    order_id

    String

    最大长度:64

    订单ID。

    promotion_plan_id

    String

    最大长度:64

    促销计划ID。

    coupon_type

    Integer

    [1-4]

    优惠券类型:

    • 1:代金券
    • 2:折扣券
    • 3:产品券
    • 4:现金券

    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。

    offset

    Integer

    [0-最大整数]

    偏移量,从0开始。默认为0。

    limit

    Integer

    最大值:100

    查询的优惠券数量,默认10。

    source_id

    String

    最大长度:255

    发券来源,如果是合作伙伴发送的券,此处为伙伴ID。

    如果需要查询某个伙伴发放的券,可以在此处输入该伙伴ID。

  3. 请求消息

    请求参数

    无。

    请求示例

    GET https://bss.myhuaweicloud.com/v2/promotions/benefits/coupons HTTP/1.1
    Content-Type: application/json
    X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
  4. 响应消息

    响应参数

    参数

    参数类型

    取值范围

    描述

    error_code

    String

    最大长度:16

    状态码。

    具体请参见5

    error_msg

    String

    最大长度:1024

    错误描述信息。

    count

    Integer

    -

    符合查询条件的总条数。

    user_coupons

    List<IQueryUserCouponsResult>

    -

    优惠券记录。

    具体请参见表2

    表2 IQueryUserCouponsResult

    参数

    参数类型

    描述

    coupon_id

    String

    优惠券实例ID。

    coupon_code

    String

    优惠券编码。

    status

    Integer

    优惠券状态:

    • 1:未激活
    • 2:待使用
    • 3:已使用
    • 4:已过期

    customer_id

    String

    客户账号ID。

    coupon_type

    Integer

    优惠券类型:

    • 1:代金券
    • 2:折扣券
    • 3:产品券
    • 4:现金券

    measure_id

    Integer

    度量单位。

    1:元

    face_value

    Double

    优惠券金额。

    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<ICouponUseLimitInfoV2>

    优惠券使用限制。

    具体请参见表3

    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

    Double

    余额。

    如果为老版本优惠券,该值为空。

    lock_order_id

    String

    锁定优惠券的订单ID。

    如果为老版本优惠券,该值为空。

    coupon_usage

    String

    优惠券用途。

    is_frozen

    String

    优惠券是否冻结:

    • 0:否
    • 1:是

    可用优惠券接口返回时不包括冻结状态的优惠券。

    currency

    String

    币种,目前固定位CNY。

    extend_param1

    String

    扩展字段。

    source_id

    String

    发券来源。

    • 如果是合作伙伴发送的券,此处为伙伴ID。
    • 如果是活动发券,此处为活动ID:
      • 云豆兑换优惠券:云豆计划ID
      • 累计送优惠券:累计送计划ID
      • 抽奖送优惠券:抽奖计划ID
      • 事件送优惠券:事件计划ID
      • 定制优惠券:创建人ID
    表3 ICouponUseLimitInfoV2

    参数

    参数类型

    描述

    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。

    表4 ICouponUseLimitInfo的limit_key要求

    key值

    含义

    说明

    备注

    baseValue

    订单金额

    value1中保存订单金额下限,value2中保存订单金额上限。

    支持代金券,现金券,折扣券

    serviceType

    云服务类型

    只有value1有效,具体的云服务类型请参见云服务类型

    支持代金券,现金券,折扣券

    regionCode

    区域编码

    value2中保存区域名称,value1中保存区域编码。

    支持代金券,现金券,折扣券

    productId

    产品ID

    可以包含多个产品ID,英文逗号分隔。

    支持代金券,现金券,折扣券

    subscribeType

    订购类型

    只有value1有效。取值为:

    • 下单:new
    • 续订:renew
    • 变更:change

    支持代金券,现金券,折扣券

    firstOrderInService

    首次购买限制

    只有value1有效。

    支持代金券,现金券,折扣券

    cycleNum

    周期数量

    只有value1有效。

    支持代金券,现金券,折扣券

    cycleType

    适用周期类型

    • 0:包年/包月-不限
    • 1:包年/包月-年
    • 2:包年/包月-月
    • 3:包年/包月-天
    • 4:包年/包月-小时
    • 5:按需
    • 6:通用

    支持代金券,现金券,折扣券,折扣券仅支持包年/包月

    simultaneousUseWithEmpowerDiscount

    代金券是否可以和授权折扣同享

    • 0:否
    • 1:是

    支持代金券,现金券,折扣券,折扣券只能使用0。

    usageTimes

    是否支持多次使用

    是否支持多次使用,值保存在value1中。取值为:

    • 0:不限制次数
    • 1:1次
    • N:限制使用N次(目前旧版代金券固定填写为1)
    • CouponType=折扣券时,只能设置为1;不指定或者指定为非1,均设置为1。
    • CouponType=代金券、现金券时,如果不指定或者指定为0、1之外的值,均设置为0。

    isOnlyForStrictSelected

    是否只能用于云市场严选产品

    是否只能用于云市场严选产品,值保存在value1中。取值为:

    • 0:否
    • 1:是

    如果没有这个限制,等同于0;该限制只是用于现金券。

    支持现金券

    isRabate

    是否参与伙伴激励返点

    是否参与伙伴激励返点,值保存在value1中。取值为:

    • 0:否
    • 1:是

    该限制只是用于现金券。

    支持现金券

    serviceTypeBlackList

    服务类型黑名单

    服务类型黑名单,value1中保存服务类型编码;该限制只是用于现金券。

    支持现金券

    minConsumeDiscount

    最低客户消费折扣

    最低客户消费折扣,值保存在value1中。取值为0-1之间(不包括0和1)。

    支持代金券、现金券

    isForAnnualContracts

    是否只能用于包年/包月1年的订单

    是否只能用于包年/包月1年的订单。取值为:

    • 0:否
    • 1:是

    支持代金券、折扣券

    simultaneousUseWithPromotionProduct

    是否可以和促销产品同享

    代金券是否可以和促销产品同享,值保存在value1中。取值为:

    • 0:否
    • 1:是

    支持代金券/折扣券

    simultaneousUseWithPromotionDiscount

    是否可以和促销折扣同享

    代金券是否可以和促销折扣同享,值保存在value1中。取值为:

    • 0:否
    • 1:是

    支持代金券

    simultaneousUseWithDiscountCoupon

    是否可以和折扣券同享

    代金券是否可以和折扣券同享,值保存在value1中。取值为:

    • 0:否
    • 1:是

    支持代金券

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Content-Length: length
    Date: response time
    {
      "count": "1",
      "user_coupons": [
        {
          "coupon_id": "CP19092406014086E3",
          "coupon_code": "CP19092406014086E3",
          "status": "2",
          "customer_id": "c9e731c4663646988ef4cdb3122837b6",
          "coupon_type": "1",
          "measure_id": "1",
          "face_value": "100",
          "valid_time": "2019-09-16T16:00:00Z",
          "expire_time": "2019-09-16T16:00:00Z",
          "order_id": "CS1904011928GIBHC",
          "promotion_plan_id": "promotionPlanId5322584",
          "plan_name": "532元优惠券name",
          "plan_desc": "532元优惠券desc",
          "media_type": "1",
          "fetch_method": "1",
          "use_limits": [
            {
              "use_limiti_info_id": "CP19092406014086E3",
              "limit_key": "simultaneousUseWithDiscountCoupon",
              "value1": "1",
              "value2": "",
              "value_unit": "",
              "limit_type": "=",
              "promotion_plan_id": "promotionPlanId5322584"
            }
          ],
          "active_time": "2019-09-16T16:00:00Z",
          "reserve_time": "2019-09-16T16:00:00Z",
          "promotion_id": "promotionPlanId5322584",
          "create_time": "2019-09-16T16:00:00Z",
          "coupon_version": "2",
          "balance": "100",
          "lock_order_id": "CS1904011928GIBHC",
          "coupon_usage": "170719190603338056FEH60VIRWEP",
          "is_frozen": "0",
          "currency": "USD",
          "extend_param1": "2019091702368200",
          "source_id": "c9e731c4663646988ef4cdb3122837b6"
        }
      ]
    }
  5. 状态码

    HTTP状态码

    错误码

    描述

    400

    CBC.0100

    参数错误。

    403

    CBC.0151

    访问拒绝。

    500

    CBC.0999

    其他错误。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问