# dcb.getCoupons

客户端 7.0.0 开始支持,低版本需做兼容处理。

获取全部可用的优惠券,与 chooseCoupon 的区别在于不会调起优惠券选择弹窗,直接返回全部可用的优惠券。

# 参数

属性 类型 默认值 必填 说明 最低版本
amount

number

订单金额(元)。

7.0.0
goodsIds

Array<string | Object>

商品 ID 列表,支持 JSON 字符串。

7.0.0
unitOrgCode

Array<string>

优惠券支持的机构。

7.1.0
businessType

string

优惠券支持的业务类型。

7.1.0

# 返回值

属性 类型 说明 最低版本
data

Array<Object>

属性类型必填说明
couponIdstring优惠券 ID
couponNamestring优惠名称
couponTypenumber优惠类型:1=满减券,2=折扣券,3=兑换券,4=随机金额券
denominationstring抵扣金额/折扣数/兑换
discountedAmtnumber优惠金额
endTimestring有效结束日期
minPointAmtstring门槛金额
nearExpirenumber是否即将过期,0-否,1-是
payAmtnumber支付金额
remarksstring备注说明
scopestring适用范围
statusnumber状态:1=可用券,2=已过期,3=已作废,4=退回可用,5=已使用,6=订单冻结中
useTimeTypenumber优惠券可用时间
useTimeValstring优惠券可用时间值

卡券列表。

# 示例

const res = await dcb.getCoupons({
  amount: 10,
  goodsIds: ['122333'],
});
// 结果类似:
// [{
//   "couponId": "8a8a893075d3e7160175d40e316a0005",
//   "couponName": "兑换优惠券",
//   "couponType": 3,
//   "denomination": "兑换",
//   "discountedAmt": 0,
//   "endTime": "有效期至:2020/11/30",
//   "minPointAmt": "",
//   "nearExpire": 0,
//   "remarks": "无门槛(备注)",
//   "scope": "全部商品",
//   "status": 1,
//   "useTimeType": 3,
//   "useTimeVal": "周一、周二、周三、周四、周五、周六、周日 09:00-12:00 可用<br/>周一、周二、周三、周四、周五、周六、周日 13:00-24:00 可用",
//   "validEndTime": "2020-11-30T23:59:59"
// }]

# 贡献者

上次更新时间: 3/11/2022, 3:51:50 PM