用户批次优惠券领取状态
1. 前言:
2. 交互时序图:
3. 请求场景:
查询用户批次优惠券领取状态
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | supplier-app-api |
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 入参 Parameters
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
lyfuid | String | 是 | 第三方应用用户授权id |
batchId | String | 是 | 优惠券批次id |
5.4 入参示例
/v1/supplier/coupon/69782155a427b03b13379131c29cb1a2?lyfuid=302179DCC2F12D929080F6CBD9610F5C
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
couponStatus | Integer | 是 | 优惠券使用状态 2.未使用,3.已过期,4已使用,5.已禁用 |
couponCode | String | 是 | 优惠券券号 |
5.7 返回示例
{
"data":[
{
"couponStatus":4,
"couponCode":"20490400000658"
},
{
"couponStatus":4,
"couponCode":"20490400003452"
}
],
"code":"0",
"msg":"success"
}