
该接口用于获取活动奖品、商品已产生订单的记录
接口参数说明
请求地址 | https://open.rrx.cn/api/v1/order/GetList | |
请求方式 | POST | |
参数名称 | 是否必须 | 说明 |
app_key | 是 | 人人秀平台分配的AppKey |
time_stamp | 是 | 1970-01-01开始的时间戳,精确到毫秒 |
sign | 是 | 根据签名算法所得,如何计算签名 |
h5_guid | 是 | 活动唯一标识 |
activity_guid | 否 | 互动标识,指定活动下互动可传值 ,如何获取互动ID |
order_no | 否 | 查询指定订单编号数据,可空。多个订单编码可传数组,最多100个。 |
order_state | 否 | 查询订单状态,默认:-1。枚举( 0:待付款,1:待发货,2:待收货,3:退款中,4:已完成,5:已取消,6:待分享,7:待核销) |
page | 是 | 分页页码 |
limit | 否 | 每页返回数量,不填默认20条,最大支持100条/页,时间倒序 |
start_time | 否 | 查询订单创建起始时间 |
end_time | 否 | 查询订单创建结束时间 |
返回JSON格式结果 Content-type: application/json | ||
{"result":0,"msg":"","data":{}} | ||
参数名称 | 说明 | |
result | 0表示成功,1表示失败 | |
msg | 失败时,返回的错误描述 | |
data | 详情见data参数说明 | |
data参数说明
参数名称 | 数据类型 | 说明 |
rows | obj | 订单记录列表,详情见rows参数说明 |
total | int(11) | 订单总数 |
rows参数说明
参数名称 | 数据类型 | 说明 |
order_no | string(32) | 人人秀订单编号 |
order_state | int(11) | 订单状态枚举( 0:待付款,1:待发货,2:待收货,3:退款中,4:已完成,5:已取消,6:待分享,7:待核销) |
order_total_amount | float(2) | 订单总金额,奖品类型为0,支付单位为元 |
order_pay_amount | float(2) | 订单支付金额 |
order_pay_discount | obj | 订单支付折扣(积分、金币兑换、优惠劵时有值,数组) |
openid | string(128) | 用户唯一授权标识 |
nickname | string(60) | 用户授权昵称 |
headimgurl | string(200) | 用户授权头像 |
create_time | datetime | 订单创建时间 |
shipping_time | datetime | 订单发货时间 |
complete_time | datetime | 订单完成时间(收货或取消) |
cancel_msg | string(100) | 取消订单原因,仅商城取消订单时可能有值 |
product_info | obj | 订单商品详情,参看 product_info参数 |
receiver_name | string(20) | 收货人姓名 |
receiver_phone | string(20) | 收货人电话 |
receiver_adds | string(100) | 收货人地址,包含省市区详细地址 |
express_name | string(60) | 快递公司名称 |
express_no | string(60) | 快递发货单号 |
user_info | obj | 报名信息,活动开启报名后参与时有值 |
activity_guid | string(32) | 互动GUID,通过互动产生的数据有值,商城商品无值 |
source_name | string(60) | 推广来源,活动从推广渠道访问时有值 |
product_info 参数说明
参数名称 | 数据类型 | 说明 |
product_id | string(30) | 商品ID |
product_name | string(60) | 商品名称 |
product_type | int(11) | 奖品/商品类型枚举:1:实物;2:红包;5:优惠券;6:积分;7:自有奖品;8:礼品;12:商品;13:活动报名;15:表单;16:预约;17:微信卡劵 |
product_detail | string(10) | 仅当奖品类型为红包、积分、优惠劵,有明细值,例如积分值"5" |
product_sku | string(20) | 商品规格名称,仅商城商品多规格时有值 |
product_num | int(11) | 商品购买数量 |
product_price | float(2) | 商品金额(单价) |
product_image_url | string(200) | 商品图片地址 |
user_info 参数说明
参数名称 | 数据类型 | 说明 |
id | int(11) | 数据ID |
title | string(100) | 数据标题 |
value | string(200) | 数据内容 |
order_pay_discount 参数说明
参数名称 | 数据类型 | 说明 |
type | int(11) | 折扣类型,枚举 1:积分,2:金币,3:优惠劵 |
name | string(100) | 折扣类型名称,例如“积分” |
value | float(2) | 折扣类型值,例如“10” |
活动支持说明
1.适用于电商活动玩法,拼团、秒杀;
请求示例
{
"app_key": "96c84928b1dce057d110ea3b3880fc83",
"time_stamp":"1543999047492",
"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",
"h5_guid":"123456",
"activity_guid": "",
"order_type": 0,
"page ":1,
"limit ":20,
"start_time":"2099-09-10 09:10:00",
"end_time":"2099-09-10 09:10:00",
}
返回值示例, json格式 Content-type: application/json
{
"result": 0,
"data": {
"total": 1,
"rows": [{
"order_no": "TP1543999047492",
"order_state": "待收货",
"order_total_amount": 0.1,
"order_pay_amount": 0.1,
"order_pay_discount": [],
"openid ": " gb_1543999047492",
"nickname": "小张子",
"headimgurl": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TMaE…zXTfZQugNBA/132",
"create_time": "2099-09-10 09:10:00",
"shipping_time": "2099-09-10 09:10:00",
"product_info": [{
"product_id": "10001",
"product_name": "商品1",
"product_image_url": "https://qn-file.rrxiu.net/prize_icon_v2.png",
"product_type": 13,
"product_num": 1,
"product_price": 0.1,
}],
"receiver_name": "张三",
"receiver_phone": "15800001111",
"receiver_adds": "北京市朝阳区幸福大厦101",
"express_name": "顺风快递",
"express_no": "SF10001",
"activity_guid": "9309b5e3",
"source_name": "百度",
}]
},
"msg": "ok"
}
枚举值
product_type,奖品/商品类型枚举值:1:实物;2:红包;5:优惠券;6:积分;7:自有奖品;8:礼品;12:商品;13:活动报名;15:表单;16:预约;17:微信卡劵
order_state,订单状态类型枚举值: 0:待付款,1:待发货,2:待收货,3:退款中,4:已完成,5:已取消,6:待分享,7:待核销
相关文档