优惠券列表 - CFT-周大福

curl --location --request POST 'https://api-vpjq75s2e4.kylin.shuyun.com/fast-service/v1/0.0/api/coupon/list' \ --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", "page": 0, "identify": { "memberId": "string", "channel": "string", "userId": "wxd678efh567hg6787_oGPAG5rdBP78jh_3cmJ1en8FvZlo" }, "projectId": "string", "state": "string", "pageSize": 20, "queryParams": "string", "showProject": true }'

{ "success": true, "code": "string", "message": "string", "data": { "page": 0, "pageSize": 0, "totalCount": 0, "items": [ { "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

可选

默认值:

X-Caller-sign

string

可选

默认值:

X-Caller-Timestamp

string

可选

默认值:

X-Caller-Sign

string

网关签名

可选

默认值:

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

page

integer <int32>

当前页:从0开始

必需

默认值:

示例值:

identify

object

必需

memberId

string

麒麟会员ID

可选

channel

string

识别渠道 POS;WECHAT:微信非必输(如果不传默认取requestChannel)

可选

userId

string

渠道用户id。POS渠道:pos卡号(不能为手机号);微信:appId_openId;淘宝渠道:ouid;京东:xid;抖店:openid.其他渠道唯一id等等

可选

示例值:

wxd678efh567hg6787_oGPAG5rdBP78jh_3cmJ1en8FvZlo

projectId

string

项目ID

可选

state

string

卡劵实例状态,不传入默认查询所有状态下的实例,CREATED:已发放,ACTIVATED:已启用,DISCARDED:已作废,EFFECTED:已生效,EXPIRED:已失效,LOCKED:已锁定,USED:已使用

可选

pageSize

integer <int32>

页大小:不超过20

必需

默认值:

示例值:

queryParams

string

查询条件参数

可选

查询条件参数是动态传入,例子:{"title":{"EQ":"openapi测试项目"},"status":{"EQ":"RELEASED"},"branch":{"IN":["2e3cc427"]},"updateAt":{"BETWEEN":["2022-10-21 14:24:28","2022-10-21 14:24:30"]}}，可通过响应结果值中的属性名称过滤

showProject

boolean

是否展示项目信息

可选

为false的话响应参数中没有project

示例

返回响应

🟢200成功

application/json

list 200 response

Body

success

boolean

是否成功：true 表示成功 false 表示失败

可选

code

string

000000 表示成功，其余编码表示具体错误编码

可选

message

string

可选

data

object (PageResult_CouponGetResult_)

可选

page

integer <int32>

当前页

可选

pageSize

integer <int32>

页大小

可选

totalCount

integer <int64>

总记录数

可选

items

array[object (CouponGetResult) {33}]

明细数据

可选