会员卡

MODULE_NAME	MODULE_DESC	入参	返参	路径
card_tasks	任务中心	CardTasksParams	CardTasksResp	card/index/tasks
card_next	下级会员卡信息	CardNextParams	CardNextResp	card/index/nextcard
card_require	入会前提	CardRequireParams	CardRequireResp	card/index/requireprofile
card_user_info	用户会员卡	CardUserinfoParams	CardUserinfoResp	card/index/userinfo
card_list	会员卡列表	CardListParams	CardListResp	card/index/cards
card_task_add	任务完成	CardTaskAddParams	CardTaskAddResp	card/index/taskadd

任务中心

CardTasksParams 参数

无参数

CardTasksResp 参数

interface CARD_TASKS_RESP {
  id: number;
  company_id: number;
  app_id: number;
  config_id: number;
  type: number;
  score: number;
  score_per: number;
  score_send: number;
  state: number;
  operator_id: number;
  created_at: string;
  updated_at: string;
  config: string; // 假设 config 是任意类型的数组
  is_complate: 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	是否微信

下级会员卡信息

CardNextParams 参数

interface CARD_NEXT_PARAMS {
  card_id: number; // 会员卡id，0为初始卡
  card_type: number; // 会员卡类型 0成长 1购物 2储值
}

参数名	参数描述	类型	是否必填
card_id	会员卡 id，0 为初始卡	number	否
card_type	会员卡类型 0 成长 1 购物 2 储值	number	否

CardNextResp 参数

interface CARD_NEXT_RESP {
  id: number;
  company_id: number;
  app_id: number;
  shop_name: string;
  card_name: string;
  card_logo: string;
  card_logo_in: string;
  background_type: number;
  background_name: string;
  background_img: string;
  is_postage_free: number;
  is_discount: number;
  discount: number;
  coupon: {
    id: number;
    name: string;
    num: number;
  }[];
  is_score: number;
  score: number;
  is_goods: number;
  goods: {
    id: number;
    name: string;
    num: number;
  }[];
  description: string;
  service_tel: string;
  right_extends: {
    id: number;
    name: string;
    rate: number;
  }[];
  card_type: number;
  card_type_limit: number;
  card_limit: number;
  card_limits: {
    type: number;
    limit: number;
  }[];
  card_int_money: string;
  card_keep: number;
  card_keep_day: number;
  card_keep_task: number;
  vip_level: number;
  gift_all: number;
  term_type: number;
  term_days: number;
  term_start_date: string;
  term_end_date: string;
  term_to_card_id: number;
  sku_name: string;
  sku_price: string;
  sku_stock: number;
  sku_code: string;
  sku_effect: string;
  is_activate: number;
  require_profile: number;
  require_profile_key: string;
  operator_id: number;
  created_at: string;
  updated_at: string;
  score_birthday_mul: string;
  score_shop_mul: string;
  state: number;
  right_detail: {
    right_id: number;
    config_id: number;
    config_right: string;
    right_type: number;
    right_name: string;
    right_icon: string;
    right_description: string;
    right_amount: string;
    right_rate: number;
  }[];
  config_right: string;
  is_wechat: number;
}

字段名	类型	描述
id	number	卡 ID
card_name	string	卡名称
card_logo	string	卡 Logo
card_logo_in	string	卡内 Logo
shop_name	string	店铺名称
background_type	number	背景类型
background_name	string	背景名称
background_img	string	背景图片
is_postage_free	number	是否免邮
is_discount	number	是否有折扣
discount	number	折扣
coupon	string(array of objects)JSON	优惠券列表
└─ id	number	优惠券 ID
└─ name	string	优惠券名称
└─ num	number	优惠券数量
is_score	number	是否积分
score	number	积分
is_goods	number	是否有商品
goods	string(array of objects)JSON	商品列表
└─ id	number	商品 ID
└─ name	string	商品名称
└─ num	number	商品数量
description	string	描述
service_tel	string	服务电话
right_extends	string(array of objects)JSON	权益扩展列表
└─ id	number	权益 ID
└─ name	string	权益名称
└─ rate	number	权益比率
card_type	number	卡类型
card_type_limit	number	卡类型限制
card_limit	number	卡限制
card_limits	string(array of objects)JSON	卡限制列表
└─ type	number	限制类型
└─ limit	number	限制作
card_int_money	string	卡初始金额
card_keep	number	续卡次数
card_keep_day	number	续卡天数
card_keep_task	number	续卡任务
vip_level	number	VIP 等级
gift_all	number	全部礼品
term_type	number	有效期类型
term_days	number	有效期天数
term_start_date	string	有效期开始日期（格式为日期时间）
term_end_date	string	有效期结束日期（格式为日期时间）
term_to_card_id	number	有效期对应的卡 ID
sku_name	string	SKU 名称
sku_price	string	SKU 价格
sku_stock	number	SKU 库存
sku_code	string	SKU 编码
sku_effect	string	SKU 效果
is_activate	number	是否激活
require_profile	number	是否需要资料
require_profile_key	string	需要的资料键
created_at	string	创建时间（格式为日期时间）
updated_at	string	更新时间（格式为日期时间）
score_birthday_mul	string	生日积分倍率
score_shop_mul	string	购物积分倍率
state	number	状态
right_detail	string(array of objects)JSON	权益详情列表
└─ right_id	number	权益 ID
└─ config_id	number	配置 ID
└─ config_right	string	配置权益
└─ right_type	number	权益类型
└─ right_name	string	权益名称
└─ right_icon	string	权益图标
└─ right_description	string	权益描述
└─ right_amount	string	权益数量
└─ right_rate	number	权益比率
config_right	array of strings	配置权益列表
is_wechat	number	是否微信
company_id	number	公司 ID
app_id	number	应用 ID
operator_id	number	操作员 ID

入会前提

CardRequireParams 参数

无参数

CardRequireResp 参数

interface CARD_REQUIRE_RESP {
  key: string; // 校验key
  value: string; // 已校验值
  name: string; // 名称
  is_set: number; // 是否已有
}

参数名	参数描述	类型
key	校验 key	string
value	已校验值	string
name	名称	string
is_set	是否已有	number

用户会员卡

CardUserinfoParams 参数

无参数

CardUserinfoResp 参数

interface CARD_USERINFO_RESP {
  id: number; // 1;
  company_id: number; // 102;
  app_id: number; // 259;
  store_id: number; // 0;
  pos_id: number; // 0;
  user_id: number; // 15;
  phone: string; // "";
  realname: string; // string;
  bithday: string; // string;
  sex: number; // 0;
  card_info_id: number; // 1;
  card_code: string; // "VIP240259000015";
  card_name: string; // "会员卡名称";
  term_name: string; // string;
  term_start: string; // string;
  term_end: string; // string;
  task_score: number; // 0;
  task_score_all: number; // 0;
  task_score_start: string; // string;
  task_score_end: string; // string;
  task_order_amount: string; // "0.00";
  task_order_num: number; // 0;
  created_at: string; // "2024-03-15 14:50:02";
  updated_at: string; // "2024-03-15 14:52:32";
  state: number; // 1;
  card_info: {
    id: number; // 1;
    company_id: number; // 102;
    app_id: number; // 259;
    shop_name: string; // "";
    card_name: string; // "会员卡名称";
    card_logo: string; // "";
    card_logo_in: string; // "";
    background_type: number; // 1;
    background_name: string; // "";
    background_img: string; // "https://pro-mixed-tt.ali-cache.com/2023/nxhbase/02/59/uploads";
    is_postage_free: number; // 0;
    is_discount: number; // 0;
    discount: number; // 0;
    coupon: Array<{
      id: number; // 1;
      name: string; // "优惠券";
      num: number; // 1;
    }>;
    is_score: number; // 0;
    score: number; // 0;
    is_goods: number; // 1;
    goods: Array<{
      id: number; // 1;
      name: string; // "商品";
      num: number; // 1;
    }>;
    description: string; // "";
    service_tel: string; // "";
    right_extends: Array<{
      id: number; // 1;
      name: string; // "折扣";
      rate: number; // 1;
    }>;
    card_type: number; // 0;
    card_type_limit: number; // 0;
    card_limit: number; // 0;
    card_limits: Array<{
      type: number; // 4;
      limit: number; // 0;
    }>;
    card_int_money: string; // "0.00";
    card_keep: number; // 0;
    card_keep_day: number; // 0;
    card_keep_task: number; // 0;
    vip_level: number; // 1;
    gift_all: number; // 0;
    term_type: number; // 0;
    term_days: number; // 0;
    term_start_date: string; // "";
    term_end_date: string; // "";
    term_to_card_id: number; // 0;
    sku_name: string; // "";
    sku_price: string; // "0.00";
    sku_stock: number; // 0;
    sku_code: string; // "0";
    sku_effect: string; // "0";
    is_activate: number; // 0;
    require_profile: number; // 1;
    require_profile_key: string; // "phone,nickname";
    operator_id: number; // 258;
    created_at: string; // "2024-03-13 18:44:08";
    updated_at: string; // string;
    score_birthday_mul: string; // "0.00";
    score_shop_mul: string; // "0.00";
    state: number; // 1;
    right_detail: Array<{
      right_id: number; // 1;
      config_id: number; // 1;
      config_right: string; // "discuss";
      right_type: number; // 0;
      right_name: string; // "折扣";
      right_icon: string; // "https://pro-mixed-tt.ali-cache.com/2023/nxhbase/00/00/uploads";
      right_description: string; // "下单享受打折优惠";
      right_amount: string; // "100.00";
      right_rate: number; // 1;
    }>;
    config_right: string; // ["discuss"];
  };
  require_profile_able: number; // 1;
  is_wechat: number; // 0;
}

字段名	类型	说明
id	number	主键 ID
store_id	number	门店 ID
pos_id	number	POS 机 ID
user_id	number	用户 ID
phone	string	用户电话
realname	string	用户真实姓名
birthday	string	用户生日
sex	number	用户性别（0：女，1：男）
card_info_id	number	会员卡信息 ID
card_code	string	会员卡号
card_name	string	会员卡名称
term_name	string	会员卡有效期名称
term_start	string	会员卡有效期开始日期
term_end	string	会员卡有效期结束日期
task_score	number	任务得分
task_score_all	number	累计任务得分
task_score_start	string	任务得分开始日期
task_score_end	string	任务得分结束日期
task_order_amount	string	任务订单金额
task_order_num	number	任务订单数量
created_at	string	创建时间
updated_at	string	更新时间
state	number	状态（0：无效，1：有效）
card_info	object	会员卡信息对象
└─ id	number	会员卡信息 ID
└─ company_id	number	公司 ID
└─ app_id	number	应用 ID
└─ shop_name	string	店铺名称
└─ card_name	string	会员卡名称
└─ card_logo	string	会员卡 LOGO
└─ card_logo_in	string	会员卡内页 LOGO
└─ background_type	number	背景类型
└─ background_name	string	背景名称
└─ background_img	string	背景图片 URL
└─ is_postage_free	number	是否免邮费（0：否，1：是）
└─ is_discount	number	是否有折扣（0：否，1：是）
└─ discount	number	折扣数值
└─ coupon	string(array of objects)JSON	优惠券数组
	└─ id	number	优惠券 ID
	└─ name	string	优惠券名称
	└─ num	number	优惠券数量
└─ is_score	number	是否有积分（0：否，1：是）
└─ score	number	积分数值
└─ is_goods	number	是否有商品（0：否，1：是）
└─ goods	string(array of objects)JSON	商品数组
	└─ id	number	商品 ID
	└─ name	string	商品名称
	└─ num	number	商品数量
└─ description	string	描述
└─ service_tel	string	服务电话
└─ right_extends	string(array of objects)JSON	权益扩展数组
	└─ id	number	权益 ID
	└─ name	string	权益名称
	└─ rate	number	权益比率
└─ card_type	number	会员卡类型
└─ card_type_limit	number	会员卡类型限制
└─ card_limit	number	会员卡限制
└─ card_limits	string(array of objects)JSON	会员卡限制数组
	└─ type	number	限制类型
	└─ limit	number	限制值
└─ card_int_money	string	会员卡初始金额
└─ card_keep	number	保留字段 1
└─ card_keep_day	number	保留字段 2
└─ card_keep_task	number	保留字段 3
└─ vip_level	number	VIP 等级
└─ gift_all	number	是否有礼品（0：否，1：是）
└─ term_type	number	有效期类型
└─ term_days	number	有效期天数
└─ term_start_date	string	有效期开始日期
└─ term_end_date	string	有效期结束日期
└─ term_to_card_id	number	转换至其他会员卡的 ID
└─ sku_name	string	SKU 名称
└─ sku_price	string	SKU 价格
└─ sku_stock	number	SKU 库存
└─ sku_code	string	SKU 编码
└─ sku_effect	string	SKU 生效期
└─ is_activate	number	是否激活（0：否，1：是）
└─ require_profile	number	是否需要完善资料（0：否，1：是）
└─ require_profile_key	string	需要完善的资料 Key
└─ operator_id	number	操作员 ID
└─ created_at	string	创建时间
└─ updated_at	string	更新时间
└─ score_birthday_mul	string	生日积分倍数
└─ score_shop_mul	string	店铺积分倍数
└─ state	number	状态（0：无效，1：有效）
└─ right_detail	string(array of objects)JSON	权益详情数组
	└─ right_id	number	权益 ID
	└─ config_id	number	配置 ID
	└─ config_right	string	配置权益
	└─ right_type	number	权益类型
	└─ right_name	string	权益名称
	└─ right_icon	string	权益图标 URL
	└─ right_description	string	权益描述
	└─ right_amount	string	权益数量
	└─ right_rate	number	权益比率
└─ config_right	string	配置的权益字符串数组
require_profile_able	number	是否可以完善资料
is_wechat	number	是否为微信用户（0：否，1：是）
company_id	number	公司 ID
app_id	number	应用 ID

会员卡列表

CardListParams 参数

interface CARD_LIST_PARAMS {
  card_type: number; // 会员卡类型 0成长 1购物 2储值
}

字段名	类型	描述
card_type	number	会员卡类型 0 成长 1 购物 2 储值

CardListResp 参数

interface CARD_LIST_RESP {
  id: number;
  company_id: number;
  app_id: number;
  shop_name: string;
  card_name: string;
  card_logo: string;
  card_logo_in: string;
  background_type: number;
  background_name: string;
  background_img: string;
  is_postage_free: number;
  is_discount: number;
  discount: number;
  coupon: {
    id: number;
    name: string;
    num: number;
  }[];
  is_score: number;
  score: number;
  is_goods: number;
  goods: {
    id: number;
    name: string;
    num: number;
  }[];
  description: string;
  service_tel: string;
  right_extends: {
    id: number;
    name: string;
    rate: number;
  }[];
  card_type: number;
  card_type_limit: number;
  card_limit: number;
  card_limits: string;
  card_int_money: string;
  card_keep: number;
  card_keep_day: number;
  card_keep_task: number;
  vip_level: number;
  gift_all: number;
  term_type: number;
  term_days: number;
  term_start_date: string;
  term_end_date: string;
  term_to_card_id: number;
  sku_name: string;
  sku_price: string;
  sku_stock: number;
  sku_code: string;
  sku_effect: string;
  is_activate: number;
  require_profile: number;
  require_profile_key: string;
  operator_id: number;
  created_at: string;
  updated_at: string;
  score_birthday_mul: string;
  score_shop_mul: string;
  state: number;
}

字段名	类型	说明
id	number	主键 ID
shop_name	string	店铺名称
card_name	string	会员卡名称
card_logo	string	会员卡 LOGO
card_logo_in	string	会员卡内页 LOGO
background_type	number	背景类型
background_name	string	背景名称
background_img	string	背景图片 URL
is_postage_free	number	是否免邮费（0：否，1：是）
is_discount	number	是否有折扣（0：否，1：是）
discount	number	折扣数值
coupon	array	优惠券数组
└─ id	number	优惠券 ID
└─ name	string	优惠券名称
└─ num	number	优惠券数量
is_score	number	是否有积分（0：否，1：是）
score	number	积分数值
is_goods	number	是否有商品（0：否，1：是）
goods	array	商品数组
└─ id	number	商品 ID
└─ name	string	商品名称
└─ num	number	商品数量
description	string	描述
service_tel	string	服务电话
right_extends	array	权益扩展数组
└─ id	number	权益 ID
└─ name	string	权益名称
└─ rate	number	权益比率
card_type	number	会员卡类型
card_type_limit	number	会员卡类型限制
card_limit	number	会员卡限制
card_limits	string	会员卡限制字符串
card_int_money	string	会员卡初始金额
card_keep	number	保留字段 1
card_keep_day	number	保留字段 2
card_keep_task	number	保留字段 3
vip_level	number	VIP 等级
gift_all	number	是否有礼品（0：否，1：是）
term_type	number	有效期类型
term_days	number	有效期天数
term_start_date	string	有效期开始日期
term_end_date	string	有效期结束日期
term_to_card_id	number	转换至其他会员卡的 ID
sku_name	string	SKU 名称
sku_price	string	SKU 价格
sku_stock	number	SKU 库存
sku_code	string	SKU 编码
sku_effect	string	SKU 生效期
is_activate	number	是否激活（0：否，1：是）
require_profile	number	是否需要完善资料（0：否，1：是）
require_profile_key	string	需要完善的资料 Key
operator_id	number	操作员 ID
created_at	string	创建时间
updated_at	string	更新时间
score_birthday_mul	string	生日积分倍数
score_shop_mul	string	店铺积分倍数
state	number	状态（0：无效，1：有效）
company_id	number	公司 ID
app_id	number	应用 ID

任务完成

CardTaskAddParams 参数

interface CARD_TASK_ADD_PARAMS {
  code: string; // 任务配置code，非系统级可调用
}

字段名	类型	描述	示例值	必填
code	string	任务配置 code，非系统级可调用	'perfect_info'	是

CardTaskAddResp 参数

interface CARD_TASK_ADD_RESP {
  score: number; // 增加成长值
  is_wechat: number; // 是否为微信端
}

字段名	类型	描述
score	number	增加成长值
is_wechat	number	是否为微信端