CFT-周大福
  1. 权益场景
CFT-周大福
在线API
  • 在线API
  • 接口鉴权说明
  • 接口说明
  • 会员场景
    • 会员绑定
      POST
    • 国家代码查询
      POST
    • 手机号修改
      POST
    • 会员修改
      POST
    • 会员卡号查询Global ID
      POST
    • 会员注册
      POST
    • 会员解绑
      POST
    • 会员查询
      POST
    • 会员扩展数据辅助表查询
      POST
    • 会员注销
      POST
    • 会员查询绑定
      POST
    • 会员查询(批量分页)
      POST
    • 会员跨境
      POST
    • 会员沟通渠道
      POST
  • 等级场景
    • 查询等级配置列表
    • 等级查询
    • 明细查询
  • mdm场景
    • 组织结构同步
    • 商品同步
    • 门店列表
    • 门店同步
  • 积分场景
    • 积分膨胀
      • 门店是否满足积分膨胀活动
      • 积分膨胀
      • 积分膨胀-取消
      • 积分膨胀资格扣分
      • 积分膨胀资格扣分-取消
    • 互动类活动
      • 互动类活动加分
      • 互动类活动扣分
      • 取消互动类活动加分
      • 取消互动类活动扣分
    • 积分抵现
      • 积分抵现
      • 取消 - 积分抵现
    • 积分券抵现
      • 积分券抵现
      • 取消 - 积分券抵现
      • 积分券加赠券派分
      • 取消-积分券加赠券派分
    • 积分兑礼
      • 积分兑礼
      • 取消 - 积分兑礼
    • 其他积分操作
      • 积分冻结
      • 积分解冻
      • 积分交易撤销
      • 消耗已冻结积分
      • 拆分积分分批冻结
    • 积分查询
      • 积分查询
      • 积分比例查询
      • 积分有效期明细
    • 积分变更接口
    • 明细查询
  • 标签场景
    • 标签目录列表
    • 标签列表
    • 打标
    • 去标
    • 用户标签列表
    • 分组下用户标签列表
    • 标签导入通知
  • 销售场景
    • 退单同步
    • 订单同步
    • 订单查询
    • 查询销售单会员
    • 查询会员消费件数
    • 线上订单(60580)通知计算积分
    • 订单换渠道ID
  • 权益场景
    • 自研礼券
      • 自研礼券项目同步Loyalty
      • 自研礼券 实例同步Loyalty
    • 权益礼品同步
      POST
    • 权益礼品详情查询
      POST
    • 核销
      POST
    • 优惠券列表
      POST
    • 已领取礼品列表查询
      POST
    • 会员可用券列表
      POST
    • 积分商城订单同步
      POST
    • 反核销
      POST
    • 券查询
      POST
    • 卡券发放
      POST
    • 券项目查询
      POST
    • 券项目列表
      POST
  • 活动场景
    • 微信报名活动
      • 微信活动详情
      • 微信活动报名
      • 微信活动签到
      • 根据memberId分页查询微信活动参与记录列表
      • 分页查询微信活动列表
    • 积分券活动
      • 积分券活动查询
    • 邀请有礼活动
      • 分页查询邀请有礼活动列表
      • 邀请有礼活动-绑定会员邀请申请码
      • 邀请有礼活动-详情
      • 邀请有礼活动资格验证
    • 互动类积分活动详情和参与记录
  • 企点
    • 积分变更接口
    • 券项目列表
    • 卡券批量发放
    • 标签导入通知
  1. 权益场景

券项目查询

POST
/fast-service/v1/0.0/api/coupon/project/get
卡券场景
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-vpjq75s2e4.kylin.shuyun.com/fast-service/v1/0.0/api/coupon/project/get' \
--header 'Authorization;' \
--header 'X-Caller-Service: ' \
--header 'X-Caller-sign: ' \
--header 'X-Caller-Timestamp: ' \
--header 'X-Caller-Sign: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bizCode": "CTFCN",
    "requestChannel": "WX",
    "requestSystem": "WX",
    "transactionId": "TX2024030490569",
    "projectId": "deu2hznf",
    "useCache": true
}'
响应示例响应示例
{
  "success": true,
  "code": "000000",
  "message": "成功",
  "data": {
    "includeShops": null,
    "excludeShops": null,
    "includeGoods": null,
    "excludeGoods": null,
    "id": "deu2hznf",
    "branch": "deu2hznf",
    "title": "王乾测试资格券-注册好礼",
    "kind": "",
    "campaignTitle": "王乾测试资格券",
    "description": null,
    "status": "RELEASED",
    "restrict": null,
    "grantRestrict": {
      "startAt": "2025-01-01 16:03:29",
      "endAt": "2025-03-01 16:03:34",
      "platformsRef": null,
      "invokeNum": null,
      "invokeNumByUserPerDay": null,
      "invokeNumByPerDay": null
    },
    "useRestrict": {
      "shopsRefType": null,
      "shopsRef": null,
      "platformsRef": null,
      "goodsRefType": null,
      "goodsRef": null,
      "startAt": "2025-01-01 16:03:49",
      "endAt": "2025-03-01 16:03:56",
      "invokeNumByUserPerDay": null,
      "wait": null,
      "timeType": "FIXED_TIME",
      "timeCycle": null
    },
    "cancelUseRestrict": {
      "invokeNum": 1,
      "invokeNumByUserPerDay": null,
      "startAt": "2025-01-01 16:04:00",
      "endAt": "2025-03-01 16:04:06"
    },
    "updateAt": "2025-01-09 10:13:05",
    "maxQuantity": 100,
    "useCountRestrict": 1,
    "transferable": null,
    "type": "RegisterGift",
    "discount": null,
    "exchange": {
      "goods": "5",
      "num": null,
      "maxPerGoods": null
    },
    "maxOverlayNum": null,
    "combinationEnabled": false,
    "grantedCount": 1,
    "usedCount": 1,
    "reminderBeforeExpirationEnable": true,
    "reminderBeforeExpiration": {
      "year": null,
      "quarter": null,
      "month": null,
      "week": null,
      "day": 7,
      "hour": null,
      "minute": null,
      "second": null
    },
    "effectPeriod": {
      "type": "RELATIVE_TIME",
      "fixed": null,
      "relatives": [
        {
          "scene": "activate",
          "duration": {
            "year": null,
            "quarter": null,
            "month": null,
            "week": null,
            "day": null,
            "hour": null,
            "minute": null,
            "second": 0
          },
          "toDayBegin": false,
          "toDayEnd": null,
          "fixedPart": null
        }
      ]
    },
    "expiredPeriod": {
      "type": "RELATIVE_TIME",
      "fixed": null,
      "relatives": [
        {
          "scene": "grant",
          "duration": {
            "year": null,
            "quarter": null,
            "month": 1,
            "week": null,
            "day": null,
            "hour": null,
            "minute": null,
            "second": null
          },
          "toDayBegin": null,
          "toDayEnd": false,
          "fixedPart": null
        }
      ]
    },
    "template": "deyc9o1r",
    "codeMaker": "3rwu3e",
    "effectRestrict": null,
    "expireRestrict": null,
    "previous": "snmg9cex",
    "program": "dmcirekx",
    "subOrderShareDiscount": null,
    "combinationType": "NO_OVERLAY",
    "storeDirectDistribution": null,
    "transferRestrict": null,
    "transferPeriod": null,
    "weiMob": null,
    "weChatPayCouponStocks": null,
    "couponCost": null,
    "positivePriceGoods": null,
    "payBenefit": null,
    "storeLimitNum": null,
    "orderDeductList": null,
    "materialImage": null,
    "createNow": false,
    "activateNow": false,
    "subject": "dm3dgd27",
    "benefitGrade": "Tier0",
    "fqn": "benefit.deu2hznf",
    "approveBy": null,
    "builtIn": false,
    "insertAt": "2025-01-09 10:13:05",
    "_i18nPayload": {
      "title": {
        "zh-CN": "王乾测试资格券-注册好礼"
      },
      "campaignTitle": {
        "zh-CN": "王乾测试资格券"
      },
      "description": {}
    },
    "available": true,
    "rejectAt": null,
    "annotations": {
      "exchange.goodsselectorValueText": "已选中 1 条数据"
    },
    "archiveBy": null,
    "explanation": "王乾测试资格券补充说明",
    "offlineAffectHistory": null,
    "giveAway": null,
    "templateSnapshotId": "s74m1dra",
    "codeExtOn": false,
    "ifPopup": true,
    "from": null,
    "statusOfApprove": null,
    "archiveAt": null,
    "statusOfUse": "RELEASED",
    "module": "benefit",
    "submitAt": null,
    "pictureUrl": "http://content-management.shuyun.com/ad7ac8d0-fc53-4c30-b305-fb914ca550bc.png",
    "benefitGroup": "MemberGifts",
    "extSet": "benefit.project",
    "tags": null,
    "statusOfEdit": "RELEASED",
    "domain": "benefit",
    "deleteBy": null,
    "operationType": null,
    "since": "1.0",
    "availableAnonymously": null,
    "code": "deu2hznf",
    "submitBy": null,
    "origin": "deu2hznf",
    "displayPriority": 1,
    "orgSystemCode": "0-",
    "directory": null,
    "releaseAt": "2025-01-09 10:13:05",
    "secretOn": null,
    "createAt": "2025-01-08 17:40:58",
    "updateBy": "wangqian",
    "audit": {
      "createAt": null,
      "createBy": null,
      "createById": null,
      "releaseAt": "2025-01-09 10:13:05",
      "releaseBy": "wangqian",
      "releaseById": null,
      "offlineAt": null,
      "offlineBy": null,
      "offlineById": null,
      "onlineAt": null,
      "onlineBy": null,
      "onlineById": null,
      "pauseAt": null,
      "pauseBy": null,
      "pauseById": null,
      "resumeAt": null,
      "resumeBy": null,
      "resumeById": null,
      "archiveAt": null,
      "archiveBy": null,
      "archiveById": null,
      "deleteAt": null,
      "deleteBy": null,
      "deleteById": null,
      "submitAt": null,
      "submitBy": null,
      "submitById": null,
      "approveAt": null,
      "approveBy": null,
      "approveById": null,
      "rejectAt": null,
      "rejectBy": null,
      "rejectById": null,
      "enableAt": null,
      "enableBy": null,
      "enableById": null,
      "disableAt": null,
      "disableBy": null,
      "disableById": null
    },
    "displayEndTime": "2025-03-31T08:02:29.000Z",
    "approveProcessId": null,
    "product": "deyc9o1r",
    "dataVersion": 0,
    "deleteAt": null,
    "releaseVersion": null,
    "approveAt": null,
    "displayStartTime": "2025-01-01T08:02:23.000Z",
    "releaseBy": "wangqian",
    "rejectBy": null,
    "updateById": "67",
    "target": null,
    "createBy": "wangqian",
    "benefitDesc": "王乾测试资格券权益描述\n",
    "createById": "67",
    "approveProcessInstanceId": null,
    "privilegeType": null,
    "freightDiscountType": null
  }
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Authorization
string 
必需
默认值:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJicmFuY2hfMzgxMCIsImF1ZCI6InNtYXJ0X3BvcnRhbF91YXQiLCJpc3MiOiJzc28iLCJpcF9hZGRyZXNzIjoiMTAuMjAwLjE4MC43NiIsImV4cCI6MTczOTc5ODIzMCwiYnJhbmNoIjoiMzgxMCIsImlhdCI6MTczOTc5MTAzMH0.jqwTnQ0ah3k94Yjpn7hw91QtmKwsvXhjyibZpXDrGifaBcvzPdz8MjCg66FUohyKTS4ciZILl6xXJ5a1pQ_iIg
X-Caller-Service
string 
可选
默认值:
{{caller}}
X-Caller-sign
string 
可选
默认值:
{{sign}}
X-Caller-Timestamp
string 
可选
默认值:
{{currentTime}}
X-Caller-Sign
string 
网关签名
可选
默认值:
{{sign}}
Body 参数application/json
bizCode
string 
业务代码
必需
>= 1 字符
示例值:
CTFCN
requestChannel
string 
请求渠道 POS;WECHAT:微信
必需
>= 1 字符
示例值:
WECHAT
requestSystem
string 
请求系统 POS;WECHAT_MALL:微信商城;MEMBER_CENTER:会员中心;POINTS_MALL:积分商城
必需
>= 1 字符
示例值:
WECHAT_MALL
transactionId
string 
事务ID
必需
>= 1 字符
示例值:
TX2024030490569
projectId
string 
项目id
必需
>= 1 字符
useCache
boolean 
是否从缓存读取
可选
默认值:
true
示例

返回响应

🟢200projectGet 200 response
application/json
Body
success
boolean 
是否成功:true 表示成功 false 表示失败
可选
code
string 
000000 表示成功,其余编码表示具体错误编码
可选
message
string 
可选
data
object (CouponProject) 
可选
includeShops
array[string]
核销限制:指定店铺集合-选择器数据
已废弃
excludeShops
array[string]
核销限制:排除店铺集合-选择器数据
已废弃
includeGoods
array[string]
核销限制:指定商品集合-选择器数据
必需
可兑换商品
excludeGoods
array[string]
核销限制:排除商品集合-选择器数据
已废弃
extData
object 
卡券项目扩展属性
已废弃
id
string 
项目id
可选
title
string 
项目名称
可选
kind
string 
业务类型id
已废弃
campaignTitle
string 
活动名称
可选
description
string 
描述信息
已废弃
status
enum<string> 
可选
DRAFT:草稿;RELEASING:发布中;RELEASED:已发布;OFFLINE:已下线;DELETED:已删除;ARCHIVED:已归档;SUBMITTED:审批中;APPROVED:已通过;REJECTED:已拒绝
枚举值:
DRAFTUPDATEDRELEASINGRELEASEDONLINEOFFLINEPAUSEDDELETEDARCHIVEDSUBMITTEDAPPROVEDREJECTED
restrict
object 
已废弃
grantRestrict
object 
已废弃
useRestrict
object 
已废弃
cancelUseRestrict
object 
已废弃
updateAt
string <date-time>
8时区项目记录更新时间
可选
时间格式是零时区:yyyy-MM-dd'T'HH:mm:ss'Z'
maxQuantity
integer <int64>
发放总量
可选
useCountRestrict
integer <int64>
可用次数限制
可选
transferable
boolean 
是否允许转赠
已废弃
type
object 
可选
EXCHANGE 兑换
FREE_SHIPPING 包邮
DISCOUNT 优惠
PRIVILEGE 特权
discount
object 
已废弃
exchange
object 
可选
maxOverlayNum
integer <int32>
最大叠加张数
已废弃
combinationEnabled
boolean 
可否组合使用
已废弃
grantedCount
integer <int64>
已发放数量
可选
usedCount
integer <int64>
已核销次数
可选
reminderBeforeExpirationEnable
boolean 
是否过期提醒
已废弃
reminderBeforeExpiration
object 
已废弃
effectPeriod
object 
可选
expiredPeriod
object 
可选
displayStartTime
string 
展示开始时间
必需
displayEndTime
string 
展示结束时间
必需
template
string 
模版ID
已废弃
codeMaker
string 
编码生成器ID
已废弃
effectRestrict
object 
已废弃
expireRestrict
object 
已废弃
previous
string 
父版本
已废弃
program
string 
方案
已废弃
subOrderShareDiscount
boolean 
子订单是否参与优惠分摊
已废弃
combinationType
object 
已废弃
storeDirectDistribution
boolean 
是否允许店铺直接发放
已废弃
三方平台对接字段,开启店铺领取优惠券
transferRestrict
object 
已废弃
transferPeriod
object 
已废弃
weiMob
object 
已废弃
微盟平台卡券专用字段
weChatPayCouponStocks
object 
已废弃
couponCost
object 
已废弃
positivePriceGoods
boolean 
是否仅限正价商品可用
已废弃
payBenefit
object 
已废弃
storeLimitNum
integer <int32>
单店最多发放
已废弃
orderDeductList
string 
下单可同时使用抵扣
已废弃
连接的字符串数组
materialImage
object 
已废弃
createNow
boolean 
是否发布后立即创建
已废弃
是:项目发布后立即创建卡券实例,应用于匿名券、实体券;否:支持接口发放或者人工发放,应用于人群营销发放、事件营销发放、人工发放。
activateNow
boolean 
是否创建和发放后立即启用
已废弃
是:创建和发放后立即启用;否:支持接口启用或者人工启用
subject
string 
主体ID
已废弃
benefitGroup
string 
权益分组
必需
MemberGifts 会员好礼
PointsPrivileges 积分特权
ExclusiveTreats 专属礼遇
PremiumPrivileges 尊享特权
benefitGrade
string 
会员所属等级
必需
大陆测试环境:
60090 Tier0
60091 Tier1
60092 Tier2
60093 Tier3
60094 Tier4
60095 Tier5
大陆UAT:
TIER0:60010
TIER1:60011
TIER2:60012
TIER3:60013
TIER4:60014
TIER5:60015
pictureUrl
string 
权益卡片URL
必需
benefitDesc
string 
权益描述
必需
explanation
string 
补充说明
可选
displayPriority
string 
展示优先级
必需
上一页
卡券发放
下一页
券项目列表
Built with