Querying Available Coupons for an Order

order_id

Yes

A maximum of 64 characters

Order ID.

error_code

String

A maximum of 20 characters

Error code.

For details, see Returned Values.

error_msg

String

A maximum of 2,000 characters

Error description.

count

Integer

-

Total queries.

user_coupons

List<CouponInfoV2>

-

Querying customer's yearly/monthly resources

For details, see Table 2.

coupon_max_use_quantity

List<CouponMaxUseQuantity>

-

Maximum number of coupons that can be used.

For details, see Table 4.

coupon_id

String

A maximum of 64 characters

Coupon ID.

coupon_code

String

A maximum of 64 characters

Coupon code.

status

Integer

-

Coupon status. The options are as follows:

• 1: Inactivated
• 2: To be used

coupon_type

Integer

-

Coupon type.

• 300: Discount coupon (reserved)
• 301: Cash coupon
• 302: Flexi-purchase coupon (reserved)
• 303: Stored-value card (reserved)

measure_id

Integer

-

Currency.

1: Dollar

face_value

Double

-

Face value.

effective_time

String

A maximum of 20 characters

Effective time.

UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, for example, 2019-05-06T08:05:01Z.

expire_time

String

A maximum of 20 characters

Expiration time.

UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, for example, 2019-05-06T08:05:01Z.

plan_name

String

A maximum of 512 characters

Promotion plan name.

plan_desc

String

A maximum of 512 characters

Promotion plan description.

use_limits

List<LimitInfoV2>

-

Coupon limits.

For details, see Table 3.

active_time

String

A maximum of 20 characters

Activation time.

UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, for example, 2019-05-06T08:05:01Z.

last_used_time

String

A maximum of 20 characters

Last use time.

UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, for example, 2019-05-06T08:05:01Z.

create_time

String

A maximum of 20 characters

Creation time.

UTC time in "yyyy-MM-dd'T'HH:mm:ss'Z'" format, for example, 2019-05-06T08:05:01Z.

coupon_version

Integer

-

Coupon version.

• 1: Earlier version (including three types: cash coupon, discount coupon, and bonus coupon)
• 2: Latest version (cash coupon)

balance

Double

-

Balance.

used_by_order_id

String

A maximum of 64 characters

ID of the order for which a coupon is used. A coupon used for an order cannot be used for other orders.

coupon_usage

String

A maximum of 512 characters

Coupon usage.

coupon_group

Integer

-

Coupon category

• 1: Coupons issued by KooGallery
• 2: Huawei Cloud coupon-1024-dedicated coupon
• 3: Huawei Cloud coupon - usage restrictions - hardware coupon
• 0: Huawei Cloud service coupons (excluding coupons above)

use_limiti_info_id

String

A maximum of 128 characters

Usage limit ID.

limit_key

String

A maximum of 1,024 characters

Discount limit. For details about the value, see Table 5.

value1

String

A maximum of 2,048 characters

Value 1.

value2

String

A maximum of 2048 characters

Value 2.

value_unit

String

A maximum of 1,024 characters

Value unit.

limit_type

String

A maximum of 1,024 characters

Limit type.

promotion_plan_id

String

A maximum of 128 characters

Promotion plan ID.

coupon_type

Integer

-

Coupon type.

• 1: Cash coupon
• 2: Discount coupon
• 3: Product coupon
• 4: Flexi-purchase coupon

coupon_group

Integer

-

Coupon category

• 1: Coupons issued by KooGallery
• 2: Huawei Cloud coupon-1024-dedicated coupon
• 3: Huawei Cloud coupon - usage restrictions - hardware coupons
• 0: Huawei Cloud service coupons (excluding coupons above)

use_quantity_value

Integer

-

Number of used coupons.

baseValue

Order amount.

value1 specifies the lower limit of the order amount, and value2 specifies the upper limit of the order amount.

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

serviceType

Cloud service type.

Only value1 is valid. To obtain a specific cloud service type, call the API in Querying Cloud Service Types.

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

regionCode

Region code.

value1 specifies the region code, and value2 specifies the region name.

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

productId

Product ID

You can configure multiple product IDs. Separate them using commas (,).

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

subscribeType

Order type.

Only value1 is valid. The value can be:

• new: Order placement
• renew: Order renewal
• change: Order change

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

firstOrderInService

Restriction for the first-time purchase.

Only value1 is valid.

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

cycleNum

Number of periods.

Only value1 is valid.

Cash coupons, flexi-purchase coupons, and discount coupons are supported.

cycleType

Trial use period type.

• 0: Yearly/monthly (unlimited)
• 1. Yearly/monthly (yearly)
• 2: Yearly/monthly (monthly)
• 3: Yearly/monthly (daily)
• 4: Yearly/monthly (hourly)
• 5: Pay-per-use
• 6: General purpose
• 7: One-off payment
• 8: Reserved instance
• 11: Savings plan

Cash coupons, flexi-purchase coupons, and discount coupons are supported. Discount coupons support only the yearly/monthly mode.

simultaneousUseWithEmpowerDiscount

Whether cash coupons can be used together with authorized discounts.

Whether cash coupons can be used with authorized discounts (including commercial discounts and discounts authorized by partners).

• 0: No
• 1: Yes

Cash coupons, flexi-purchase coupons, and discount coupons are supported. The value for discount coupons can only be 0.

usageTimes

Whether coupons can be used for multiple times.

The value is specified in value1. The value can be:

• 0: Used for unlimited times
• 1: Used for only once
• N: Used for N times. (For cash coupons of the old version, N is fixed at 1.)

• When CouponType is set to 2 (discount coupons), this parameter can only be set to 1, and if this parameter is not specified or is set to a non-1 value, the parameter value is 1.
• When CouponType is set to 1 (cash coupons) (or 4 (flexi-purchase coupons), if this parameter is not specified or is set to a value other than 0 or 1, the parameter value is 0.

isOnlyForStrictSelected

Whether the coupons can only be used for Featured Products on KooGallery.

The value is specified in value1. The value can be:

• 0: No
• 1: Yes

If there is no such restriction, the value is 0. This restriction applies only to flexi-purchase coupons.

Flex-purchase coupons are supported.

isRebate

Whether coupons are counted in to the partner incentive rebates.

The value is specified in value1. The value can be:

• 0: No
• 1: Yes

This restriction applies only to flexi-purchase coupons.

Flex-purchase coupons are supported.

serviceTypeBlackList

Service type blacklist.

Service type blacklist. The service type code is specified in value1. This restriction applies only to flexi-purchase coupons.

Flex-purchase coupons are supported.

minConsumeDiscount

Minimum customer consumption discount.

The value is specified in value1. The value ranges from 0 to 1 (excluding 0 and 1).

Cash coupons and flexi-purchase coupons are supported.

isForAnnualContracts

Whether coupons can only be used for yearly/monthly (one-year) orders.

The value can be:

• 0: No
• 1: Yes

Cash coupons and discount coupons are supported.

simultaneousUseWithPromotionProduct

Whether cash coupons can be used together with promotional products.

The value is specified in value1. The value can be:

• 0: No
• 1: Yes

Cash coupons and discount coupons are supported.

simultaneousUseWithPromotionDiscount

Whether cash coupons can be used together with promotion discounts.

The value is specified in value1. The value can be:

• 0: No
• 1: Yes

Cash coupons are supported.

simultaneousUseWithDiscountCoupon

Whether cash coupons can be used together with discount coupons.

The value is specified in value1. The value can be:

• 0: No
• 1: Yes

Cash coupons are supported.

400

CBC.0100

Parameter error.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.