使用方式
更新时间:2025-07-03 14:46:06
一、获取可领取优惠券列表
获取当前频道下所有可领取的优惠券列表,支持分页查询。
Api 方法: getCouponCommonList(options?: PageOptions): Promise<PageContent<CouponCommonData>>
参数说明:
- options:分页选项,
PageOptions类型,选传,默认{},详细类型说明如下
| 参数名 | 说明 | 类型 | 必须 | 默认值 |
|---|---|---|---|---|
pageNumber |
页数 | number |
否 | - |
pageSize |
页码 | number |
否 | - |
返回值说明: 可领取优惠券列表,Promise<PageContent<CouponCommonData>> 类型,详细类型说明如下
| 属性名 | 说明 | 类型 |
|---|---|---|
pageNumber |
当前页数 | number |
pageSize |
每页数量 | number |
totalItems |
总记录数 | number |
totalPages |
总页数 | number |
contents |
内容列表 | I[] |
示例:
const couponList = await coupon.getCouponCommonList({ pageNumber: 1, pageSize: 10 });
console.log('优惠券列表:', couponList.contents);
console.log('总数量:', couponList.totalItems);
二、领取优惠券
用户领取指定的优惠券。
Api 方法: receiveCoupon(couponId: string): Promise<void>
参数说明:
- couponId:优惠券 ID,
string类型,必传
示例:
await coupon.receiveCoupon('coupon123');
console.log('优惠券领取成功');
三、获取已领取优惠券列表
获取当前用户已领取的优惠券列表,支持分页查询。
Api 方法: getCouponUserList(options?: PageOptions): Promise<PageContent<CouponUserData>>
参数说明:
- options:分页选项,
PageOptions类型,选传,默认{},详细类型说明如下
| 参数名 | 说明 | 类型 | 必须 | 默认值 |
|---|---|---|---|---|
pageNumber |
页数 | number |
否 | - |
pageSize |
页码 | number |
否 | - |
返回值说明: 已领取优惠券列表,Promise<PageContent<CouponUserData>> 类型,详细类型说明如下
| 属性名 | 说明 | 类型 |
|---|---|---|
pageNumber |
当前页数 | number |
pageSize |
每页数量 | number |
totalItems |
总记录数 | number |
totalPages |
总页数 | number |
contents |
内容列表 | I[] |
示例:
const userCoupons = await coupon.getCouponUserList({ pageNumber: 1, pageSize: 10 });
console.log('我的优惠券:', userCoupons.contents);
