查询优惠券详情 - 客如云 API

(下行接口)客如云提供查询券模板列表

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/crm/fetchCoupInstanceDetail?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "id": 12345 }'

{ "result": { "brandId": 101819, "code_number": "168736860959456256", "couponId": 164768431294430200, "couponName": "不限库存3", "couponStatus": 3, "couponType": 4, "couponUseRuleDishList": [ { "dishTypeId": 66172478531055620, "dishTypeName": "素菜", "dishId": 4155104, "dishName": "橙汁", "unitName": "瓶", "price": 15, "couponUseRuleDishType": "DISH" } ], "createTime": 1544425202688, "creatorId": -1, "customerId": 162233171356765200, "dishConditionType": 2, "extraPeriodEnd": "23:59:00", "extraPeriodStart": "13:00:00", "faceValue": 2, "id": 168736861194337280, "instructions": "公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券", "isAllCommercial": false, "periodEnd": "12:30:00", "periodStart": "06:00:00", "planId": 168736452367137800, "updateTime": 1544461200000, "usableCommercialDesc": "仅限CI稳定区新权限01,CI稳定区新权限02,CI稳定区名字长名字长名字长名字长名字长名字长名字长名字长名字长名字长名字长,CI稳定区发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰,CI稳定区哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈,CI稳定区名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名", "usableCommercialIdList": [ 850018026, 850018030, 810022059, 810022074, 810022073, 810022072 ], "validEndDate": 1544457599000, "validStartDate": 1544371200000, "week": "1111110" }, "code": 0, "message": "成功[OK]", "messageUuid": "964644b070104fd0985b4a59023813bb", "apiMessage": "成功[OK]" }

请求参数

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

integer

必需

示例

返回响应

🟢200成功

application/json

Body

result

object (CrmCoupInstanceDetail)

可选

brandId

integer

必需

code_number

string

券编号

必需

couponId

integer

券模板id

必需

couponName

string

优惠券名称

必需

couponStatus

integer

必需

优惠券状态 4：已失效，1：未使用，2：使用中，3：无库存

couponType

integer

必需

优惠券类型：2：折扣，3：礼品，4：现金

couponUseRuleDishList

array[object (CrmCoupInstanceDetailUseDishDTO) {8}]

必需

createTime

integer

必需

creatorId

integer

必需

customerId

integer

顾客ID

必需

dishConditionType

integer

必需

extraPeriodEnd

string

必需

扩展使用时间段结束时间

extraPeriodStart

string

必需

扩展使用时间段开始时间

faceValue

integer

代金券金额

必需

integer

优惠券Id

必需

instructions

string

使用说明

必需

isAllCommercial

boolean

必需

periodEnd

string

使用时间段结束时间

必需

periodStart

string

使用时间段开始时间

必需

planId

integer

必需

updateTime

integer

必需

usableCommercialDesc

string

可用券门店名称列表

必需

usableCommercialIdList

array[integer]

必需

validEndDate

integer

必需

有效截至日期,eg:2017-01-01 23:00:23

validStartDate

integer

必需

有效开始日期,eg:2017-01-01 23:00:23

week

string

必需

使用星期限制七位字符串表示，1表示可用，0表示不可用，第一位表示周日，最后一位表示周六。如1100000表示周日、周一可用。1111110表示除了周六都能用

fullValue

string

可选

满值满x x元可用

offervalue

string

必需

用券后少付金额礼品券为空

disCount

string

必需

折扣(0.0~9.9)，eg：8.0

giftValue

number

礼品券金额

必需

ruleDesc

string

优惠券使用规则描述

可选

checkTime

string

验券时间

可选

checkerName

string

验券人

可选

availableCommercialList

array[integer]

可用门店id集合

可选

tradeNo

string

订单号

可选

tradeTime

string

订单时间

可选

personCount

string

消费人数

可选

dishId

integer

品牌菜ID

必需

dishName

string

菜品名称

必需

planName

string

方案名称

必需

field52

integer

必需

适用商品范围：1 全部可用 2 部分可用，3 部分不可用

tradeId

integer

订单ID

必需

field54

string

券编号

必需

tradeAmount

number

消费金额

必需

coupInstanceDetailUseDishList

array[string]

可选

适用商品列表：dishConditionType为：2、3的时候有值，1为空

code

integer

必需

错误码；0：成功；其他值认为失败

message

string

返回信息

必需

messageUuid

string

错误信息序列码

必需

apiMessage

string

必需