版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

使用场景:

查询订单号对应的,奖品状态

请求方式: GET

请求地址:https://integrate.rabbitpre.com/api/integrate/interest/getOrderPrizeInfo

consumes :application/json

produces :application/json

接口描述:

请求参数

...

请求头参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

X-Token自建应用访问tokenheadertruestring

请求体参数

字段名

描述

类型

是否必填

orderId

订单id

String

是 (中奖通知,传递的orderId)


请求实例

{
    "orderId": "684834095024443393"
}

响应参数:

字段名描述类型是否必填

code

结果返回码,200为正常,其余都为错误

String

msg

结果描述

String

data

结果

Boolean

data

orderId订单IdString
status领奖状态String

1:未领取

2:领取成功

3:领奖中

awardTime中奖时间Stringyyyy-MM-dd HH:mm:ss
appId作品idString
openidopenidString微信环境,用户授权才有
unionidunionidString微信环境,用户授权才有
audid客户档案IdString
activityId活动IdString
thirdPrizeId外部奖品IdString
identities身份标识List<Object>
appId
作品idString
appUrl
作品链接String
exchangeInfo
兑奖信息(编辑器奖品选项设置)Object编辑器设置了兑奖信息,才有
formInfo
权益设置的表单信息采集项Object工作台,设置奖项采集信息,并且用户填写,才有
number
奖品数量Int工作台,奖品设置数量
phone
手机号列表List<String>客户档案,用户手机号列表
prizeName
奖品名字String工作台,权益设置。奖品名称
prizeImg奖品图片String工作台,权益设置,奖品图片
prizeDetails奖品详情String工作台,权益设置,奖品详情
prizeUseRule奖品使用规则String工作台,权益设置,奖品使用规则


identities字段定义:

身份识别标识:

字段名

描述

类型

是否必须

identityType

标识类型

String

否,使用自建应用,身份识别才有

identityId标识IdString否,使用自建应用,身份识别才有
fromTo标识来源String
platform标识来源平台String
openidopenidString
当 fromTo 为 gzh 时,openid有值
微信环境,用户授权才有
unionidunionidString微信环境,用户授权才有

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>

{"姓名":"张三"}

当 fromTo 为 gzh 时,unionid有值

响应实例:

...

代码块
{
  "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

请联系管理员

80009ORDER_NOT_EXIST订单不存在,请检查订单id
80010ILLEGAL_ORDER_ID非法订单Id,请检查是不是当前Token对应的订单
80011PRIZE_DELETE奖品已被删除,请去工作台查看,是否奖品已被删除
80012ILLEGAL_PRIZE非法奖品,请检查该订单对应的奖品,是否是当前token对应的自建应用创建。
80014ILLEGAL_PARAM

订单id为空,请检查orderId传值