优惠券批次号查询优惠券详情
1. 前言:
2. 交互时序图:
3. 请求场景:
外部服务商获取关注社区生活状态
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | activity-endorsement |
URL | 测试环境:https://openapi.test.laiyifen.com/activity-endorsement/endorsement/coupon-activity/v1/coupon/detail 生产环境:https://openapi.laiyifen.com/activity-endorsement/endorsement/coupon-activity/v1/coupon/detail |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
功能描述(适用场景) | 根据优惠券批次号集合查询优惠券明细 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
encryptBatchIds | List<String> | 是 | 请求对象, 优惠券批次号集合 |
5.4 入参示例
["69782155a427b03b13379131c29cb1a2","b677dd5ff81fb42898068b0fb1c40f86"]
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
batchMaxReceive | Integer | 是 | 批次最大领取量 |
batchStatus | String | 是 | 优惠券批次状态 |
batchType | String | 是 | 优惠券类型 |
couponBatchStr | String | 是 | 加密后的优惠券批次号 |
couponDesc | String | 是 | 方案说明 |
couponDiscount | Bigdecimal | 是 | 具体折扣 |
couponName | String | 是 | 优惠券方案名称 |
couponRange | String | 是 | 使用范围 |
discountType | String | 是 | 折扣类型 |
endTime | String | 是 | 优惠券结束时间 |
isAvailable | String | 是 | 是否可用 |
maxCount | Integer | 是 | 批次最大发行数量 |
maxOfferAmount | Bigdecimal | 是 | 最大优惠金额 |
minSpendAmount | Bigdecimal | 是 | 最低消费金额 |
personMaxCount | Integer | 是 | 个人最大使用数量 |
startTime | String | 是 | 优惠券开始时间 |
timeType | String | 是 | 有效期类型 |
useRange | String | 是 | 使用范围 |
vaildDate | Integer | 是 | 领券后有效期 |
verificationCount | Integer | 是 | 核销数量 |
5.7 返回示例
{
"data":[
{
"couponBatchStr":"69782155a427b03b13379131c29cb1a2",
"batchType":"普通券",
"couponDesc":"黑金长期优惠方案",
"couponDiscount":6,
"couponName":"黑金长期优惠方案",
"couponRange":"整单",
"discountType":"优惠",
"endTime":"2021-08-31 15:59:59",
"isAvailable":"可用",
"maxOfferAmount":null,
"minSpendAmount":0,
"startTime":"2020-08-31 16:00:00",
"timeType":"固定期限",
"useRange":null,
"validDate":null,
"maxCount":5000,
"batchMaxReceive":20,
"batchStatus":"进行中(审核通过)",
"personMaxCount":999,
"verificationCount":null
},
{
"couponBatchStr":"b677dd5ff81fb42898068b0fb1c40f86",
"batchType":"普通券",
"couponDesc":"pos优化测试50个商品",
"couponDiscount":20,
"couponName":"pos优化测试50个商品",
"couponRange":"指定商品",
"discountType":"优惠",
"endTime":"2020-10-31 15:59:59",
"isAvailable":"可用",
"maxOfferAmount":null,
"minSpendAmount":80,
"startTime":"2020-09-25 06:33:50",
"timeType":"固定期限",
"useRange":"线下",
"validDate":null,
"maxCount":999999,
"batchMaxReceive":300,
"batchStatus":"进行中(审核通过)",
"personMaxCount":999,
"verificationCount":null
}
],
"code":"0",
"msg":"success"
}