网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

查询优惠券列表

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

功能介绍

客户可以查询自身的优惠券信息。

客户登录费用中心查询优惠券信息请参见这里

说明:
  • 不返回超过已失效一年时间的代金券/折扣券信息。
  • 当券的失效时间小于当前时间时,券将不再有效,此时券的状态称之为已失效。

接口约束

该接口可以使用客户AK/SK或者Token调用。

调试

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

URI

GET /v2/promotions/benefits/coupons

参数说明请参见下表。

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

coupon_id

String

最大长度:64

优惠券ID。

此参数不携带或携带值为空时,不作为筛选条件。

order_id

String

最大长度:64

订单ID。

此参数不携带或携带值为空时,不作为筛选条件。

promotion_plan_id

String

最大长度:64

促销计划ID。

此参数不携带或携带值为空时,不作为筛选条件。

coupon_type

Integer

[1-4]

优惠券类型:

  • 1:代金券
  • 2:折扣券
  • 4:现金券

此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。

status

Integer

[1-5]

客户优惠券实例状态:

  • 2:待使用
  • 3:已使用
  • 4:已过期
  • 5:已回收

此参数不携带或携带值为空时,不作为筛选条件。

active_start_time

String

最大长度:64

激活开始时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

active_end_time

String

最大长度:64

激活结束时间。

UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。

此参数不携带或携带值为空时,不作为筛选条件;不支持携带值为空串或携带值为null。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

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

示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。

limit

Integer

[1-100]

查询的优惠券数量,默认值为10。

source_id

String

最大长度:255

发券来源,如果是合作伙伴发送的券,此处为伙伴ID。

如果需要查询某个伙伴发放的券,可以在此处输入该伙伴ID。

此参数不携带或携带值为空或携带值为null时,不作为筛选条件;携带值为空串时,作为筛选条件。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/promotions/benefits/coupons HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。

具体请参见状态码

error_msg

String

最大长度:1024

错误描述信息。

count

Integer

-

符合查询条件的总条数。

user_coupons

List<IQueryUserCouponsResult>

-

优惠券记录。

具体请参见表2

表2 IQueryUserCouponsResult

参数

参数类型

描述

coupon_id

String

优惠券实例ID。

coupon_code

String

优惠券编码。

status

Integer

优惠券状态:

  • 2:待使用
  • 3:已使用
  • 4:已过期
  • 5:已回收

customer_id

String

客户账号ID。

coupon_type

Integer

优惠券类型:

  • 1:代金券
  • 2:折扣券
  • 4:现金券

measure_id

Integer

度量单位。

1:元

face_value

Double

优惠券金额。

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

order_id

String

订单ID。

说明:

优惠券被多次交易抵扣场景下,返回每次抵扣订单号用英文分号分割,同一次交易抵扣场景下,如果是合并支付,会存在多个订单号,用英文逗号分割。举例:CS1904011928GIBHC1,CS1904011928GIBHC2,CS1904011928GIBHC3;CS1904011928GIBHCB。

存在多个订单号时,不表示全部订单号都使用了该优惠券。

promotion_plan_id

String

促销计划ID。

plan_name

String

促销计划名称。

plan_desc

String

促销计划描述。

media_type

Integer

介质类型。

  • 1:电子券
  • 2:纸质券

fetch_method

Integer

获取方式:

  • 1:线上领取
  • 2:线上兑换
  • 3:线上发放
  • 4:线下获取
  • 5:事件赠送

use_limits

List<ICouponUseLimitInfoV2>

优惠券使用限制。

具体请参见表3

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

promotion_id

String

促销ID。

create_time

String

创建时间。

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

coupon_version

Integer

优惠券版本:

  • 2:优惠券可以反复使用

balance

Double

优惠券余额。单位:元。

lock_order_id

String

锁定优惠券的订单ID。

coupon_usage

String

优惠券用途。

is_frozen

String

优惠券是否冻结:

  • 0:否
  • 1:是

currency

String

币种。

CNY:人民币

extend_param1

String

扩展字段。

source_id

String

发券来源。

  • 如果是合作伙伴发送的券,此处为伙伴ID。
  • 如果是活动发券,此处为活动ID:
    • 云豆兑换优惠券:云豆计划ID
    • 累计送优惠券:累计送计划ID
    • 抽奖送优惠券:抽奖计划ID
    • 事件送优惠券:事件计划ID
    • 定制优惠券:创建人ID
表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:预留实例
  • 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": "CP19092406014086E3",
      "coupon_code": "CP19092406014086E3",
      "status": "2",
      "customer_id": "c9e731c4663646988ef4cdb3122837b6",
      "coupon_type": "1",
      "measure_id": "1",
      "face_value": "100",
      "valid_time": "2019-09-16T16:00:00Z",
      "expire_time": "2019-09-16T16:00:00Z",
      "order_id": "CS1904011928GIBHC",
      "promotion_plan_id": "promotionPlanId5322584",
      "plan_name": "532元优惠券name",
      "plan_desc": "532元优惠券desc",
      "media_type": "1",
      "fetch_method": "1",
      "use_limits": [
        {
          "use_limiti_info_id": "CP19092406014086E3",
          "limit_key": "simultaneousUseWithDiscountCoupon",
          "value1": "1",
          "value2": "",
          "value_unit": "",
          "limit_type": "=",
          "promotion_plan_id": "promotionPlanId5322584"
        }
      ],
      "active_time": "2019-09-16T16:00:00Z",
      "reserve_time": "2019-09-16T16:00:00Z",
      "promotion_id": "promotionPlanId5322584",
      "create_time": "2019-09-16T16:00:00Z",
      "coupon_version": "2",
      "balance": "100",
      "lock_order_id": "CS1904011928GIBHC",
      "coupon_usage": "170719190603338056FEH60VIRWEP",
      "is_frozen": "0",
      "currency": "USD",
      "extend_param1": "2019091702368200",
      "source_id": "c9e731c4663646988ef4cdb3122837b6"
    }
  ]
}

状态码

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

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容