使用场景:

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

使用前提,自建应用需要开通-奖品-奖品订单状态查询 权限


请求方式: GET

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

consumes :

produces :application/json

接口描述:

请求参数


请求头参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

X-Token自建应用访问tokenheadertruestring

请求体参数

字段名

描述

类型

是否必填

orderId

订单id

String

是 。(中奖通知,传递的orderId,系统内部等价于字段prizeRecordId)


请求实例

{
    "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
identities身份标识List<Object>
appId
作品idString
appUrl
作品链接String
exchangeInfo
兑奖信息(编辑器奖品选项设置)Object编辑器设置了兑奖信息,才有
formInfo
权益设置的表单信息采集项Object工作台,设置奖项采集信息,并且用户填写,才有
number
奖品数量Int工作台,奖品设置数量
phone
手机号列表List<String>客户档案,用户手机号列表
prizeName
奖品名字String工作台,权益设置。奖品名称
prizeImg奖品图片String工作台,权益设置,奖品图片
prizeDetails奖品详情String工作台,权益设置,奖品详情
prizeUseRule奖品使用规则String工作台,权益设置,奖品使用规则
prizeId兔展奖品IDString是。工作台,权益设置,创建奖品后生成的奖品唯一标识ID
thirdPrizeId第三方奖品IDString否。外部三方的奖品唯一标识ID,和兔展生成的奖品唯一标识ID 是一一映射关系,来自原于外部奖品导入时传给兔展进行记录


identities字段定义:

身份识别标识:

字段名

描述

类型

是否必须

identityType

标识类型

String

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

identityId标识IdString否,使用自建应用,身份识别才有
fromTo标识来源String
platform标识来源平台String
openidopenidString微信环境,用户授权才有
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>

{"姓名":"张三"}

响应实例:

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "orderId": "699639734053507072",
        "status": "2",
        "awardTime": "2020-04-14 15:18:31",
        "appId": "wx94ec6057d5a4a719",
        "openid": "o7kepwTADYooArn--EVTHtKY811A",
        "audid": "684066953765195776",
        "activityId": "699634741598621696",
        "thirdPrizeId": "111111111",
        "identities": [
            {
                "openid": "o7kepwTADYooArn--EVTHtKY811A",
                "unionid": "obGcFt4nz1jclUF4kO3vjEDobFAw",
                "appid": "wx94ec6057d5a4a719",
                "platform": "gzh"
            }
        ],
        "phone": [],
        "prizeName": "test3",
        "number": 32,
        "amount": "22.00",
        "prizeImg": "//test-cdn1.rabbitpre.com/b5a46d9e-7b16-4ef4-8892-3e62cbe7eba0",
        "prizeDetails": "&lt;p&gt;33&lt;/p&gt;",
        "prizeUseRule": "33",
        "exchangeInfo": {},
        "formInfo": {},
        "prizeId": "699635574419623936"
    }
}
  

错误码:

code

msg

错误描述

100100

SYSTEM_ERROR

请联系管理员

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

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

  • 无标签