优惠券

MODULE_NAME	MODULE_DESC	入参	返参	路径
coupon_list	优惠券列表	CouponListParams	CouponListResp	coupon/user/couponlists
coupon_share	赠送优惠券	CouponShareParams	CouponShareResp	coupon/give/share
coupon_shares	批量赠送优惠券	CouponSharesParams	CouponSharesResp	coupon/give/shares
coupon_cancel	取消赠送	CouponCancelParams	CouponCancelResp	coupon/give/cancel
coupon_cancels	批量取消赠送	CouponCancelsParams	CouponCancelsResp	coupon/give/cancels
coupon_detail	领取详情	CouponDetailParams	CouponDetailResp	coupon/give/info
coupon_details	批量领取详情	CouponDetailsParams	CouponDetailsResp	coupon/give/infos
coupon_receive	领取优惠券	CouponReceiveParams	CouponReceiveResp	coupon/give/receive
coupon_receives	批量领取优惠券	CouponReceivesParams	CouponReceivesResp	coupon/give/receives
coupon_exchange	兑换优惠券	CouponExchangeParams	CouponExchangeResp	coupon/info/receive

优惠券列表

CouponListParams 类型

interface COUPON_LIST_PARAMS {
  state: number; // 状态 0全部 1可用 2已经用 6赠送待领取 7已赠送 8已过期
  page: number; // 页码
  limit: number; // 分页量，默认10
}

参数名	参数描述	类型	是否必填
state	状态 0 全部 1 可用 2 已经用 6 赠送待领取 7 已赠送 8 已过期	number	是
page	页码	number	是
limit	分页量，默认 10	number	是

CouponListResp 类型

interface COUPON_LIST_RESP {
  code: string; // 优惠券代码，应为字符串类型
  condition: string; // 使用条件，应为数组类型
  coupon_id: number; // 优惠券ID，应为数字类型
  full: number; // 是否满减，应为数字类型
  give_id: number; // 赠送ID，应为数字类型
  id: number; // ID，应为数字类型
  mobile_img: string; // 移动端图片，可以为null或字符串类型
  receive_last_date: number; // 最后领取日期，应为数字类型
  rel_coupon_name: string; // 关联优惠券名称，应为字符串类型
  rel_nickname: string; // 关联昵称，可以为null或字符串类型
  reward: string; // 奖励信息，应为字符串类型（格式可能是JSON字符串）
  reward_txt: string; // 奖励文本，应为字符串类型
  reward_type: number; // 奖励类型，应为数字类型
  sfrom: string; // 来源，应为字符串类型
  share_config: number; // 分享配置，应为数字类型
  state: number; // 状态，应为数字类型
  stock_id: number; // 库存ID，应为数字类型
  subtract: number; // 是否减去，应为数字类型
  app_id: number; // 应用ID，应为数字类型
  can_use_goods: string; // 可使用的商品列表，应为数组类型
  company_id: number; // 公司ID，应为数字类型
  created_at: string; // 创建时间
  describe: string; // 描述，应为字符串类型
  extends: string; // 扩展信息，应为字符串类型
  no_can_use_goods: string; // 不可使用的商品列表，应为数组类型
  operator_id: number; // 操作员ID，应为数字类型
  order_id: number; // 订单ID，应为数字类型
  pc_img: string; // PC端图片，可以为null或字符串类型
  updated_at: string; // 更新时间，可以为null或字符串类型（格式为日期时间）
  use_end_date: string; // 使用结束日期
  use_model: number; // 使用模型，应为数字类型
  use_start_date: string; // 使用开始日期
  user_id: number; // 用户ID，应为数字类型
}

字段名	类型	描述
code	string	优惠券代码
condition	string	使用条件，应为数组类型
coupon_id	number	优惠券 ID
full	number	是否满减
give_id	number	赠送 ID
id	number	ID
mobile_img	string	移动端图片，可以为 null 或字符串类型
receive_last_date	number	最后领取日期
rel_coupon_name	string	关联优惠券名称
rel_nickname	string	关联昵称，可以为 null 或字符串类型
reward	string	奖励信息，应为字符串类型（格式可能是 JSON 字符串）
reward_txt	string	奖励文本
reward_type	number	奖励类型
sfrom	string	来源
share_config	number	分享配置
state	number	状态
stock_id	number	库存 ID
subtract	number	是否减去
app_id	number	应用 ID
can_use_goods	string	可使用的商品列表，应为数组类型
company_id	number	公司 ID
created_at	string	创建时间
describe	string	描述
extends	string	扩展信息
no_can_use_goods	string	不可使用的商品列表，应为数组类型
operator_id	number	操作员 ID
order_id	number	订单 ID
pc_img	string	PC 端图片，可以为 null 或字符串类型
updated_at	string	更新时间，可以为 null 或字符串类型（格式为日期时间）
use_end_date	string	使用结束日期
use_model	number	使用模型
use_start_date	string	使用开始日期
user_id	number	用户 ID

赠送优惠券

CouponShareParams 类型

interface COUPON_SHARE_PARAMS {
  coupon_user_id: number; // 用户优惠券id
}

参数名	参数描述	类型	是否必填
coupon_user_id	用户优惠券 id	number	是

CouponShareResp 类型

interface COUPON_SHARE_RESP {
  share_id: number; // 分享id
}

参数名	参数描述	类型
share_id	分享 id	number

批量赠送优惠券

CouponSharesParams 类型

interface COUPON_SHARES_PARAMS {
  coupon_user_id: string; // 用户优惠券id串，英文逗号拼接
}

参数名	参数描述	类型	是否必填
coupon_user_id	用户优惠券 id 串，英文逗号拼接	string	是

CouponSharesResp 类型

interface COUPON_SHARES_RESP {
  id: number; // 分享id 0为失败
  error: number; // 错误码 0为成功
  msg: string; // 提示信息
}

参数名	参数描述	类型
id	分享 id 0 为失败	number
error	错误码 0 为成功	number
msg	提示信息	string

取消赠送

CouponCancelParams 类型

interface COUPON_CANCEL_PARAMS {
  coupon_user_id: number; // 用户优惠券id
}

参数名	参数描述	类型	是否必填
coupon_user_id	用户优惠券 id	number	是

CouponCancelResp 类型

interface COUPON_CANCEL_RESP {
  result: string; // 返回结果
}

参数名	参数描述	类型
result	返回结果	string

批量取消赠送

CouponCancelsParams 类型

interface COUPON_CANCELS_PARAMS {
  coupon_user_id: string; // 用户优惠券id串，英文逗号拼接
}

参数名	参数描述	类型	是否必填
coupon_user_id	用户优惠券 id 串，英文逗号拼接	string	是

CouponCancelsResp 类型

interface COUPON_CANCELS_RESP {
  id: number; // 分享id 0为失败
  error: number; // 错误码 0为成功
  msg: string; // 提示信息
}

参数名	参数描述	类型
id	分享 id 0 为失败	number
error	错误码 0 为成功	number
msg	提示信息	string

领取详情

CouponDetailParams 类型

interface COUPON_DETAIL_PARAMS {
  share_id: number; // 优惠券分享id
}

参数名	参数描述	类型	是否必填
share_id	优惠券分享 id	number	是

CouponDetailResp 类型

interface COUPON_DETAIL_RESP {
  id: number;
  company_id: number;
  app_id: number;
  name: string;
  pc_img: string;
  mobile_img: string;
  url: string;
  describe: string;
  context: string;
  use_model: number;
  use_start_date: string;
  use_end_date: string;
  reward_type: number;
  reward: string; // JSON string representing an object
  reward_txt: string;
  receive_model: number;
  receive_once: number;
  recommend: number;
  receive_start_date: string;
  receive_end_date: string;
  sort: number;
  give_num: number;
  stock_num: number;
  operator_id: number;
  created_at: string;
  updated_at: string;
  state: number;
  is_default: number;
  is_default_switch: number;
  default_days: number;
  receive_last_date: number;
  receive_use_date: number;
  type: number;
  thirdparty_coupon_id: string;
  receive_level: number;
  receive_num: number;
  share_type: number;
  share_url: string;
  share_config: number;
  is_secret: number;
  give_user_id: number;
  give_username: string;
  is_wechat: number;
}

字段名	类型	描述
id	number	优惠券 ID
name	string	优惠券名称
reward_type	number	奖励类型
reward	string	奖励信息，应为 JSON 字符串表示的对象
reward_txt	string	奖励文本
receive_model	number	领取模式
receive_once	number	单次领取数量
recommend	number	推荐状态
company_id	number	公司 ID
mobile_img	string	移动端图片
url	string	URL
describe	string	描述
context	string	内容
use_model	number	使用模型
app_id	number	应用 ID
pc_img	string	PC 端图片
use_start_date	string	使用开始日期
use_end_date	string	使用结束日期
receive_start_date	string	领取开始日期
receive_end_date	string	领取结束日期
sort	number	排序
give_num	number	发放数量
stock_num	number	库存数量
state	number	状态
is_default	number	是否默认
is_default_switch	number	默认开关状态
default_days	number	默认天数
receive_last_date	number	最后领取日期
receive_use_date	number	领取使用日期
type	number	类型
thirdparty_coupon_id	string	第三方优惠券 ID
receive_level	number	领取等级
receive_num	number	领取数量
share_type	number	分享类型
share_url	string	分享 URL
share_config	number	分享配置
is_secret	number	是否保密
give_user_id	number	赠送用户 ID
give_username	string	赠送用户名
is_wechat	number	是否微信
operator_id	number	操作员 ID
created_at	string	创建时间
updated_at	string	更新时间

批量领取详情

CouponDetailsParams 类型

interface COUPON_DETAILS_PARAMS {
  share_id: string; // 用户优惠券分享id串，英文逗号拼接
}

参数名	参数描述	类型	是否必填
share_id	用户优惠券分享 id 串，英文逗号拼接	string	是

CouponDetailsResp 类型

interface COUPON_DETAILS_PARAMS {
  id: number; // 分享id
  error: number; // 错误码;
  info: object; // 领取信息
}

参数名	参数描述	类型
id	分享 id	number
error	错误码	number
info	领取信息	object

info 内的参数	参数描述	类型
id	number	优惠券 ID
name	string	优惠券名称
company_id	number	公司 ID
app_id	number	应用 ID
mobile_img	string	移动端图片
url	string	URL
describe	string	描述
context	string	内容
use_model	number	使用模型
use_start_date	string	使用开始日期（格式为日期时间）
use_end_date	string	使用结束日期（格式为日期时间）
reward_type	number	奖励类型
reward	string	奖励信息
reward_txt	string	奖励文本
receive_model	number	领取模式
receive_once	number	单次领取数量
recommend	number	推荐状态
receive_start_date	string	领取开始日期（格式为日期时间）
receive_end_date	string	领取结束日期（格式为日期时间）
sort	number	排序
give_num	number	发放数量
stock_num	number	库存数量
pc_img	string	PC 端图片
state	number	状态
is_default	number	是否默认
is_default_switch	number	默认开关状态
default_days	number	默认天数
receive_last_date	number	最后领取日期
receive_use_date	number	领取使用日期
type	number	类型
thirdparty_coupon_id	string	第三方优惠券 ID
receive_level	number	领取等级
receive_num	number	领取数量
share_type	number	分享类型
share_url	string	分享 URL
share_config	number	分享配置
is_secret	number	是否保密
give_user_id	number	赠送用户 ID
give_username	string	赠送用户名
give_state	string	赠送状态
operator_id	number	操作员 ID
created_at	string	创建时间（格式为日期时间）
updated_at	string	更新时间（格式为日期时间）
is_wechat	number	是否微信

领取优惠券

CouponReceiveParams 类型

interface COUPON_RECEIVE_PARAMS {
  share_id: number; // 优惠券分享id
}

参数名	参数描述	类型	是否必填
share_id	优惠券分享 id	number	是

CouponReceiveResp 类型

interface COUPON_RECEIVE_RESP {
  result: string; // 返回结果
}

参数名	参数描述	类型
result	返回结果	string

批量领取优惠券

CouponReceivesParams 类型

interface COUPON_RECEIVES_PARAMS {
  share_id: string; // 用户优惠券分享id串，英文逗号拼接
}

参数名	参数描述	类型	是否必填
share_id	用户优惠券分享 id 串，英文逗号拼接	string	是

CouponReceivesResp 类型

interface COUPON_RECEIVES_RESP {
  id: number; // 分享id 0为失败
  error: number; // 错误码 0为成功
  msg: string; // 提示信息
}

参数名	参数描述	类型
id	分享 id 0 为失败	number
error	错误码 0 为成功	number
msg	提示信息	string

兑换优惠券

CouponExchangeParams 类型

interface COUPON_EXCHANGE_PARAMS {
  code: string; // 兑换码
  secret: string; // 密钥
}

参数名	参数描述	类型	是否必填
code	兑换码	string	是
secret	密钥	string	是

CouponExchangeResp 类型

interface COUPON_EXCHANGE_RESP {
  coupon_id: number;
  stock_id: number;
  user_id: number;
  code: string;
  use_start_date: string;
  use_end_date: string;
  created_at: string;
  state: number;
  id: string;
  is_wechat: number;
}

字段名	类型	描述
coupon_id	number	优惠券 ID
stock_id	number	库存 ID
user_id	number	用户 ID
code	string	兑换码
use_start_date	string	使用开始日期（格式为日期时间）
use_end_date	string	使用结束日期（格式为日期时间）
created_at	string	创建时间（格式为日期时间）
state	number	状态
id	string	ID
is_wechat	number	是否微信

优惠券 ​

优惠券列表 ​

CouponListParams 类型 ​

CouponListResp 类型 ​

赠送优惠券 ​

CouponShareParams 类型 ​

CouponShareResp 类型 ​

批量赠送优惠券 ​

CouponSharesParams 类型 ​

CouponSharesResp 类型 ​

取消赠送 ​

CouponCancelParams 类型 ​

CouponCancelResp 类型 ​

批量取消赠送 ​

CouponCancelsParams 类型 ​

CouponCancelsResp 类型 ​

领取详情 ​

CouponDetailParams 类型 ​

CouponDetailResp 类型 ​

批量领取详情 ​

CouponDetailsParams 类型 ​

CouponDetailsResp 类型 ​

领取优惠券 ​

CouponReceiveParams 类型 ​

CouponReceiveResp 类型 ​

批量领取优惠券 ​

CouponReceivesParams 类型 ​

CouponReceivesResp 类型 ​

兑换优惠券 ​

CouponExchangeParams 类型 ​

CouponExchangeResp 类型 ​

优惠券

优惠券列表

CouponListParams 类型

CouponListResp 类型

赠送优惠券

CouponShareParams 类型

CouponShareResp 类型

批量赠送优惠券

CouponSharesParams 类型

CouponSharesResp 类型

取消赠送

CouponCancelParams 类型

CouponCancelResp 类型

批量取消赠送

CouponCancelsParams 类型

CouponCancelsResp 类型

领取详情

CouponDetailParams 类型

CouponDetailResp 类型

批量领取详情

CouponDetailsParams 类型

CouponDetailsResp 类型

领取优惠券

CouponReceiveParams 类型

CouponReceiveResp 类型

批量领取优惠券

CouponReceivesParams 类型

CouponReceivesResp 类型

兑换优惠券

CouponExchangeParams 类型

CouponExchangeResp 类型