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/get
卡券场景
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-vpjq75s2e4.kylin.shuyun.com/fast-service/v1/0.0/api/coupon/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": "WECHAT",
    "requestSystem": "WECHAT_MALL",
    "transactionId": "TX2024030490569",
    "projectId": "string",
    "code": "string",
    "showProject": true
}'
响应示例响应示例
{
  "success": true,
  "code": "string",
  "message": "string",
  "data": {
    "id": "string",
    "projectId": "string",
    "code": "string",
    "grantAt": "2019-08-24T14:15:22Z",
    "effectiveAt": "2019-08-24T14:15:22Z",
    "useAt": "2019-08-24T14:15:22Z",
    "expiredAt": "2019-08-24T14:15:22Z",
    "status": {},
    "useCountRestrict": 0,
    "usedCount": 0,
    "ruleText": "string",
    "couponName": "string",
    "projectType": "string",
    "reductAmount": 0,
    "discountRate": 0,
    "thresholdValue": 0,
    "denomination": 0,
    "grantReason": "string",
    "grantShop": "string",
    "extension": {},
    "project": {},
    "transferState": {},
    "useShop": "string",
    "useOrderId": "string",
    "activateAt": "2019-08-24T14:15:22Z",
    "grantPlatform": "string",
    "scene": {},
    "lastState": {},
    "receiver": "string",
    "transferredCount": 0,
    "transferredCountRestrict": 0,
    "usableOrderItemIds": [
      "string"
    ],
    "memberId": "string"
  }
}

请求参数

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 字符
code
string 
券码
必需
>= 1 字符
showProject
boolean 
是否展示项目信息
可选
为false的话响应参数中没有project
示例

返回响应

🟢200get 200 response
application/json
Body
success
boolean 
是否成功:true 表示成功 false 表示失败
可选
code
string 
000000 表示成功,其余编码表示具体错误编码
可选
message
string 
可选
data
object (CouponGetResult) 
可选
id
string 
卡券实例ID
可选
projectId
string 
券项目id
可选
code
string 
券码
可选
grantAt
string <date-time>
8时区发放时间
可选
格式:yyyy-MM-dd HH:mm:ss,例如:2022-10-21 00:01:01
effectiveAt
string <date-time>
8时区生效时间
可选
格式:yyyy-MM-dd HH:mm:ss,例如:2022-10-21 00:01:01
useAt
string <date-time>
8时区核销时间
可选
格式:yyyy-MM-dd HH:mm:ss,例如:2022-10-21 00:01:01
expiredAt
string <date-time>
8时区失效时间
可选
格式:yyyy-MM-dd HH:mm:ss,例如:2022-10-21 00:01:01
status
object 
可选
CREATED:已发放,ACTIVATED:已启用,DISCARDED:已作废,EFFECTED:已生效,EXPIRED:已失效,LOCKED:已锁定,USED:已使用
useCountRestrict
integer <int64>
可用次数限制
可选
usedCount
integer <int64>
已使用次数
可选
ruleText
string 
券项目规则描述
可选
卡券项目description
couponName
string 
优惠券名称
可选
projectType
string 
优惠类型
可选
EXCHANGE:兑换券,RATIO_OFF:折扣券;AMOUNT_OFF:抵扣券
reductAmount
number 
满减金额
可选
优惠面额-指定代金效果
discountRate
number 
折扣比率
可选
优惠面额-指定折扣效果
thresholdValue
number 
门槛金额
可选
门槛值-订单最低消费金额
denomination
number 
优惠金额
可选
grantReason
string 
发放原因
可选
grantShop
string 
发放店铺
可选
extension
object 
卡券实例扩展属性
可选
project
object 
可选
transferState
object 
可选
WAITING:待领取,RECEIVED:已领取,RETURNED:已退回,CANCELLED:已取消,TIMEOUT:已超时
useShop
string 
核销店铺
可选
useOrderId
string 
订单Id
可选
activateAt
string <date-time>
8时区启用时间
可选
格式:yyyy-MM-dd HH:mm:ss,例如:2022-10-21 00:01:01
grantPlatform
string 
发放平台
可选
scene
object 
可选
具体可参考卡券TicketScene枚举
lastState
object 
可选
CREATED:已发放,ACTIVATED:已启用,DISCARDED:已作废,EFFECTED:已生效,EXPIRED:已失效,LOCKED:已锁定,USED:已使用
receiver
string 
受赠人,只有赠送状态是WAITING:待领取时,该值不为空
可选
transferredCount
integer <int32>
已赠送次数
可选
transferredCountRestrict
integer <int32>
赠送次数限制
可选
usableOrderItemIds
array[string]
实例可用的子订单ID列表-可用列表查询接口时才会返回数据
可选
请求参数中-根据子订单判断实例是否可用是true,有效的券实例才会返回可用的子订单号
memberId
string 
麒麟会员ID
可选
上一页
反核销
下一页
卡券发放
Built with