API文档中心

热门接口：产品ID找同款全量维权查询万能转链字符串ID转换 （有API需求可联系本站）

唯品会联盟订单查询接口

调用权限：核心接口会员卡调用
 接口测试 
接口使用场景等说明：

获取唯享客推广的订单信息列表 。

注：

（1）未传入OrderSnList时查询时间区间必传(OrderTime或UpdateTime)，最大查询时间区间默认不超过1小时 

（2）传入OrderSnList时，最大订单数不超过50条。

（3）因订单结算后仍有可能发生售后，所以一段周期内的订单收益为“推广成功订单收益”减去“结算后售后订单扣款”；但原订单信息一旦结算后，订单信息不再更改

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/vip/vip_orderlist 暂无

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
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
querySubsidyActFlag Boolean 否 false 是否查询补贴活动商品信息

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/vip/vip_orderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000 

【例子】根据订单号查询
http://api.veapi.cn/vip/vip_orderlist?vekey=xxx&orderSnList=23011151827442
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/vip/vip_orderlist?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; //返回值
使用okhttp3/httpclient/jsoup/hutool，以hutool为例：

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_orderlist?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);
    }
}
推荐使用 requests，支持访问http,https网页：

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/vip/vip_orderlist?vekey=xxx&orderTimeStart=1673405416000&orderTimeEnd=1673409016000"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值（JSON）

参数名称 参数类型 是否必选 示例值 描述
orderSn String 否 23011151827442 订单号
status Short 否   订单状态:0-不合格，1-待定，2-已完结
newCustomer Short 否   新老客：0-待定，1-新客，2-老客
channelTag String 否   渠道商模式下表示自定义渠道标识；工具商模式下表示pid
orderTime Long 否 1673405416000 下单时间 时间戳 单位毫秒
signTime Long 否   签收时间:时间戳 单位毫秒
settledTime Long 否   结算时间:时间戳 单位毫秒
detailList List 否   商品明细
 └─ goodsId String 否   商品id
 └─ goodsName String 否   商品名称
 └─ goodsThumb String 否   商品缩略图
 └─ goodsCount Integer 否   商品数量
 └─ commissionTotalCost String 否   商品计佣金额(元,保留两位小数)
 └─ commissionRate String 否   商品佣金比例(%)
 └─ commission String 否   商品佣金金额(元,保留两位小数)
 └─ commCode String 否   佣金编码：对应商品二级分类
 └─ commName String 否   佣金方案名称
 └─ orderSource String 否   订单来源
 └─ afterSaleInfo List<> 否   商品售后信息
 └─ sizeId String 否   商品尺码：2019.01.01之后可用
 └─ status Short 否   商品状态：0-不合格，1-待定，2-已完结
 └─ brandStoreSn String 否   品牌编号
 └─ brandStoreName String 否   品牌名称
 └─ spuId String 否   商品spuId
 └─ goodsFinalPrice String 否   商品成交价（元,保留两位小数,商品成交价上线之后的订单才有该值）
 └─ isSubsidyTaskOrder Boolean 是   商品是否参与渠道补贴活动
 └─ subsidyTaskOrderStatus Integer 否   补贴活动考核商品订单状态：-1：考核失败，0：未考核，1：已考核
 └─ subsidyTaskGoodsAward String 否   补贴活动商品奖励（单位：元）
 └─ cat1Code String 否   商品一级品类code
 └─ cat1Name String 否   商品一级品类名称
 └─ cat2Code String 否   商品二级品类code
 └─ cat2Name String 否   商品二级品类名称
 └─ cat3Code String 否   商品三级品类code
 └─ cat3Name String 否   商品三级品类名称
lastUpdateTime Long 否   订单上次更新时间,时间戳 单位毫秒
settled Short 否 0 订单结算状态0-未结算,1-已结算
selfBuy Integer 否 1 是否自推自买 0-否，1-是
orderSubStatusName String 否 已付款 订单子状态：流转状态-支持状态：（已下单、已付款、已签收、待结算、已结算、已失效）
commission String 否 2.36 商品总佣金:单位元
afterSaleChangeCommission String 否   售后订单佣金变动：仅在订单完结之后发生售后行为时返回
afterSaleChangeGoodsCount Integer 否   售后订单总商品数量变动：仅在订单完结之后发生售后行为时返回
commissionEnterTime Long 否 31507200000 入账时间，时间戳，单位毫秒
orderSource String 否 wap 订单来源
pid String 否   推广PID:目前等同于channelTag
isPrepay Integer 否 0 是否预付订单:0-否，1-是
statParam String 否   自定义统计参数
isSplit Integer 否 0 订单拆单标识: 0-否，1-是
parentSn String 否   订单母单号:订单为拆单子单时返回
orderTrackReason Integer 否 0 订单归因方式：0-常规推广,1-惊喜红包,2-锁粉,3-超级红包,4-专属券
appKey String 否 adfeesd1 开发者调用的appKey：当订单是通过开发者API推广成单时返回，其余时候返回为空
totalCost String 否 9.31 订单支付金额:单位元
openId String 否   渠道用户唯一标识
adCode String 否 vendoapi 标识获取推广物料的来源，从物料输出接口获取，可用于效果分析
statParam String 否 wx_1 自定义统计参数

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "接口调用成功！", "data": { "total": 0, "pageSize": 20, "page": 1, "orderInfoList": [ { "isSplit": 0, "orderSource": "wap", "orderSn": "23060533179608", "settled": 0, "openId": "", "commissionEnterTime": 31507200000, "pid": "5566", "orderTrackReason": 5, "orderSubStatusName": "已付款", "isPrepay": 0, "statParam": "abd56", "orderTime": 1685949456000, "newCustomer": 2, "adCode": "vendoapi", "detailList": [ { "commissionTotalCost": "16.00", "sizeId": "2805782718880832", "commissionRate": "0.00", "orderSource": "wap", "goodsId": "2805782718872640", "goodsFinalPrice": "16.00", "brandStoreSn": "10200037", "brandStoreName": "小茶日记", "cat2Code": "384289", "cat2Name": "茗茶", "commCode": "384289", "goodsCount": 1, "isSubsidyTaskOrder": false, "goodsThumb": "https://a.vpimg3.com/upload/merchandise/pdcpos/1100013578/2023/0420/78/4bd43da8-389c-4dfd-823d-e2860cdbe48b_750x750_50.jpg", "commission": "0.00", "commName": "MP直营|茗茶", "spuId": "SPU-13EFB0628000077F", "cat3Code": "384559", "cat1Name": "食品饮料", "goodsName": "金骏眉红茶桐木关蜜香红茶茶叶精致罐装好礼", "cat1Code": "384252", "cat3Name": "红茶", "status": 1 } ], "commission": "0.0", "appKey": "ea165a6b", "channelTag": "5566", "selfBuy": 1, "totalCost": "16.0", "status": 1, "lastUpdateTime": 1685949472000 } ] }, "request_id": "zF2YGYU" }

错误码

如果error不为0时，请点此查看错误码表格

在线
客服

点此【QQ在线咨询】QQ号：3252444923

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部