更新时间:2022-04-25 GMT+08:00
分享

查询已发放的优惠券

功能介绍

合作伙伴可以查询已发放的优惠券列表。

伙伴登录伙伴中心,进入“客户业务 > 代金券管理”,选择“已发放代金券”页签,即可查询已发放的代金券。

接口约束

该接口只能给合作伙伴使用,调用的时候必须传递合作伙伴的AK/SK或者Token。

调试

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

URI

GET /v2/promotions/benefits/partner-coupons

参数说明请参见下表。

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

coupon_id

String

最大长度:64

优惠券ID。

customer_id

String

最大长度:64

客户账号ID。您可以调用查询客户列表接口获取customer_id。

order_id

String

最大长度:64

订单ID。

coupon_type

Integer

-

优惠券类型:

  • 1:代金券
  • 4:现金券

status

Integer

-

客户优惠券实例状态:

  • 1:未激活
  • 2:可使用
  • 3:已使用
  • 4:已过期
  • 5:已回收

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,则返回满足条件的第二个数据至最后一个数据。

例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

limit

Integer

[1-100]

查询的每页数量。默认值为10。

indirect_partner_id

String

最大长度:64

精英服务商ID。获取方法请参见查询精英服务商列表

华为云伙伴能力中心(一级经销商)查询精英服务商发放给子客户的优惠券时,需要携带该参数;否则只能查询发放给自己子客户的优惠券。

请求消息

请求参数

无。

请求示例

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 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参见状态码

error_msg

String

最大长度:1000

错误描述信息。

total_count

Integer

-

总数。

user_coupons

List< IQueryUserPartnerCouponsResult>

-

发放的优惠券记录。

具体请参见表2

表2 IQueryUserPartnerCouponsResult

参数

参数类型

描述

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

BigDecimal

优惠券面值。

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

List<ICouponUseLimitInfoV2>

优惠券限制。

具体请参见表3

active_time

String

优惠券的激活时间。

last_used_time

String

优惠券的使用时间。

promotion_id

String

促销活动ID。

create_time

String

优惠券的创建时间。

balance

BigDecimal

优惠券余额。

lock_order_id

String

锁定优惠券的订单ID。

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

is_frozen

String

优惠券是否冻结。

  • 0:否
  • 1:是

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

表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:通用
  • 7:一次性 (只针对订购送事件活动)
  • 8:预留实例

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

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;该限制只是用于现金券。

支持现金券

isRebate

是否参与伙伴激励返点

是否参与伙伴激励返点,值保存在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
{
    "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"
        }
    ]
}

状态码

  • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
  • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

400

CBC.99000037

您没有操作该精英服务商的权限。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品

关闭导读