使用场景:
查询奖品id,查询订单列表
请求方式: POST
请求地址:https://integrate.rabbitpre.com/api/integrate/interest/order/lists
consumes :application/json
produces :application/json
接口描述:
请求参数
请求头参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| X-Token | 自建应用访问token | header | true | string |
请求体参数
字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
pageIndex | 页码 | int | 是 |
pageSize | 每页大小 | int | 是(范围为1~10) |
prizeId | 奖品id | long | 是 |
请求实例
{
"pageIndex": 1,
"pageSize": 10,
"prizeId": 0
}
响应参数:
| 字段名 | 描述 | 类型 | 是否必填 |
|---|---|---|---|
code | 结果返回码,200为正常,其余都为错误 | String | 是 |
msg | 结果描述 | String | 否 |
data | 结果 | List<Object> | 是 |
data | |||
| orderId | 订单Id | String | 是 |
| status | 领奖状态 | String | 1:未领取 2:领取成功 3:领奖中 |
| awardTime | 中奖时间 | String | yyyy-MM-dd HH:mm:ss |
| appId | 作品id | String | 是 |
| openid | openid | String | 微信环境,用户授权才有 |
| unionid | unionid | String | 微信环境,用户授权才有 |
| audid | 客户档案Id | String | 是 |
| activityId | 活动Id | String | 是 |
| thirdPrizeId | 外部奖品Id | String | 是 |
| identities | 身份标识 | List<Object> | 是 |
appId | 作品id | String | 是 |
appUrl | 作品链接 | String | 是 |
exchangeInfo | 兑奖信息(编辑器奖品选项设置) | Object | 编辑器设置了兑奖信息,才有 |
formInfo | 权益设置的表单信息采集项 | Object | 工作台,设置奖项采集信息,并且用户填写,才有 |
number | 奖品数量 | Int | 工作台,奖品设置数量 |
phone | 手机号列表 | List<String> | 客户档案,用户手机号列表 |
prizeName | 奖品名字 | String | 工作台,权益设置。奖品名称 |
| prizeImg | 奖品图片 | String | 工作台,权益设置,奖品图片 |
| prizeDetails | 奖品详情 | String | 工作台,权益设置,奖品详情 |
| prizeUseRule | 奖品使用规则 | String | 工作台,权益设置,奖品使用规则 |
identities字段定义:
身份识别标识:
字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
identityType | 标识类型 | String | 否,使用自建应用,身份识别才有 |
| identityId | 标识Id | String | 否,使用自建应用,身份识别才有 |
| fromTo | 标识来源 | String | 是 |
| platform | 标识来源平台 | String | 是 |
| openid | openid | String | 微信环境,用户授权才有 |
| unionid | unionid | String | 微信环境,用户授权才有 |
exchangeInfo字段定义:
兑奖信息标识:
字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
contact | 联系方式 | String | 编辑器。奖品兑奖信息设置 |
exchangeAddress | 兑奖地址 | String | 编辑器。奖品兑奖信息设置 |
exchangeDesc | 兑奖描述 | String | 编辑器。奖品兑奖信息设置 |
exchangeUrl | 兑奖线上地址 | String | 编辑器。奖品兑奖信息设置 |
operateTip | 操作提示 | String | 编辑器。奖品兑奖信息设置 |
orgName | 主办单位名称 | String | 是 |
| contactLabel | 联系方式label值 | String | 编辑器。奖品兑奖信息设置 |
| exchangeAddressLabel | 兑奖地址label值 | String | 编辑器。奖品兑奖信息设置 |
| exchangeDescLabel | 兑奖描述label值 | String | 编辑器。奖品兑奖信息设置 |
formInfo字段定义:
兑奖信息标识:
字段名 | 描述 | 类型 | 是否必须 |
|---|---|---|---|
data | 表单提交信息 | Map<String,String> | {"姓名":"张三"} |
响应实例:
{
"code": "string",
"data": [
{
"activityId": "string",
"amount": "string",
"appId": "string",
"appUrl": "string",
"audid": "string",
"awardTime": "string",
"exchangeInfo": {
"contact": "string",
"exchangeAddress": "string",
"exchangeDesc": "string",
"exchangeUrl": "string",
"operateTip": "string",
"orgName": "string"
},
"formInfo": {
"data": {}
},
"identities": [
{
"appid": "string",
"fromTo": "string",
"identityId": "string",
"identityType": "string",
"jcappId": "string",
"openid": "string",
"platform": "string",
"unionid": "string"
}
],
"number": 0,
"openid": "string",
"orderId": "string",
"phone": [
"string"
],
"prizeName": "string",
"status": "string",
"thirdPrizeId": "string",
"unionid": "string"
}
],
"errorCode": "string",
"msg": "string"
}
错误码:
code | msg | 错误描述 |
|---|---|---|
100100 | SYSTEM_ERROR | 请联系管理员 |