接口使用场景等说明:获取唯品会联盟(唯享客)的虚拟订单信息,注:
(1)未传入OrderSnList时查询时间区间必传(OrderTime或UpdateTime),最大查询时间区间默认不超过24小时
(2)传入OrderSnList时,最大订单数不超过50条
(3)pageSize不大于100
| 环境 | http 地址 | https 地址 |
|---|---|---|
| 正式环境 | http://api.veapi.cn/vip/vip_virtualorderlist | 暂无 |
| 参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
| orderSnList | List | 否 | 20031992788414 | 订单号列表,支持批量查询订单号,用逗号隔开,比如111,222:当传入订单号列表时,订单时间和更新时间区间可不传入。 |
| status | Short | 否 | 1 | 订单状态:0-不合格,1-待定,2-已完结,该参数不设置默认代表全部状态 |
| orderTimeStart | Long | 否 | 1584611370000 | 订单时间起始:时间戳,单位毫秒,你可以在10位的时间戳后面直接加'000'三位做毫秒 |
| orderTimeEnd | Long | 否 | 1584611370000 | 订单时间结束:时间戳,单位毫秒,注意与orderTimeStart的时间范围不能超过1小时 |
| page | Integer | 否 | 1 | 页码:从1开始 |
| pageSize | Integer | 否 | 20 | 页面大小:默认20,不大于100 |
| updateTimeStart | Long | 否 | 1584611370000 | 更新时间-起始 时间戳 单位毫秒 |
| updateTimeEnd | Long | 否 | 1584611370000 | 更新时间-结束 时间戳 单位毫秒,注意与updateTimeStart的时间范围不能超过1小时 |
| chanTag | String | 否 | 渠道标识,即推广位PID。注意:若传此参数,则必须和转链接口传的chanTag一样。 | |
| vendorCode | String | 否 | false | vendorCode,工具商方式下会传入 |
GET/POST http://api.veapi.cn/vip/vip_virtualorderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000【例子】根据订单号查询
http://api.veapi.cn/vip/vip_virtualorderlist?vekey=xxx&orderSnList=23011151827442
$api="http://api.veapi.cn/vip/vip_virtualorderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $api); //curl_setopt($ch, CURLOPT_POST, true); //POST方式时启用 //curl_setopt($ch, CURLOPT_POSTFIELDS, $postData ); //POST方式时传参 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true ); //返回数据流,不直接输出 curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快 curl_setopt($ch, CURLOPT_TIMEOUT, 6); //允许执行的最长秒数。这里设定6S curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); $result = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); echo $result; //返回值
import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;
public class testGetParam {
public static void main(String[] args) {
// API网址
String url = "http://api.veapi.cn/vip/vip_virtualorderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000";
// JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
//System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");
// 发送请求
String result = HttpRequest.get(url)
.timeout(10000)//设置超时,毫秒
.execute().body();
System.out.println(result);
}
}
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/vip/vip_virtualorderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
| 参数名称 | 参数类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| orderSn | String | 否 | 订单号 | |
| status | Short | 否 | 订单状态:0-不合格,1-待定,2-已完结 | |
| channelTag | String | 否 | channelTag=chanTag=pid,即推广位标识,用来标记推广中的某个资源位,比如APP的banner、icon等(必传)(不能含有特殊字符,仅限字母、数字、下划线, 长度最大64) | |
| orderTime | Long | 否 | 下单时间 时间戳 单位毫秒 | |
| settledTime | Long | 否 | 结算时间 时间戳 单位毫秒 | |
| goodsId | String | 否 | 商品id | |
| goodsName | String | 否 | 商品名称 | |
| goodsThumb | String | 否 | 商品缩略图 | |
| goodsType | Integer | 否 | 商品类型304:超级VIP,302:电子唯品卡,700:MP通用卡券 | |
| lastUpdateTime | Long | 否 | 订单上次更新时间 时间戳 单位毫秒 | |
| settled | Short | 否 | 订单结算状态 0-未结算,1-已结算 | |
| selfBuy | Integer | 否 | 是否自推自买 0-否,1-是 | |
| orderSubStatusName | String | 否 | 订单子状态:流转状态-支持状态:(已下单、已付款、待结算、已结算、已失效) | |
| commissionTotalCost | String | 否 | 订单计佣金额(元,两位小数) | |
| commission | String | 否 | 订单佣金(元,两位小数) | |
| commissionRate | String | 否 | 订单佣金比例(%) | |
| commissionEnterTime | Long | 否 | 入账时间,时间戳,单位毫秒 | |
| orderSource | String | 否 | 订单来源 | |
| totalCost | String | 否 | 订单支付金额:单位元 | |
| afterSaleChangeCommission | String | 否 | 售后订单佣金变动:仅在订单完结之后发生售后行为时返回,单位元 | |
| pid | String | 否 | 推广PID:目前等同于channelTag | |
| statParam | String | 否 | 自定义统计参数 | |
| orderTrackReason | Integer | 否 | 订单归因方式:0:常规推广,1:锁粉,2:deeplink 或常规推广,3:惊喜红包,4:deeplink唤起,5:渠道包,6:商详页浏览,7:超级红包(券),8:超级红包币,9:超级红包(津贴),10:专属券,11:直推订单,12:直推订单(跨端),13:常规推广(跨端) | |
| appKey | String | 否 | 开发者调用的appKey:当订单是通过开发者API推广成单时返回,其余时候返回为空 | |
| openId | String | 否 | 渠道用户唯一标识(若未返回openid,请先在联盟平台-推广管理-会员管理-私域用户管理处进行申请,并联系商务进行审核,未申请和超过申请数量的openid不会返回) | |
| adCode | String | 否 | 标识获取推广物料的来源,从物料输出接口获取,可用于效果分析 | |
| refundOrderDetails | List | 否 | 维权订单明细 | |
| └─ goodsId | String | 否 | 商品id | |
| └─ sizeId | String | 否 | 商品尺码id | |
| └─ goodsPrice | String | 否 | 商品价格:元 | |
| └─ goodsCount | Integer | 否 | 维权商品数量 | |
| └─ commission | String | 否 | 维权商品佣金 | |
| └─ totalCost | String | 否 | 维权商品计佣金额 | |
| fdsBlackOrder | Integer | 否 | 是否异常订单,1:是,0:否 | |
| svipOpenType | Integer | 否 | 超V首开类型,0:续费,非首开,1:首开(待定),2:首开 | |
| total | Integer | 否 | 业绩总条数 | |
| page | Integer | 否 | 当前页码 | |
| pageSize | Integer | 否 | 页面大小 |