文档首页 > > API参考> 管理包周期订单> 查询订单可用优惠券

查询订单可用优惠券

分享
更新时间: 2019/09/20 GMT+08:00

功能介绍

客户在客户自建平台查看订单可用的优惠券列表。

注意事项:

该接口只允许使用客户AK/SK或者Token调用。

URI

GET /v1.0/{domain_id}/common/order-mgr/orders/order-coupons

参数说明请参见下表。

表1 路径参数

参数

是否必选

取值范围

描述

domain_id

最大长度:64

客户账号ID。获取方法请参见如何获取customer_id/domain_id

表2 查询参数

参数

是否必选

取值范围

描述

order_id

最大长度:64

订单ID。

请求消息

请求参数

无。

请求示例

GET /v1.0/{domain_id}/common/order-mgr/orders/order-coupons?order_id=CS1801221450EF0OE HTTP/1.1
Host: Host Server   
Content-Type: application/json
X-Sdk-Date: request time  
Authorization: authorization

响应消息

响应参数

参数

参数类型

描述

error_code

String

状态码。

具体请参见状态码

error_msg

String

错误描述信息。

total_count

Integer

查询总数。

user_coupons

List<CouponInfo>

可用的优惠券列表。

具体请参见表3

表3 CouponInfo

参数

参数类型

描述

coupon_id

String

优惠券实例ID。

coupon_code

String

优惠券编码。

status

Integer

优惠券状态:

2:待使用。

coupon_type

Integer

优惠券类型:

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

measure_id

Integer

面额单位:

1:元。

face_value

Number

面值。

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”。

plan_name

String

促销计划名称。

plan_desc

String

促销计划描述。

use_limits

List<LimitInfo>

优惠券限制。

具体请参见表4

be_id

String

客户对应的运营实体Id。

  • 为0表示华为云实体。
  • 不为0表示合作伙伴实体,即客户与合作伙伴有关联关系。

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”。

create_time

String

创建时间。

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

coupon_version

Integer

优惠券版本。

  • 1:老版本(原本分为三种:代金券/折扣券/奖金券);
  • 2:新版本(只有代金券)。

balance

Number

余额。

used_by_order_id

String

使用优惠券的订单ID,表示正在有另外一张订单正在使用这个优惠券。正在锁定的时候,只有锁定优惠券的订单才能使用这个优惠券,其他订单不能使用该优惠券。

coupon_usage

String

优惠券用途。

表4 LimitInfo

参数

是否必选

参数类型

描述

use_limiti_info_id

String

使用限制ID,主键。

limit_key

String

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

value1

String

value1。

value2

String

value2。

value_unit

String

value单位。

limit_type

String

限制类型。

promotion_plan_id

String

促销计划ID。

表5 ICouponUseLimitInfo的limit_key要求

key值

含义

说明

baseValue

订单金额

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

serviceType

服务类型

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

只有value1有效。

regionCode

区域编码

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

productId

产品ID

可以多值,英文逗号分隔。

subscribeType

订购类型

只有value1有效。

firstOrderInService

首次购买限制

只有value1有效。

cycleNum

周期数量

只有value1有效。

cycleType

适用周期类型

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

simultaneousUseWithEmpowerDiscount

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

  • 0:否;
  • 1:是。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

{
    "error_code": "CBC.0000",
    "error_msg": "success",
    "total_count": 1,
    "user_coupons": [
        {
            "status": 2,
            "balance": 200,
            "coupon_id": "CP1801230955504VC8",
            "coupon_code": null,
            "coupon_type": 1,
            "measure_id": 1,
            "face_value": 200,
            "valid_time": "2018-01-22T16:00:00Z",
            "expire_time": "2023-05-31T15:59:59Z",
            "plan_mame": null,
            "plan_desc": null,
            "use_limits": [
                {
                    "value1": "0",
                    "value2": null,
                    "use_limiti_info_id": null,
                    "limit_key": "simultaneousUseWithEmpowerDiscount",
                    "value_unit": null,
                    "limit_type": "=",
                    "promotion_plan_id": null
                },
                {
                    "value1": "0",
                    "value2": null,
                    "use_limiti_info_id": null,
                    "limit_key": "usageTimes",
                    "value_unit": null,
                    "limit_type": "=",
                    "promotion_plan_id": null
                },
                {
                    "value1": "6",
                    "value2": null,
                    "use_limiti_info_id": null,
                    "limit_key": "cycleType",
                    "value_unit": null,
                    "limit_type": "=",
                    "promotion_plan_id": null
                }
            ],
            "be_id": "2473",
            "active_time": "2018-01-23T01:55:53Z",
            "reserve_time": null,
            "create_time": "2018-01-23T01:55:53Z",
            "coupon_version": 2,
            "used_by_order_id": "",
            "coupon_usage": null
        }
    ]
}

状态码

状态码

描述

CBC.0000

成功。

CBC.0999

其他错误。

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区