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/consume
卡券场景
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-vpjq75s2e4.kylin.shuyun.com/fast-service/v1/0.0/api/coupon/consume' \
--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",
    "identify": {
        "memberId": "string",
        "channel": "string",
        "userId": "wxd678efh567hg6787_oGPAG5rdBP78jh_3cmJ1en8FvZlo"
    },
    "coupons": [
        {
            "memberId": "string",
            "id": "string",
            "projectId": "string",
            "code": "string",
            "grantAt": "2019-08-24T14:15:22Z",
            "state": "string"
        }
    ],
    "giftCode": "string",
    "phone": "string",
    "addressee": "string",
    "address": "string",
    "shopCode": "string",
    "platformId": "string"
}'
响应示例响应示例
{
  "success": true,
  "code": "string",
  "message": "string",
  "data": {
    "orderId": "string",
    "amount": 0,
    "paymentAmount": 0,
    "discountAmount": 0,
    "items": [
      {
        "orderItemId": "string",
        "price": 0,
        "specialPrice": 0,
        "goodsId": "string",
        "num": 0,
        "amount": 0,
        "paymentAmount": 0,
        "discountAmount": 0
      }
    ],
    "status": "string",
    "couponSn": "KH78281",
    "couponPwd": "ASJIOSSHDNJJUSD",
    "couponUrl": "https://xxxx.com",
    "couponCode": "BN",
    "couponNo": "369",
    "activityId": "123",
    "tranCode": "2",
    "couponNum": "BN000000369"
  }
}

请求参数

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
identify
object 
可选
memberId
string 
麒麟会员ID
可选
channel
string 
识别渠道 POS;WECHAT:微信 非必输(如果不传默认取requestChannel)
可选
userId
string 
渠道用户id。POS渠道:pos卡号(不能为手机号);微信:appId_openId;淘宝渠道:ouid;京东:xid;抖店:openid.其他渠道唯一id等等
可选
示例值:
wxd678efh567hg6787_oGPAG5rdBP78jh_3cmJ1en8FvZlo
coupons
array[object (Coupon) {6}] 
劵码
必需
memberId
string 
麒麟会员ID
可选
id
string 
卡券实例ID
可选
projectId
string 
项目ID
必需
>= 1 字符
code
string 
卡券券码
必需
>= 1 字符
grantAt
string <date-time>
发放时间:8时区格式
可选
state
string 
实例状态
可选
giftCode
string 
礼品编号
必需
phone
string 
收件人手机号
可选
当商品类型为实物时,此字段必传
addressee
string 
收件人名称
可选
当商品类型为实物时,此字段必传
address
string 
收件人地址
可选
当商品类型为实物时,此字段必传
shopCode
string 
店铺code
可选
platformId
string 
平台Id
可选
示例

返回响应

🟢200成功
application/json
consume 200 response
Body
success
boolean 
是否成功:true 表示成功 false 表示失败
可选
code
string 
000000 表示成功,其余编码表示具体错误编码
可选
message
string 
可选
data
object (BenefitUseResult) 
可选
orderId
string 
订单id
必需
>= 1 字符
amount
number 
订单金额
必需
paymentAmount
number 
订单实付金额
必需
discountAmount
number 
订单优惠金额
可选
优惠、促销等优惠的金额,通常等于订单金额减去订单实付金额
items
array[object (子订单) {8}] 
子订单
必需
>= 1 items
status
string 
事务状态
必需
WAITING:待处理,HANDLING:处理中,SUCCESS:成功,FAIL:失败,DUPLICATED:重复
couponSn
string 
卡号
可选
示例值:
KH78281
couponPwd
string 
密码
可选
示例值:
ASJIOSSHDNJJUSD
couponUrl
string 
卡链接
可选
示例值:
https://xxxx.com
couponCode
string 
礼券小类
可选
示例值:
BN
couponNo
string 
礼券号码
可选
示例值:
369
activityId
string 
活动ID
可选
示例值:
123
tranCode
string 
操作类型
可选
示例值:
2
couponNum
string 
礼券编号
可选
示例值:
BN000000369
上一页
权益礼品详情查询
下一页
优惠券列表
Built with