合作方发起查券接口
说明
合作方调用该接口查询首约已经发放的券详细信息
地址URL
http:// <SQYC_DOMAIN>/carapi/partner/query/coupon
HTTP请求方式
POST + form
请求参数
| 名称 | 选项 | 类型及范围 | 说明 |
|---|---|---|---|
| sign | 必选 | string | 签名 |
| channel | 必选 | string | 渠道号 |
| couponsId | 可选 | string | 券id |
| pageNum | 可选 | integer | 页码，默认为1 |
| pageSize | 可选 | integer | 每页条数，默认跟最大都是50 |
返回数据
| 名称 | 类型 | 说明 |
|---|---|---|
| result | string | 0：成功；非0：失败原因编号 |
| errmsg | string | 失败原因描述，若成功则值为空 |
| data | object | 详见下面返回示例 |
| data.coupons[] | JSON数组 | 券列表 |
| data.total | string | 总条数 |
coupons详细如下
| 名称 | 类型 | 说明 |
|---|---|---|
| couponsId | Long | 券id |
| couponsName | string | 券名称 |
| couponsType | integer | 类型 = 1：抵用券，2：折扣券 |
| createTime | number | 券创建时间戳 |
| couponsStatus | string | 状态 = 1：已使用，2：未使用，3：已过期，4：已锁定 |
| couponsAmount | number | 券面额（折扣券为最高抵扣金额） |
| discountInfo | string | 折扣信息（仅针对折扣券） |
| expireTime | number | 券失效时间戳 |
| useTime | number | 券使用时间戳 |
| orderNo | string | 券被应用到的首约的订单号 |
| day | Long | 发券时期 |
示例
{
"result": null,
"errmsg": null,
"data": {
"total": 1,
"coupons": [
{
"orderNo": "B2322184720134132012",
"couponsInfo": "{\"discountInfo\":\"80\",\"couponsAmount\":\"8\",\"couponsName\":\"福利中心\",\"couponsType\":\"2\"}",
"couponsId": 22008001,
"channelNum": "partner-XXXX",
"updateTime": null,
"templateId": 5001,
"couponsName": "福利中心",
"discountInfo": "80",
"expireTime": "2023-06-01 00:00:00",
"createTime": "2023-05-01 10:42:06",
"phone": "13401056789",
"couponsAmount": "8",
"couponsStatus": 2,
"useTime": null,
"id": 134,
"day": 20230614,
"couponsType": 2,
"status": 1
}
]
}
}