更新时间:2024-08-22 GMT+08:00
分享

发放优惠券

功能介绍

合作伙伴可以在拥有的代金券额度范围内为客户下发优惠券。

伙伴登录合作伙伴中心为客户发放代金券请参见这里

只能给代售子客户发放优惠券。

接口约束

  • 该接口只能给合作伙伴使用,调用的时候必须传递合作伙伴的AK/SK或者Token。
  • 调用该接口之前,需通过客户经理联系华为运营人员,为合作伙伴设置优惠券发放额度。

调试

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

URI

POST /v2/promotions/benefits/partner-coupons

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

quota_id

String

最大长度:64

优惠券额度ID。该值在查询优惠券额度接口的响应参数中获取。

customer_ids

List<String>

最大个数:100

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

face_value

BigDecimal

-

代金券面值。

单位:元。取值大于0且精确到小数点后2位。

valid_time

String

最大长度:20

生效时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

此参数不携带或携带值为null时,赋值为发放优惠券额度的生效时间。

expire_time

String

最大长度:20

失效时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

此参数不携带或携带值为null时,赋值为发放优惠券额度的失效时间。

cloud_service_types

List<String>

最大个数:10

允许使用的云服务列表,您可以调用查询云服务类型列表接口获取。

多个云服务产品以“,”隔开,最多支持10个。

默认:空(继承额度上的限制)

此参数不携带或携带值为空数组或携带值为null时,默认为空。

说明:
  • 如果额度上有限制云服务类型列表,则优惠券上的限制不能超过额度的限制。
  • 如果额度上没有限制,则优惠券上可以随意指定云服务类型。

product_ids

List<String>

最大个数:10

允许使用的产品列表。

多个产品以“,”隔开,最多支持10个。

默认:空(继承额度上的限制)

此参数不携带或携带值为空数组或携带值为null时,默认为空。

说明:
  • 如果额度上有限制产品列表,则优惠券上的限制不能超过额度的限制。
  • 如果额度上没有限制,则优惠券上可以随意指定产品ID。

产品ID需要合作伙伴通过线下获得。

memo

String

最大长度:512

发券时的备注信息。

此参数不携带或携带值为null时,不赋值;携带值为空串时,赋值空串。

indirect_partner_id

String

最大长度:64

云经销商ID。获取方法请参见查询云经销商列表

云经销商给子客户发放优惠券时,需要携带该参数。除此之外,此参数不做处理。

请求示例

POST https://bss.myhuaweicloud.com/v2/promotions/benefits/partner-coupons HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "quota_id": "2018011615520150",
    "customer_ids": ["f8231a7d11484dfaaea8b70755680c7e"],
    "face_value": 1.11,
    "valid_time": "2017-12-17T10:32:02Z",
    "expire_time": "2017-12-17T10:32:02Z",
    "cloud_service_types": ["hws.service.type.vpc"],
    "product_ids": ["90301-316030-0--0"],
    "memo": "请尽快使用,防止过期。",
    "indirect_partner_id": "c9e731c4663646988ef4cdb3122837b6"
}

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

错误码。只有出错的时返回该参数。

具体请参见状态码

error_msg

String

最大长度:1024

错误描述信息。只有出错的时返回该参数。

coupon_infos

List<CouponSimpleInfo>

最大个数:10

成功的客户ID和对应的券ID列表,只有HTTP 200的时候才会返回这个结构体,具体参见表2

error_details

List<ErrorDetail>

最大个数:10

错误的客户列表和错误信息,只有HTTP 200的时候才会返回这个结构体,具体参见表1

表1 ErrorDetail

参数

参数类型

取值范围

描述

id

String

最大长度:128

客户账号ID。

error_code

String

最大长度:20

状态码,具体请参见状态码

error_msg

String

最大长度:1000

错误描述信息。

表2 CouponSimpleInfo

参数

参数类型

取值范围

描述

id

String

最大长度:64

批量发放优惠券成功的客户ID。

coupon_id

String

最大长度:64

发放成功的券ID。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
    "error_details": [],
    "coupon_infos": [
        {
            "id": "17a80a9f9d3949ddb60ee73a5b3c9618",
            "coupon_id": "2024051108584114"
        }
    ]
}

状态码

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

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

200

CBC.99000000

无对该客户的操作权限。

400

CBC.99000012

额度不存在或者额度状态不正确。

200

CBC.99000013

优惠券额度不足。

400

CBC.99000017

额度未生效或者已过期。

400

CBC.99000018

券面值不得小于最小值。

400

CBC.99000019

券面值不得大于最大值。

200

CBC.99000020

券数量超过最大限制。

200

CBC.99000021

券总面值不允许超过总面值。

200

CBC.99000022

该券只能发给首次关联的子客户。

400

CBC.99000023

券的云服务限制、产品限制超出额度的限制。

200

CBC.99000035

非合作伙伴子客户。

400

CBC.99000037

您没有操作该云经销商的权限。

400

CBC.50000020

该代金券只适用于指定客户。

400

CBC.50000010

您已是伙伴用券模式,无法发放代金券。

400

CBC.50000054

产品不存在。

400

CBC.50000055

云服务类型不存在。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

相关文档