文档首页/ 合作伙伴中心/ API参考/ 管理交易/ 管理包年/包月订单/ 查询订单可用优惠券
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询订单可用优惠券

功能介绍

客户在伙伴销售平台支付待支付订单时，查询可使用的优惠券列表。

接口约束

该接口只允许使用客户AK/SK或者Token调用，不允许使用合作伙伴AK/SK或者Token调用。

调试

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

URI

GET /v2/orders/customer-orders/order-coupons

参数说明请参见下表。

表1 查询参数

参数

是否必选

取值范围

描述

order_id

是

最大长度：64

订单ID。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/orders/customer-orders/order-coupons?order_id=CS170926155954NO7 HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度：20

状态码。

具体请参见状态码。

error_msg

String

最大长度：2000

错误描述信息。

count

Integer

-

查询总数。

user_coupons

List<CouponInfoV2>

-

可用的优惠券列表。

具体请参见表2。

coupon_max_use_quantity

List<CouponMaxUseQuantity>

-

优惠券使用的最大数量。

具体请参见表4。
表2 CouponInfoV2

参数

参数类型

取值范围

描述

coupon_id

String

最大长度：64

优惠券实例ID。

coupon_code

String

最大长度：64

优惠券编码。

status

Integer

-

优惠券状态：

  • 1：未激活
  • 2：待使用

coupon_type

Integer

-

优惠券类型：

  • 300：折扣券
  • 301：代金券
  • 302：现金券
  • 303：储值卡

measure_id

Integer

-

面额单位：

1：元。

face_value

Double

-

面值。

effective_time

String

最大长度：20

生效时间。

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

expire_time

String

最大长度：20

失效时间。

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

plan_name

String

最大长度：512

促销计划名称。

plan_desc

String

最大长度：512

促销计划描述。

use_limits

List<LimitInfoV2>

-

优惠券限制。

具体请参见表3。

active_time

String

最大长度：20

激活时间。

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

last_used_time

String

最大长度：20

上一次使用时间。

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

create_time

String

最大长度：20

创建时间。

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

coupon_version

Integer

-

优惠券版本。

  • 1：老版本（包含三种：代金券、折扣券和奖金券）
  • 2：新版本（只有代金券）

balance

Double

-

余额。

used_by_order_id

String

最大长度：64

使用优惠券的订单ID。表示有订单正在使用这个优惠券，优惠券已被锁定，只有锁定优惠券的订单才能使用这个优惠券，其他订单不能使用该优惠券。

说明：

该字段只有在订单占用折扣券的时候才有值。

coupon_usage

String

最大长度：512

优惠券用途。

coupon_group

Integer

-

优惠券分组。

  • 1：云商店发放的券
  • 2：华为云券-1024-专用代金券
  • 3：华为云券-使用限制-抵扣硬件的券
  • 0：华为云服务券（排除上述取值之外的券）
表3 LimitInfoV2

参数

参数类型

取值范围

描述

use_limiti_info_id

String

最大长度：128

使用限制ID，主键。

limit_key

String

最大长度：1024

折扣限制，key的取值请参考表5。

value1

String

最大长度：2048

value1。

value2

String

最大长度：2048

value2。

value_unit

String

最大长度：1024

value单位。

limit_type

String

最大长度：1024

限制类型。

promotion_plan_id

String

最大长度：128

促销计划ID。
表4 CouponMaxUseQuantity

参数

参数类型

取值范围

描述

coupon_type

Integer

-

优惠券类型。

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

coupon_group

Integer

-

优惠券分组。

  • 1：云商店发放的券
  • 2：华为云券-1024-专用代金券
  • 3：华为云券-使用限制-抵扣硬件的券
  • 0：华为云服务券（排除上述取值之外的券）

use_quantity_value

Integer

-

优惠券使用数量。
表5 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：预留实例
  • 11：节省计划

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

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
{
  "count": "1",
  "user_coupons": [
    {
      "coupon_id": "CP1*****4VC8",
      "coupon_code": "",
      "status": "2",
      "coupon_type": "301",
      "measure_id": "1",
      "face_value": "100",
      "effective_time": "2021-04-29T15:59:59Z",
      "expire_time": "2021-04-30T15:59:59Z",
      "plan_name": "华为云产品代金券",
      "plan_desc": "",
      "use_limits": [
        {
          "use_limiti_info_id": "",
          "limit_key": "simultaneousUseWithDiscountCoupon",
          "value1": "1",
          "value2": "",
          "value_unit": "",
          "limit_type": "",
          "promotion_plan_id": ""
        }
      ],
      "active_time": "2020-04-24T12:16:55Z",
      "last_used_time": "",
      "create_time": "2020-04-24T12:16:55Z",
      "coupon_version": 2,
      "balance": 10.0,
      "used_by_order_id": "",
      "coupon_usage": "null",
      "coupon_group": 1
    }
  ],
"coupon_max_use_quantity": [
        {
            "coupon_type": 1,
            "coupon_group": 0,
            "use_quantity_value": 3
        },
        {
            "coupon_type": 1,
            "coupon_group": 3,
            "use_quantity_value": 4
        },
        {
            "coupon_type": 1,
            "coupon_group": 1,
            "use_quantity_value": 2
        }
    ]
}

状态码

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

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

相关文档