券查询 - 客如云 API

（上行接口）合作方提供此接口地址，接受客如云商户pos端查询券信息的请求（满足第三方满减券、折扣券在客如云POS端核销验券场景）注：crm2.0商户不可使用该接口

curl --location -g --request POST '{{url}}?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "coupons":["123456789012345601"], "shopId":810094162 }'

{ "code": 0, "message": "OK", "messageUuid": "3b4cce269b0d45a3a2a783e91bed263a", "result": [ { "brandId": 32296, "shopId": 810094162, "couponInfo": { "couponNo": "123456789012345601", "couponName": "第三方满减券", "couponType": 1, "status": 1, "statusDesc": "可用", "threshold": 1, "faceValue": 1, "deductPerThreshold": 1, "startTime": "2019-08-01", "endTime": "2019-08-01" } } ] }

请求参数

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

coupons

array[string]

待核销券码集合

必需

shopId

integer

客如云商户门店编号

必需

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

messageUuid

string

必需

result

array[object (couponInfo) {10}]

必需

couponNo

string

优惠券编码

必需

couponName

string

必需

券标题(第三方券名称)

couponType

integer

必需

券类型(1:满减券, 2:折扣券)

status

integer

必需

劵状态 0 不可用(其他异常状态) 1 可用(未核销状态)

statusDesc

string

状态信息描述

必需

threshold

integer

必需

使用门槛(满xx元可用) (单位:元)

faceValue

integer

必需

couponType=2 → 折扣比例(比如:8.5→八五折) couponType=1 → 优惠金额(单位:元)

deductPerThreshold

integer

必需

couponType=1并且该字段值为true时 → 代表满减可以重复计算,为false时代表不可以重复计算

startTime

string

必需

有效期开始日期(2019-08-01)

endTime

string

必需

有效期截止日期(2019-09-30),注意：不包含最后一天