企迈云-开放平台

API 2.0

API 2.0 > 7.4 优惠券相关操作 > 7.4.4 券状态查询

7.4.4 券状态查询

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：查询某张券信息

餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	user.coupon-new-status	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	描述
customerId	string	是	客户ID 383933091455959041
useStatus	int	否	券状态:0：未使用、1：已使用、2：已冻结、6：已失效、7：已删除
cardId	string	否	券编码（对应发券相应参数中的cardID）390913445498200065

响应参数

参数	参数类型	描述
beginAt	date	券生效时间
cardId	string	券编码 390913445498200065
channel	string	商家账户名
couponId	string	优惠券id 389420520079552512
couponType	string	券类型:0、现金券/折扣券 2、限制数量免单券 3、erp兑换券(线下用) 4、买M送N券 5、商品券 6、免运费/配送费券 7、免排队券 8、停车券
createdAt	string	创建时间
customerId	string	客户ID
title	string	券名称
updatedAt	string	更新时间
useStatus	int	劵状态:0：未使用/已冲正、1：已核销、2：已冻结、6：已失效、7：已删除/已回收
templateId	int	券模板id 895
endAt	string	券失效时间
extra	string	附加信息

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "user.coupon-new-status",
    "Params": {
        "customerId": "383933091455959041",
        "useStatus": "",
        "cardId": "390913445498200065"
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "beginAt": "2019-08-24 00:00:00",
        "cardId": "390913445498200065",
        "channel": "naixue",
        "couponId": "390913445519171584",
        "couponType": "0",
        "createdAt": "2019-10-15 17:10:28",
        "customerId": "383933091455959041",
        "title": "",
        "updatedAt": "2019-10-15 17:10:2",
        "useStatus": "0",
        "templateId": "951",
        "endAt": "2019-11-03 23:59:59",
        "extra": ""
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}