查询优惠券列表 - 客如云 API

(下行接口)合作方查询优惠券列表

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/crm/fetchCoupInstanceList?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "customerId": 888893406139, "couponStatus": [ 1, 2 ], "couponTypes": [ 1 ], "page": 1, "pageSize": 12 }'

{ "code": "1", "result": { "currentPage": 1, "pageSize": 10, "totalRows": 11, "startRow": 0, "totalPage": 2, "items": [ { "codeNumber": 3268120690040015, "couponType": 1, "id": 1657945, "couponName": "oetuaoetn", "ruleDesc": "满12减1", "periodStart": "00:00:00", "periodEnd": "23:59:00", "week": "1111111", "usableCommercialDesc": "仅限重庆冷锅鱼5,重庆冷锅鱼2,重庆冷锅鱼,重庆冷锅鱼1\",重庆冷锅鱼('小猪店),重庆冷锅鱼重庆冷锅4,重庆冷锅鱼1号店,重庆\"冷锅鱼2\"号店,重庆冷锅鱼4号店haohaohoa", "usableCommercialIdList": [ 880000880, 800000098, 800000096, 800000095, 810002316, 810004945, 810005934, 810005935, 810005937 ], "couponStatus": 3 }, { "codeNumber": 3268125450090017, "couponType": 3, "id": 1659520, "couponName": "aaaqqqq", "ruleDesc": "满0元可用", "periodStart": "00:00:00", "periodEnd": "23:59:00", "week": "1111111", "usableCommercialDesc": "仅限重庆冷锅鱼5,重庆冷锅鱼2,重庆冷锅鱼,重庆冷锅鱼1\",重庆冷锅鱼('小猪店),重庆冷锅鱼重庆冷锅4,重庆冷锅鱼1号店,重庆\"冷锅鱼2\"号店,重庆冷锅鱼4号店haohaohoa", "usableCommercialIdList": [ 880000880, 800000098, 800000096, 800000095, 810002316, 810004945, 810005934, 810005935, 810005937 ], "couponStatus": 3 } ] } }

请求参数

Query 参数

appKey

string

必需

开发者申请服务客如云分配的appKey

默认值:

shopIdenty

string

必需

客如云门店id （门店维度接口传递门店ID）

默认值:

brandId

string

必需

客如云品牌id（品牌授权的接口传递品牌ID）

默认值:

version

string

必需

版本,默认2.0（1.0版本仍可用）

默认值:

2.0

timestamp

string

必需

时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒，我方服务器使用阿里云授时中心

默认值:

sign

string

必需

签名，64位长度的字符串，获取规则详见签名规则

默认值:

Body 参数application/json

customerId

integer

顾客ID

必需

couponStatus

array[integer]

必需

优惠券状态(1:未使用;2:已验证;3:已过期;4:作废;)

couponTypes

array[integer]

必需

优惠券类型(2:折扣券;3:礼品券;4:现金券;)

page

integer

第几页

必需

pageSize

integer

每页查询数据条数

必需

示例

返回响应

🟢200成功

application/json

Body

code

string

必需

返回编码，详见错误码

result

object (CRMPager)

必需

currentPage

integer

当前页

必需

pageSize

integer

每页记录数

可选

totalRows

integer

总记录数

可选

startRow

integer

开始记录数

可选

totalPage

integer

总页码数

可选

items

array[object (CRMCoupInstanceVO) {14}]

数据对象

可选