- swagger
- 平台
- 商家商品
- 设置
- 供应链
- 仓库
- 采购
- 要货
- 【商户平台(CMC)】门店收货单模块
- 【商户平台(CMC)】门店退货单模块
- 【商户平台(CMC)】门店结算价模块
- 【商户平台(CMC)】门店补货模板模块
- 【商户平台(CMC)】门店补货模板同步任务模块
- 【商户平台(CMC)】门店补货清单模块
- 【商户平台(CMC)】补货订单模块
- 【商户平台(CMC)】补货接单批次模块
- 【商户平台(CMC)】补货接单批次转采购记录模块
- 【商户平台(CMC)】门店结算价模板模块
- 【商户平台(CMC)】门店结算价模板同步任务模块
- 【商户平台(CMC)】门店额度明细记录模块
- 【商户平台(CMC)】门店额度模块
- 【商户平台(CMC)】补货订单(门店额度管理)模块
- 【商户平台(CMC)】门店退货单(门店额度管理)模块
- 门店生产
- 销售
- 商城
- 【商户平台(CMC)】满减
- 【商户平台(CMC)】小程序装修资料模块
- 【商户平台(CMC)】外卖退款原因模块
- 【商户平台(CMC)】抖音兑换记录
- 【商户平台(CMC)】快递运费模版
- 【商户平台(CMC)】限时折扣活动模块
- 【商户平台(CMC)】电商商城菜单
- 【商户平台(CMC)】电商商城菜单分组
- 【商户平台(CMC)】会员优惠专场模块
- 【商户平台(CMC)】菜单同步任务模块
- 【商户平台(CMC)】菜单模版模块
- 【商户平台(CMC)】小程序公告模块
- 【商户平台(CMC)】小程序弹窗广告模块
- 【商户平台(CMC)】商城销售退单模块
- 【商户平台(CMC)】商城退单账单模块
- 【商户平台(CMC)】商城退单支付记录模块
- 【商户平台(CMC)】商城概览模块
- 【商户平台(CMC)】商城订单模块
- 【商户平台(CMC)】商城订单账单模块
- 【商户平台(CMC)】商城订单支付记录模块
- 【商户平台(CMC)】秒杀活动模块
- 【商户平台(CMC)】门店外卖设置模块
- 【商户平台(CMC)】门店菜单分组模块
- 【商户平台(CMC)】商品模块
- 【商户平台(CMC)】店铺装修模版模块
- 【小程序(MP)】微信
- 【商户平台(CMC)】门店限时折扣活动模块
- 【商户平台(CMC)】门店满减
- 支付
- 【商户平台(CMC)】支付账户-支付宝模块
- 【商户平台(CMC)】支付账户-翼支付模块
- 【商户平台(CMC)】支付账户-银联POS通模块
- 【商户平台(CMC)】支付账户-银联商务大华捷通模块
- 【商户平台(CMC)】支付账户-掌上生活模块
- 【商户平台(CMC)】支付账户-和包支付模块
- 【商户平台(CMC)】支付账户-聚福宝模块
- 【商户平台(CMC)】支付账户-联科快付模块
- 【商户平台(CMC)】支付账户-扫呗模块
- 【商户平台(CMC)】支付账户-收钱吧模块
- 【商户平台(CMC)】支付账户-威富通模块
- 【商户平台(CMC)】支付账户-云闪付模块
- 【商户平台(CMC)】支付账户-微信支付模块
- 【商户平台(CMC)】支付账户-智付云模块
- 【商户平台(CMC)】支付应用模块
- 【商户平台(CMC)】支付交易流水模块
- 【商户平台(CMC)】支付账户-聚合支付模块
- 【商户平台(CMC)】门店支付账号模块
- 会员卡券
- 礼品卡
- 【商户平台(CMC)】礼品卡模块
- 【商户平台(CMC)】会员礼品卡调整模块
- 【商户平台(CMC)】礼品卡流水记录模块
- 【商户平台(CMC)】礼品卡明细模块
- 【商户平台(CMC)】礼品卡订单模块
- 【商户平台(CMC)】POS售卡订单账单模块
- 【商户平台(CMC)】售卡订单支付记录模块
- 【商户平台(CMC)】礼品卡退单模块
- 【商户平台(CMC)】售卡退单支付记录模块
- 【商户平台(CMC)】礼品卡营销活动模块
- 【商户平台(CMC)】礼品卡操作记录模块
- 【商户平台(CMC)】礼品卡储值模块
- 【商户平台(CMC)】礼品卡储值单支付记录模块
- 【商户平台(CMC)】礼品卡储值退款模块
- 【商户平台(CMC)】礼品卡储值退单支付记录模块
- 【商户平台(CMC)】校园卡模块
- 【商户平台(CMC)】校园卡操作记录模块
- 优惠券
- 【商户平台(CMC)】优惠券模块
- 【商户平台(CMC)】会员优惠券模块
- 【商户平台(CMC)】优惠券流水记录模块
- 【商户平台(CMC)】优惠券操作记录模块
- 会员
- 【商户平台(CMC)】会员模块
- 【商户平台(CMC)】会员钱包调整模块
- 【商户平台(CMC)】会员钱包流水记录模块
- 【商户平台(CMC)】会员生日有礼模块
- 【商户平台(CMC)】会员等级模块
- 【商户平台(CMC)】会员等级方案
- 【商户平台(CMC)】会员邀请有礼模块
- 【商户平台(CMC)】会员接收邀请记录模块
- 【商户平台(CMC)】会员邀请记录模块
- 【商户平台(CMC)】会员发券模块
- 【商户平台(CMC)】会员发券记录模块
- 【商户平台(CMC)】会员手机号变更记录模块
- 【商户平台(CMC)】会员完善资料奖励模块
- 【商户平台(CMC)】会员注册有礼模块
- 【商户平台(CMC)】会员首充有礼模块
- 【商户平台(CMC)】会员签到记录模块
- 【商户平台(CMC)】会员签到有礼模块
- 【商户平台(CMC)】会员签到奖励发放记录模块
- 【商户平台(CMC)】会员标签模块
- 【商户平台(CMC)】会员储值模块
- 【商户平台(CMC)】会员储值单支付记录模块
- 【商户平台(CMC)】会员线上储值活动模块
- 【商户平台(CMC)】会员储值退款模块
- 【商户平台(CMC)】会员储值退单支付记录模块
- 【商户平台(CMC)】会员协议模块
- 【商户平台(CMC)】会员亲情卡模块
- 积分
- 【商户平台(CMC)】卡券销售检查模块
- 【商户平台(CMC)】优惠券统计模块
- 【商户平台(CMC)】礼品卡统计模块
- 【商户平台(CMC)】会员储值统计模块
- 门店
- 【商户平台(CMC)】POS外屏广告模块
- 【商户平台(CMC)】POS搭售模块
- 【商户平台(CMC)】收银员角色模块
- 【商户平台(CMC)】POS销售订单(点餐)模块
- 【商户平台(CMC)】POS销售退单(点餐)模块
- 【商户平台(CMC)】POS满减
- 【商户平台(CMC)】POS参数模块
- 【商户平台(CMC)】POS限时折扣活动模块
- 【商户平台(CMC)】POS备注模块
- 【商户平台(CMC)】POS菜单同步任务模块
- 【商户平台(CMC)】POS菜单模版模块
- 【商户平台(CMC)】支付菜单同步任务模块
- 【商户平台(CMC)】支付菜单模版模块
- 【商户平台(CMC)】POS支付订单模块
- 【商户平台(CMC)】支付方式资料维护模块
- 【商户平台(CMC)】门店收银概览模块
- 【商户平台(CMC)】门店档口模块
- 【商户平台(CMC)】门店收银应用版本模块
- 【商户平台(CMC)】门店收银员模块
- 【商户平台(CMC)】门店盘点单模块
- 【商户平台(CMC)】门店盘点任务模块
- 【商户平台(CMC)】门店库存模块
- 【商户平台(CMC)】门店每日库存记录模块
- 【商户平台(CMC)】门店库存记录模块
- 【商户平台(CMC)】门店POS菜单分组模块
- 【商户平台(CMC)】POS商品模块
- 【商户平台(CMC)】门店其他出入库模块
- 【商户平台(CMC)】门店其他出入库原因模块
- 【商户平台(CMC)】门店支付菜单模块
- 【商户平台(CMC)】门店打印机模块
- 【商户平台(CMC)】门店拨入单模块
- 【商户平台(CMC)】门店拨出单模块
- 【商户平台(CMC)】桌台模块
- 【商户平台(CMC)】桌台区域模块
- 【商户平台(CMC)】桌台流水记录模块
- 【商户平台(CMC)】收银终端模块
- 【商户平台(CMC)】收银终端记录模块
- 【门店收银(POS)】餐道退单模块
- 【门店收银(POS)】POS备注模块
- 【商户平台(CMC)】门店收银搭售模块
- 【商户平台(CMC)】门店收银满减
- 【商户平台(CMC)】门店收银限时折扣活动模块
- 【商户平台(CMC)】门店报工计划模块
- 【商户平台(CMC)】销售退单(零售)支付记录模块
- 【商户平台(CMC)】销售订单(零售)模块
- 【商户平台(CMC)】销售订单(零售)账单模块
- 【商户平台(CMC)】销售退单(零售)模块
- 【商户平台(CMC)】销售订单(零售)支付记录模块
- 【商户平台(CMC)】班次模块
- 【商户平台(CMC)】门店班次模块
- 【商户平台(CMC)】银联云MIS配置模块
- 收银终端
- 会员
- 【门店收银(POS)】会员储值退模块
- 【门店收银(POS)】会员储值活动模块
- 【门店收银(POS)】会员储值模块
- 【门店收银(POS)】会员储值退单支付记录模块
- 【门店收银(POS)】会员储值单支付记录模块
- 【门店收银(POS)】会员积分流水记录模块
- 【门店收银(POS)】积分菜单模块
- 【门店收银(POS)】积分兑换订单支付记录模块
- 【门店收银(POS)】积分兑换订模块
- 【门店收银(POS)】会员等级方案
- 【门店收银(POS)】会员钱包流水记录模块
- 【门店收银(POS)】会员模块
- 【门店收银(POS)】优惠券流水记录模块
- 【门店收银(POS)】会员优惠券模块
- 【门店收银(POS)】礼品卡流水记录模块
- 【门店收银(POS)】礼品卡模块
- 【门店收银(POS)】优惠券查询模块
- 【门店收银(POS)】优惠券模块
- 供应链
- 【门店收银(POS)】门店拨出模块
- 【门店收银(POS)】门店拨入单模块
- 【门店收银(POS)】门店其他出入库原因模块
- 【门店收银(POS)】门店其他出入库模块
- 【门店收银(POS)】门店库存记录模块
- 【门店收银(POS)】门店每日库存记录模块
- 【门店收银(POS)】门店库存模块
- 【门店收银(POS)】门店盘点单模块
- 【门店收银(POS)】商家商品模块
- 【门店收银(POS)】品类模块
- 【门店收银(POS)】门店加工清单模块
- 【门店收银(POS)】门店报工单模块
- 【门店收银(POS)】门店报工计划模块
- 【门店收银(POS)】门店补货清单模块
- 【门店收银(POS)】补货订单模块
- 【门店收银(POS)】拣货出库单模块
- 【门店收银(POS)】门店收货单模块
- 【门店收银(POS)】门店退货单模块
- 【门店收银(POS)】销售订单模块
- 【门店收银(POS)】门店额度模块
- 【门店收银(POS)】门店额度明细记录模块
- 【门店收银(POS)】补货订单(门店额度管理)模块
- 【门店收银(POS)】门店退货单(门店额度管理)模块
- 商城
- 零售
- 设置
- 查询
- 【门店收银(POS)】礼品卡模块
- 会员
- 商城小程序
- 设置
- 会员
- 【小程序(MP)】会员线上储值活动模块
- 【小程序(MP)】会员储值模块
- 【小程序(MP)】会员积分流水记录模块
- 【小程序(MP)】会员优惠专场模块
- 【小程序(MP)】会员钱包流水记录模块
- 【小程序(MP)】会员地址模块
- 【小程序(MP)】会员模块
- 【小程序(MP)】积分菜单模块
- 【小程序(MP)】商城小程序积分抽奖记录模块
- 【小程序(MP)】积分抽奖模块
- 【小程序(MP)】积分兑换订单模块
- 【小程序(MP)】会员签到有礼模块
- 【小程序(MP)】会员签到记录模块
- 【小程序(MP)】会员邀请记录模块
- 【小程序(MP)】会员接收邀请记录模块
- 【小程序(MP)】会员礼品卡模块
- 【小程序(MP)】优惠券流水记录模块
- 【小程序(MP)】会员优惠券模块
- 【小程序(MP)】优惠券模块
- 【小程序(MP)】礼品卡流水记录模块
- 【小程序(MP)】礼品卡退单模块
- 【小程序(MP)】礼品卡订单模块
- 【小程序(MP)】礼品卡模块
- 【小程序(MP)】会员协议模块
- 【小程序(MP)】礼品卡储值模块
- 【小程序(MP)】会员亲情卡模块
- 销售
- 餐道
- MES
- 教育
- 【商户平台(CMC)】活动模块
- 【商户平台(CMC)】活动邀请记录模块
- 【商户平台(CMC)】活动报名记录模块
- 【商户平台(CMC)】教学点模块
- 【商户平台(CMC)】教练模块
- 【商户平台(CMC)】课程模块
- 【商户平台(CMC)】精彩课程模块
- 【商户平台(CMC)】课程分类模块
- 【商户平台(CMC)】课程作业模块
- 【商户平台(CMC)】课程包模块
- 【商户平台(CMC)】预约记录模块
- 【商户平台(CMC)】课程回顾模块
- 【商户平台(CMC)】课表模块
- 【商户平台(CMC)】课程打分模块
- 【商户平台(CMC)】小程序设置模块
- 【商户平台(CMC)】学校年级模块
- 【商户平台(CMC)】学员积分兑换商品模块
- 【商户平台(CMC)】学员课程打分规则模块
- 【商户平台(CMC)】学员模块
- 【商户平台(CMC)】学员课程包模块
- 【商户平台(CMC)】学员课程包购买记录模块
- 【商户平台(CMC)】学员积分兑换订单模块
- 【商户平台(CMC)】篮球营学员分数流水记录模块
- 【商户平台(CMC)】商城满减送同步任务模块
- 【商户平台(CMC)】商城限时折扣同步任务模块
- 【商户平台(CMC)】POS搭售同步任务模块
- 【商户平台(CMC)】POS满减送同步任务模块
- 【商户平台(CMC)】POS限时折扣同步任务模块
- 加盟商管理
- 扫码点餐
- 【商户平台(CMC)】自助售卖机订单模块
- 【商户平台(CMC)】认证店申请模块
- 【开放平台(OPEN)】认证店申请模块
- 数据
- 开放平台
- 加盟商平台
- 【加盟商平台(FCM)】登录模块
- 【加盟商平台(FCM)】素材中心模块
- 【加盟商平台(FCM)】商品属性库模块
- 【加盟商平台(FCM)】商家角色模块
- 【加盟商平台(FCM)】加盟商模块
- 【加盟商平台(FCM)】加盟商申请模块
- 【加盟商平台(FCM)】门店申请模块
- 【加盟商平台(FCM)】门店模块
- 【加盟商平台(FCM)】素材分组模块
- 【加盟商平台(FCM)】商家类目模块
- 【加盟商平台(FCM)】商城满减
- 【加盟商平台(FCM)】商城满减送同步任务模块
- 【加盟商平台(FCM)】商城限时折扣活动模块
- 【加盟商平台(FCM)】商城限时折扣同步任务模块
- 【加盟商平台(FCM)】商城门店满减送活动模块
- 【加盟商平台(FCM)】商城门店限时折扣活动模块
- 【加盟商平台(FCM)】POS外屏广告模块
- 【加盟商平台(FCM)】POS搭售模块
- 【加盟商平台(FCM)】POS搭售同步任务模块
- 【加盟商平台(FCM)】POS满减送模块
- 【加盟商平台(FCM)】POS满减送同步任务模块
- 【加盟商平台(FCM)】POS限时折扣活动模块
- 【加盟商平台(FCM)】POS限时折扣同步任务模块
- 【加盟商平台(FCM)】POS菜单模版模块
- 【加盟商平台(FCM)】支付菜单模版模块
- 【加盟商平台(FCM)】门店档口模块
- 【加盟商平台(FCM)】门店收银应用版本模块
- 【加盟商平台(FCM)】门店收银搭售模块
- 【加盟商平台(FCM)】门店收银满减送模块
- 【加盟商平台(FCM)】门店盘点单模块
- 【加盟商平台(FCM)】门店盘点任务模块
- 【加盟商平台(FCM)】门店库存模块
- 【加盟商平台(FCM)】门店每日库存记录模块
- 【加盟商平台(FCM)】门店库存记录模块
- 【加盟商平台(FCM)】门店收银限时折扣活动模块
- 【加盟商平台(FCM)】门店其他出入库模块
- 【加盟商平台(FCM)】门店其他出入库原因模块
- 【加盟商平台(FCM)】门店打印机模块
- 【加盟商平台(FCM)】门店拨入单模块
- 【加盟商平台(FCM)】门店拨出单模块
- 【加盟商平台(FCM)】收银终端模块
- 【加盟商平台(FCM)】商家商品模块
- 【加盟商平台(FCM)】菜单同步任务模块
- 【加盟商平台(FCM)】菜单模版模块
- 【加盟商平台(FCM)】商城销售退单模块
- 【加盟商平台(FCM)】商城订单模块
- 【加盟商平台(FCM)】门店菜单分组模块
- 【加盟商平台(FCM)】门店POS菜单分组模块
- 【加盟商平台(FCM)】POS菜单同步任务模块
- 【加盟商平台(FCM)】POS销售订单(零售)模块
- 【加盟商平台(FCM)】POS零售订单退单模块
- 【加盟商平台(FCM)】POS商品模块
- 【加盟商平台(FCM)】门店收银员模块
- 【加盟商平台(FCM)】收银员角色模块
- 【加盟商平台(FCM)】商家部门模块
- 【加盟商平台(FCM)】商家员工模块
- 【加盟商平台(FCM)】优惠券统计模块
- 【加盟商平台(FCM)】会员储值统计模块
- 【加盟商平台(FCM)】统计查询
- 【加盟商平台(FCM)】概览查询
- 【加盟商平台(FCM)】校园卡模块
- 【加盟商平台(FCM)】校园卡明细模块
- 【加盟商平台(FCM)】校园卡操作记录模块
- 【加盟商平台(FCM)】自助售卖机订单模块
- 【加盟商平台(FCM)】认证店登录模块
- 【加盟商平台(FCM)】门店服务开通记录模块
- 篮球营小程序
- 【小程序(MP)】活动模块
- 【小程序(MP)】活动邀请记录模块
- 【小程序(MP)】活动报名记录模块
- 【小程序(MP)】教学点模块
- 【小程序(MP)】课程模块
- 【小程序(MP)】精彩课程模块
- 【小程序(MP)】课程分类模块
- 【小程序(MP)】课程作业模块
- 【小程序(MP)】课程包模块
- 【小程序(MP)】预约记录模块
- 【小程序(MP)】课程回顾模块
- 【小程序(MP)】课表模块
- 【小程序(MP)】课程打分模块
- 【小程序(MP)】小程序设置模块
- 【小程序(MP)】学员积分兑换商品模块
- 【小程序(MP)】学员模块
- 【小程序(MP)】学员课程包模块
- 【小程序(MP)】学员课程包购买记录模块
- 【小程序(MP)】学员积分兑换订单模块
- 【小程序(MP)】篮球营学员分数流水记录模块
- 【商户平台(CMC)】门店报工单模块
- 【商户平台(CMC)】门店其他出入库模块
- 【商户平台(CMC)】门店拨出单模块
- 【商户平台(CMC)】补货订单模块
- 【商户平台(CMC)】门店收货单模块
- 【商户平台(CMC)】门店退货单模块
- 【商户平台(CMC)】仓库盘点单模块
- 【商户平台(CMC)】仓库其他出入库模块
- 【商户平台(CMC)】仓库拨入单模块
- 【商户平台(CMC)】仓库拨出单模块
- 【商户平台(CMC)】门店盘点单模块
- 【商户平台(CMC)】门店拨入单模块
- 【商户平台(CMC)】静安商城订单模块
- 【商户平台(CMC)】静安商城订单账单模块
- 【商户平台(CMC)】静安商城订单支付记录模块
- 【加盟商平台(FCM)】静安商城订单模块
- 【小程序(MP)】静安商城订单(商城)模块
- 【小程序(MP)】静安商城订单(外卖)模块
新建优惠券
POST
/cmc/esCoupon/add
【商户平台(CMC)】优惠券模块
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Query 参数
clientId
string
clientId
userId
string
userId
Header 参数
Authorization
string
必需
Body 参数application/json
新建优惠券数据
active_days
integer <int32>
领取后X天生效
auto_number
boolean
自动生成券号
category_exclude
array[string]
不参加类目
category_include
array[string]
参加类目
channels
array[string]
可使用渠道
client_id
string
商户Id
coupon_value
number <double>
可选
cover
string
封面
deduct_delivery_fee
boolean
可抵扣运费
desc
string
说明
disc_amt_limited
number <double>
优惠金额上限
disc_qty_limited
number <double>
折扣商品限定数量
end_time_type
enum<string>
到期类型
枚举值:
DAYSYEARASSIGN_DAYNONE
exchange_group_select_type
enum<string>
兑换分组选择方式
枚举值:
ANDOR
exchange_groups
array[object (CrmCouponExchangeGroupInfoVO) {5}]
兑换分组
exchange_group_id
string
兑换分组ID
exchange_group_items
array[object (CrmCouponExchangeGroupItemInfoVO) {3}]
分组内容
exchange_group_name
string
兑换分组名称
exchange_times
integer <int32>
可兑换次数
select_type
enum<string>
选择方式
枚举值:
ANDOR
get_times_limited
integer <int32>
每人领取次数
get_times_limited_type
enum<string>
领取周期
枚举值:
DAYWEEKMONTHNONE
gift
boolean
可转赠
member_grades
array[string]
限定会员等级
member_tags
array[string]
限定会员标签
memo
string
备注
name
string
优惠券名称
no_exclude
array[object (CrmNoExcludeVO) {2}]
券号规则
nos
array[integer <int32>]
排除数字
type
enum<string>
排除类型
枚举值:
ANYLAST
pattern
array[object (CrmPatternVO) {2}]
券号规则
prefix
string
固定前缀
seq_digit
integer <int32>
流水号的位数
pattern_type
enum<string>
券号规则类型
枚举值:
STYLECUSTOMER
pay_exclude_balance
boolean
可选
pay_exclude_card
boolean
可选
pay_exclude_online
boolean
不允许使用微信支付
pay_exclude_physical_card
boolean
可选
payment_exclude
array[string]
不可用支付方式
payment_include
array[string]
可用支付方式
physical
boolean
实体券
price
number <double>
售价
redeem_code
boolean
启用兑换码
sales_store_exclude
array[string]
不可销售门店范围
sales_store_include
array[string]
可销售门店范围
self_get
boolean
在领券中心中显示
show_name
string
展示名称
sku_exclude
array[string]
不参加商品
sku_include
array[string]
参加商品
start_time_type
enum<string>
生效类型
枚举值:
SAME_DAYNEXT_DAYOTHER_DAYASSIGN_DAYNONE
store_exclude
array[string]
不参加门店范围
store_include
array[string]
参加门店范围
store_type
enum<string>
参加门店范围类型
枚举值:
STORE
threshold_type
enum<string>
使用门槛类型
枚举值:
AMTQTY
threshold_value
number <double>
使用门槛
total_qty
integer <int32>
限定会员等级
turnover
boolean
计入营业额
type
enum<string>
类型
枚举值:
BLANKVOUCHERAMTDISCEXCHANGEPOSTAGE
use_days
integer <int32>
生效后Y天内有效
use_end_time
string <date-time>
可选
use_multi
boolean
限定会员等级
use_periods
array[object (CrmCouponUsePeriodVO) {2}]
可使用时间段
end_time
string <date-time>
截止时间(时分秒)
start_time
string <date-time>
起始时间(时分秒)
use_start_time
string <date-time>
可选
use_std_price
boolean
限定会员等级
use_weeks
array[integer <int32>]
可使用星期
user_id
string
用户Id
示例
{
"active_days": 0,
"auto_number": true,
"category_exclude": [
"string"
],
"category_include": [
"string"
],
"channels": [
"string"
],
"client_id": "string",
"coupon_value": 0,
"cover": "string",
"deduct_delivery_fee": true,
"desc": "string",
"disc_amt_limited": 0,
"disc_qty_limited": 0,
"end_time_type": "DAYS",
"exchange_group_select_type": "AND",
"exchange_groups": [
{
"exchange_group_id": "string",
"exchange_group_items": [
{
"exchange_sku_id": "string",
"exchange_sku_type": "SKU",
"qty": 0
}
],
"exchange_group_name": "string",
"exchange_times": 0,
"select_type": "AND"
}
],
"get_times_limited": 0,
"get_times_limited_type": "DAY",
"gift": true,
"member_grades": [
"string"
],
"member_tags": [
"string"
],
"memo": "string",
"name": "string",
"no_exclude": [
{
"nos": [
0
],
"type": "ANY"
}
],
"pattern": [
{
"prefix": "string",
"seq_digit": 0
}
],
"pattern_type": "STYLE",
"pay_exclude_balance": true,
"pay_exclude_card": true,
"pay_exclude_online": true,
"pay_exclude_physical_card": true,
"payment_exclude": [
"string"
],
"payment_include": [
"string"
],
"physical": true,
"price": 0,
"redeem_code": true,
"sales_store_exclude": [
"string"
],
"sales_store_include": [
"string"
],
"self_get": true,
"show_name": "string",
"sku_exclude": [
"string"
],
"sku_include": [
"string"
],
"start_time_type": "SAME_DAY",
"store_exclude": [
"string"
],
"store_include": [
"string"
],
"store_type": "STORE",
"threshold_type": "AMT",
"threshold_value": 0,
"total_qty": 0,
"turnover": true,
"type": "BLANK",
"use_days": 0,
"use_end_time": "2019-08-24T14:15:22Z",
"use_multi": true,
"use_periods": [
{
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z"
}
],
"use_start_time": "2019-08-24T14:15:22Z",
"use_std_price": true,
"use_weeks": [
0
],
"user_id": "string"
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/cmc/esCoupon/add?clientId=&userId=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"active_days": 0,
"auto_number": true,
"category_exclude": [
"string"
],
"category_include": [
"string"
],
"channels": [
"string"
],
"client_id": "string",
"coupon_value": 0,
"cover": "string",
"deduct_delivery_fee": true,
"desc": "string",
"disc_amt_limited": 0,
"disc_qty_limited": 0,
"end_time_type": "DAYS",
"exchange_group_select_type": "AND",
"exchange_groups": [
{
"exchange_group_id": "string",
"exchange_group_items": [
{
"exchange_sku_id": "string",
"exchange_sku_type": "SKU",
"qty": 0
}
],
"exchange_group_name": "string",
"exchange_times": 0,
"select_type": "AND"
}
],
"get_times_limited": 0,
"get_times_limited_type": "DAY",
"gift": true,
"member_grades": [
"string"
],
"member_tags": [
"string"
],
"memo": "string",
"name": "string",
"no_exclude": [
{
"nos": [
0
],
"type": "ANY"
}
],
"pattern": [
{
"prefix": "string",
"seq_digit": 0
}
],
"pattern_type": "STYLE",
"pay_exclude_balance": true,
"pay_exclude_card": true,
"pay_exclude_online": true,
"pay_exclude_physical_card": true,
"payment_exclude": [
"string"
],
"payment_include": [
"string"
],
"physical": true,
"price": 0,
"redeem_code": true,
"sales_store_exclude": [
"string"
],
"sales_store_include": [
"string"
],
"self_get": true,
"show_name": "string",
"sku_exclude": [
"string"
],
"sku_include": [
"string"
],
"start_time_type": "SAME_DAY",
"store_exclude": [
"string"
],
"store_include": [
"string"
],
"store_type": "STORE",
"threshold_type": "AMT",
"threshold_value": 0,
"total_qty": 0,
"turnover": true,
"type": "BLANK",
"use_days": 0,
"use_end_time": "2019-08-24T14:15:22Z",
"use_multi": true,
"use_periods": [
{
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z"
}
],
"use_start_time": "2019-08-24T14:15:22Z",
"use_std_price": true,
"use_weeks": [
0
],
"user_id": "string"
}'
返回响应
🟢200OK
application/json
Body
code
string
可选
data
object (CrmCouponVO)
优惠券数据
active_days
integer <int32>
领取后X天生效
auto_number
boolean
自动生成券号
category_exclude
array[object (CrmCouponCatSkuVO) {12}]
不参加类目
category_include
array[object (CrmCouponCatSkuVO) {12}]
参加类目
channels
array[string]
可使用渠道
client_id
string
商户
close_qty
integer <int32>
注销数量
coupon_value
number <double>
可选
cover
string
封面
cover_url
string
封面链接
create_time
string <date-time>
创建时间
creator
string
创建人Id
creator_name
string
创建人姓名
deduct_delivery_fee
boolean
可抵扣运费
desc
string
说明
disc_amt_limited
number <double>
优惠金额上限
disc_qty_limited
number <double>
折扣商品限定数量
edit_time
string <date-time>
最后修改时间
editer
string
修改人Id
editer_name
string
修改人姓名
end_time_type
enum<string>
到期类型
枚举值:
DAYSYEARASSIGN_DAYNONE
exchange_group_select_type
enum<string>
兑换分组选择方式
枚举值:
ANDOR
exchange_groups
array[object (CrmCouponExchangeGroupVO) {5}]
兑换分组
get_times_limited
integer <int32>
每人领取次数
get_times_limited_type
enum<string>
领取周期
枚举值:
DAYWEEKMONTHNONE
gift
boolean
可转赠
gift_qty
integer <int32>
赠送数量
id
string
Id
in_stock_qty
integer <int32>
入库数量
lock_qty
integer <int32>
冻结数量
member_grades
array[object (CrmCouponMemberGradeVO) {2}]
限定会员等级
member_tags
array[object (CrmCouponTagVO) {2}]
限定会员标签
memo
string
备注
name
string
优惠券名称
no_exclude
array[object (CrmNoExcludeVO) {2}]
券号规则
pattern
array[object (CrmPatternVO) {2}]
券号规则
pattern_type
enum<string>
券号规则类型
枚举值:
STYLECUSTOMER
pay_exclude_balance
boolean
可选
pay_exclude_card
boolean
可选
pay_exclude_online
boolean
不允许使用微信支付
pay_exclude_physical_card
boolean
可选
payment_exclude
array[object (PosPaymentInfoVO) {3}]
不可用支付方式
payment_include
array[object (PosPaymentInfoVO) {3}]
可用支付方式
physical
boolean
实体券
price
number <double>
售价
redeem_code
boolean
启用兑换码
register_qty
integer <int32>
登记数量
sale_qty
integer <int32>
发售数量
sales_store_exclude
array[object (CrmCouponStoreVO) {2}]
不可销售门店范围
sales_store_include
array[object (CrmCouponStoreVO) {2}]
可销售门店范围
self_get
boolean
在领券中心中显示
show_name
string
展示名称
sku_exclude
array[object (CrmCouponCatSkuVO) {12}]
不参加商品
sku_include
array[object (CrmCouponCatSkuVO) {12}]
参加商品
sku_type
enum<string>
参加范围类型
枚举值:
SKUCOMBOCATCOUPON
start_time_type
enum<string>
生效类型
枚举值:
SAME_DAYNEXT_DAYOTHER_DAYASSIGN_DAYNONE
state
enum<string>
状态
枚举值:
OPENACTIVEINACTIVE
store_exclude
array[object (CrmCouponStoreVO) {2}]
不参加门店范围
store_include
array[object (CrmCouponStoreVO) {2}]
参加门店范围
store_type
enum<string>
参加门店范围类型
枚举值:
STORE
threshold_type
enum<string>
使用门槛类型
枚举值:
AMTQTY
threshold_value
number <double>
使用门槛
total_qty
integer <int32>
限定会员等级
turnover
boolean
计入营业额
type
enum<string>
类型
枚举值:
BLANKVOUCHERAMTDISCEXCHANGEPOSTAGE
use_days
integer <int32>
生效后Y天内有效
use_end_time
string <date-time>
可选
use_multi
boolean
限定会员等级
use_periods
array[object (CrmCouponUsePeriodVO) {2}]
可使用时间段
use_qty
integer <int32>
使用数量
use_start_time
string <date-time>
可选
use_std_price
boolean
限定会员等级
use_weeks
array[integer <int32>]
可使用星期
void_qty
integer <int32>
作废数量
message
string
可选
示例
{
"code": "string",
"data": {
"active_days": 0,
"auto_number": true,
"category_exclude": [
{
"barcode": "string",
"icon_url": "string",
"merchandise_category_id": "string",
"merchandise_category_name": "string",
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"sku_id": "string",
"sku_name": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"category_include": [
{
"barcode": "string",
"icon_url": "string",
"merchandise_category_id": "string",
"merchandise_category_name": "string",
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"sku_id": "string",
"sku_name": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"channels": [
"string"
],
"client_id": "string",
"close_qty": 0,
"coupon_value": 0,
"cover": "string",
"cover_url": "string",
"create_time": "2019-08-24T14:15:22Z",
"creator": "string",
"creator_name": "string",
"deduct_delivery_fee": true,
"desc": "string",
"disc_amt_limited": 0,
"disc_qty_limited": 0,
"edit_time": "2019-08-24T14:15:22Z",
"editer": "string",
"editer_name": "string",
"end_time_type": "DAYS",
"exchange_group_select_type": "AND",
"exchange_groups": [
{
"exchange_group_id": "string",
"exchange_group_items": [
{
"barcode": "string",
"categroy_skus": [
{
"barcode": "string",
"client_merchandise_id": "string",
"client_sku_id": "string",
"exchange_combo_items": [
{
"group": "string",
"group_qty": 0,
"items": [
{
"barcode": "string",
"client_merchandise_id": "string",
"client_sku_id": "string",
"markup": 0,
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"min_price": 0,
"price": 0,
"props": [
{
"multi_select": true,
"name": "string",
"obligatory": true,
"prop_id": "string",
"prop_seq": 0,
"values": [
null
]
}
],
"qty": 0,
"scm_material_id": "string",
"scm_sku_id": "string",
"seq": 0,
"sku_id": "string",
"sku_name": "string",
"specs": [
{
"name": "string",
"seq": 0,
"spec_id": "string",
"spec_value_id": "string",
"value": "string",
"value_img": "string",
"value_img_url": "string"
}
],
"thumbnail": "string",
"thumbnail_url": "string",
"unit": "string",
"warranty_period": 0,
"weight": 0
}
],
"required": true,
"seq": 0
}
],
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"price_std": 0,
"props": [
{
"multi_select": true,
"name": "string",
"obligatory": true,
"prop_id": "string",
"prop_seq": 0,
"values": [
{
"name": "string",
"option_id": "string",
"price": 0,
"seq": 0
}
]
}
],
"qty": 0,
"sku_id": "string",
"sku_name": "string",
"specs": [
{
"name": "string",
"seq": 0,
"spec_id": "string",
"spec_value_id": "string",
"value": "string",
"value_img": "string",
"value_img_url": "string"
}
],
"thumbnail": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"client_merchandise_id": "string",
"client_sku_id": "string",
"combo_items": [
{
"group": "string",
"group_qty": 0,
"items": [
{
"barcode": "string",
"markup": 0,
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"qty": 0,
"seq": 0,
"sku_id": "string",
"sku_name": "string",
"unit": "string"
}
],
"required": true,
"seq": 0
}
],
"coupon_id": "string",
"coupon_name": "string",
"coupon_show_name": "string",
"coupon_type": "string",
"coupon_value": 0,
"exchange_combo_items": [
{
"group": "string",
"group_qty": 0,
"items": [
{
"barcode": "string",
"client_merchandise_id": "string",
"client_sku_id": "string",
"markup": 0,
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"min_price": 0,
"price": 0,
"props": [
{
"multi_select": true,
"name": "string",
"obligatory": true,
"prop_id": "string",
"prop_seq": 0,
"values": [
{
"name": "string",
"option_id": "string",
"price": 0,
"seq": 0
}
]
}
],
"qty": 0,
"scm_material_id": "string",
"scm_sku_id": "string",
"seq": 0,
"sku_id": "string",
"sku_name": "string",
"specs": [
{
"name": "string",
"seq": 0,
"spec_id": "string",
"spec_value_id": "string",
"value": "string",
"value_img": "string",
"value_img_url": "string"
}
],
"thumbnail": "string",
"thumbnail_url": "string",
"unit": "string",
"warranty_period": 0,
"weight": 0
}
],
"required": true,
"seq": 0
}
],
"exchange_sku_id": "string",
"exchange_sku_type": "SKU",
"icon_url": "string",
"merchandise_category_id": "string",
"merchandise_category_name": "string",
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"props": [
{
"multi_select": true,
"name": "string",
"obligatory": true,
"prop_id": "string",
"prop_seq": 0,
"values": [
{
"name": "string",
"option_id": "string",
"price": 0,
"seq": 0
}
]
}
],
"qty": 0,
"sku_id": "string",
"sku_name": "string",
"specs": [
{
"name": "string",
"seq": 0,
"spec_id": "string",
"spec_value_id": "string",
"value": "string",
"value_img": "string",
"value_img_url": "string"
}
],
"thumbnail": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"exchange_group_name": "string",
"exchange_times": 0,
"select_type": "AND"
}
],
"get_times_limited": 0,
"get_times_limited_type": "DAY",
"gift": true,
"gift_qty": 0,
"id": "string",
"in_stock_qty": 0,
"lock_qty": 0,
"member_grades": [
{
"grade_id": "string",
"grade_name": "string"
}
],
"member_tags": [
{
"member_tag_id": "string",
"member_tag_name": "string"
}
],
"memo": "string",
"name": "string",
"no_exclude": [
{
"nos": [
0
],
"type": "ANY"
}
],
"pattern": [
{
"prefix": "string",
"seq_digit": 0
}
],
"pattern_type": "STYLE",
"pay_exclude_balance": true,
"pay_exclude_card": true,
"pay_exclude_online": true,
"pay_exclude_physical_card": true,
"payment_exclude": [
{
"id": "string",
"name": "string",
"type": "CASH"
}
],
"payment_include": [
{
"id": "string",
"name": "string",
"type": "CASH"
}
],
"physical": true,
"price": 0,
"redeem_code": true,
"register_qty": 0,
"sale_qty": 0,
"sales_store_exclude": [
{
"store_id": "string",
"store_name": "string"
}
],
"sales_store_include": [
{
"store_id": "string",
"store_name": "string"
}
],
"self_get": true,
"show_name": "string",
"sku_exclude": [
{
"barcode": "string",
"icon_url": "string",
"merchandise_category_id": "string",
"merchandise_category_name": "string",
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"sku_id": "string",
"sku_name": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"sku_include": [
{
"barcode": "string",
"icon_url": "string",
"merchandise_category_id": "string",
"merchandise_category_name": "string",
"merchandise_code": "string",
"merchandise_id": "string",
"merchandise_name": "string",
"price": 0,
"sku_id": "string",
"sku_name": "string",
"thumbnail_url": "string",
"unit": "string"
}
],
"sku_type": "SKU",
"start_time_type": "SAME_DAY",
"state": "OPEN",
"store_exclude": [
{
"store_id": "string",
"store_name": "string"
}
],
"store_include": [
{
"store_id": "string",
"store_name": "string"
}
],
"store_type": "STORE",
"threshold_type": "AMT",
"threshold_value": 0,
"total_qty": 0,
"turnover": true,
"type": "BLANK",
"use_days": 0,
"use_end_time": "2019-08-24T14:15:22Z",
"use_multi": true,
"use_periods": [
{
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z"
}
],
"use_qty": 0,
"use_start_time": "2019-08-24T14:15:22Z",
"use_std_price": true,
"use_weeks": [
0
],
"void_qty": 0
},
"message": "string"
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
修改于 2025-02-12 07:17:07