API文档中心

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

唯品会联盟商品关键字搜索接口

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

根据关键字查询唯品会联盟商品列表，支持指定排序字段和设置价格区间。

接口请求地址

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

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
keyword String 是 羽绒服女 关键词
virtual Integer 否 默认0 是否屏蔽虚拟商品：帮助小程序和IOS APP上架审核。可选值0，1，2，上架时可临时开启，参数值：默认0表示不检查虚拟类商品，1表示检测并拒绝虚拟类商品搜索（此时如果检测到虚拟类产品则接口error为91），2表示只检测不过滤，只提示搜索结果，这时返回值中增加一个字段is_virtual（值0表示不是虚拟产品，1表示是虚拟产品）
fieldName String 否   排序字段，可选值：PRICE 表示价格排序，DISCOUNT 折扣排序，SALES 销量排序，COMMISSION_RATE 佣金比例排序
order Integer 否   排序顺序：默认0-升序（等同于其它平台搜索接口的asc），1-降序（等同于其它平台搜索接口的desc）
page Integer 否 默认20 页码
pageSize Integer 否   页面大小：默认20,最大50
priceStart String 否   价格区间---start
priceEnd String 否   价格区间---end
queryReputation Boolean 否   是否查询商品评价信息:默认不查询，该数据在详情页有返回，没有特殊需求，建议不查询，影响接口性能
queryStoreServiceCapability Boolean 否   是否查询店铺服务能力信息：默认不查询，该数据在详情页有返回，没有特殊需求，建议不查询，影响接口性能
queryStock Boolean 否   是否查询库存:默认不查询
queryActivity Boolean 否   是否查询商品活动信息:默认不查询
queryPrepay Boolean 否   是否查询商品预付信息:默认不查询
vendorCode String 否   工具商code
chanTag String 否   用户pid
queryExclusiveCoupon Boolean 否 true 是否查询专属红包信息：默认false不查询
queryCpsInfo Integer 否 默认0 是否返回cps链接：默认0-不查询，1-tra_from参数,2-小程序链接，默认为0，查询多个时按照位运算处理，例如：3表示查询tra_from参数+小程序链接
research Boolean 否 true 搜索无结果时是否返回推荐词搜索结果,默认是
queryFuturePrice Boolean 否 true 是否查询未来价信息：默认不查询
openId String 否 556599542235 自定义的标记渠道用户在渠道侧的用户唯一标识（必传）（如已接入sdk，该值为渠道用户授权绑定唯品会账号的标识，如没接入sdk，该值为渠道用户在渠道侧的用户唯一标识）不能含有特殊字符，仅限字母、数字、下划线，长度最大32，用于识别用户并给用户返利分佣（非常重要！传错影响给用户返利分佣）如果当前调用与用户无关，比如后台job触发拉取商品，则传默认标识：default_open_id (转链接口不论是否实时调用都必须传实际的 open_id)。调转链接口与商品接口时，同一用户openId传参需要一致订单里面会带上转链时所传的openId信息。
realCall Boolean 否 false 2023.7.1后新增的参数：是否实时调用，true：由用户实时触发的请求，实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false：不是由用户实时触发，由渠道后台job触发的请求，比如渠道后台job定期调联盟接口拉取商品到渠道自己的库，请按实际情况传该参数。

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/vip/vip_search?vekey=xxx&keyword=羽绒服女冬时尚休闲短款小个子面包服保暖羽绒外套 

【例子】按discount字段排序
http://api.veapi.cn/vip/vip_search?vekey=xxx&keyword=羽绒服外套&fieldName=discount&order=0
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/vip/vip_search?vekey=xxx&keyword=羽绒服女冬时尚休闲短款小个子面包服保暖羽绒外套";

$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_search?vekey=xxx&keyword=羽绒服女冬时尚休闲短款小个子面包服保暖羽绒外套";
        // 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_search?vekey=xxx&keyword=羽绒服女冬时尚休闲短款小个子面包服保暖羽绒外套"

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

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

返回值（JSON）

参数名称 参数类型 示例值 描述
goodsId String   商品id
goodsName String   商品名称
goodsDesc String   商品描述,字段暂不输出
destUrl String   商品落地页
goodsThumbUrl String   商品缩略图
goodsCarouselPictures List   商品轮播图：根据商品id查询时返回，商品列表不返回
goodsMainPicture String   商品主图
categoryId Long   商品三级分类id
categoryName String   商品三级分类
sourceType Integer   商品类型：0-自营，1-MP
marketPrice String   市场价（元）
vipPrice String   唯品价（元）
commissionRate String   佣金比例（%）
commission String   佣金金额（元）
discount String   折扣:唯品价/市场价 保留两位小数字符串
goodsDetailPictures List   商品详情图片：根据商品id查询商品信息时返回，商品列表不返回
cat1stId Long   商品一级分类id
cat1stName String   商品一级分类名称
cat2ndId Long   商品二级分类id
cat2ndName String   商品二级分类名称
brandStoreSn String   商品品牌sn
brandName String   商品品牌名称
brandLogoFull String   商品品牌logo全路径地址
schemeEndTime Long   商品推广计划有效期预估截止时间：仅为预估时间，仅做参考；时间戳，单位：毫秒
sellTimeFrom Long   商品售卖开始时间,时间戳，单位毫秒
sellTimeTo Long   商品售卖结束时间,时间戳,单位毫秒
weight Integer   推广权重，用于确定推广该商品的优先级，权重值越大，优先级越高
storeInfo Storeinfo   店铺信息
 └─ storeId String 唯品自营 店铺id
 └─ storeName String ST00000 店铺名称
commentsInfo Map   商品评价信息
 └─ comments Integer 11496 商品评论数
 └─ goodCommentsShare String 99.00 商品好评率:百分比，不带百分号
storeServiceCapability Map   商品所属店铺服务能力评价
 └─ storeScore String 98 店铺评分：保留两位小数
 └─ storeRankRate String 1.00 店铺同品类排名比例：例如10表示前10%
brandId Long   商品所属档期（专场）id
schemeStartTime Long   商品所属推广方案开始时间：时间戳，单位：毫秒
saleStockStatus Integer   商品库存状态：1-已抢光，2-有库存，3-有机会,当列表查询库存或者查询商品详情时返回
status Integer   商品状态：0-下架，1-上架
prepayInfo Map   商品预付信息
 └─ isPrepay Integer 0 是否预付商品:0-否，1-是
 └─ prepayPrice String 56.00 预付到手价：元
 └─ firstAmount String   预付首款金额：元
 └─ lastAmount String   预付尾款金额：元
 └─ prepayFavAmount String   预付优惠金额:元
 └─ deductionPrice String   抵扣价格(首款+优惠金额)：元
 └─ prepayDiscount String   预付折扣：(唯品价-优惠金额)/唯品价,保留两位小数的数字字符串
 └─ prepayFirstStartTime Long   首款支付开始时间:时间戳,单位毫秒
 └─ prepayFirstEndTime Long   首款支付结束时间:时间戳,单位毫秒
 └─ prepayLastStartTime Long   尾款支付开始时间:时间戳,单位毫秒
 └─ prepayLastEndTime Long   尾款支付结束时间:时间戳,单位毫秒
joinedActivities Map   商品参与活动信息:未参与活动集合为空
 └─ actType Integer   活动类型:18-唯品快抢
 └─ actName String   活动名称
 └─ beginTime Long   开始时间：时间戳，单位毫秒
 └─ endTime Long   结束时间：时间戳，单位毫秒
 └─ foreShowBeginTime Long   预热开始时间：时间戳，单位毫秒
couponInfo Map   红包信息
 └─ useBeginTime Long 1673280000000 使用开始时间，毫秒级时间戳
 └─ useEndTime Long 1673280000000 使用结束时间，毫秒级时间戳
 └─ couponNo String   优惠券批次号
 └─ couponName String 红包5元 优惠劵名称
 └─ couponType Byte 5 券类型,(1:买赠 2:满减 3:折扣 4:免邮 5:多减多减)
 └─ buy String 5.00 使用门槛
 └─ fav String 5.00 优惠金额
 └─ activateBeginTime Long 1673316000000 券激活开始时间,毫秒级时间戳
 └─ activateEndTime Long 1673316000000 券激活结束时间,毫秒级时间戳
 └─ totalAmount Long 10000 生成劵的总量
 └─ activedAmount Long -1 劵已激活的数量
 └─ vipPrice Double   唯品价(用于券的展示逻辑)
 └─ hiddenCouponReceiveUrl String   隐藏红包领券页链接
haiTao Integer   是否海淘商品标识：1是 0不是
spuId String   商品spuId
goodsIdsWithSameSpu List   同spuId扩展商品id: 新版详情接口返回，其余接口不返回该字段
skuInfos Map   对应sku信息
 └─ sizeId String   商品尺码id(唯品会体系下和skuId等同)
 └─ saleProps Map   售卖属性信息（134 - 颜色,453 - 尺码）
 └─ leavingStock Integer   剩余库存:查询库存时返回
 └─ saleStockStatus Integer   商品库存状态：1-已抢光，2-有库存，3-有机会
 └─ vipPrice String   唯品价:单位元
 └─ marketPrice String   市场价:单位元
exclusiveCoupon Channelexclusivecoupon   渠道专属红包：目前仅开放单品券，没有则返回空.下级字段参考couponInfo信息。
cpsInfo Map   cps推广信息：目前只返回小程序链接和通用追踪参数，其他链接请移步转链接口,1-通用推广参数(tra_from)，2-唯品会微信小程序链接
sn String   商品货号/商品原编号
tagNames List   商品标签
whiteImage String   商品透明底图
futurePriceMsg String   商品未来价信息
isSubsidyActivityGoods Boolean false 是否为补贴活动商品标识，默认为false
subsidyActivityAmount String   补贴活动奖励金额（单位：元）
subsidyTaskNo String   补贴活动任务编码
couponPriceType Integer   券后价类型：0-否，1-公开券后价，2-隐藏券后价
estimatePrice String   商品预估价格
goodsSoldNumDesc String   商品销量文案(仅2小时榜单和今日榜单会返回)，例如：1万+
productSales String   商品销量1

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "接口调用成功！", "data": { "total": 3250, "goodsInfoList": [ { "marketPrice": "599.00", "commissionRate": "8", "whiteImage": "https://a.vpimg3.com/upload/merchandise/pdcvop/00104218/10004116/2097530231-5408900331663446016-5408900331663450125-30.png", "goodsId": "6920037873415152645", "discount": "0.69", "couponPriceType": 0, "goodsCarouselPictures": [ "https://a.vpimg4.com/upload/merchandise/pdcvis/104218/2022/1024/191/0ed87526-5f54-4cf5-a280-64270aee2894_750x750_75.jpg", "https://a.vpimg4.com/upload/merchandise/pdcvis/104218/2022/1024/26/dec4d084-c087-4c1c-b4f4-bb9b645a022d_750x750_75.jpg", "https://a.vpimg2.com/upload/merchandise/pdcvop/00104218/10004116/933536928-5408900331663446016-5408900331663450125-19_750x750_75.jpg" ], "goodsDetailPictures": [ "https://a.vpimg4.com/upload/merchandise/pdcvop/00104218/10004116/859527222-5408900331663446016-601.jpg", "https://a.vpimg2.com/upload/merchandise/pdcvop/00104218/10004116/951482209-5408900331663446016-602.jpg", "https://a.vpimg2.com/upload/merchandise/pdcvop/00104218/10004116/660612040-5408900331663446016-603.jpg", "https://a.vpimg3.com/upload/merchandise/pdcvop/00104218/10004116/792965662-5408900331663446016-604.jpg", "https://a.vpimg2.com/upload/merchandise/pdcvis/104218/2022/1024/23/5c43f3ac-5081-47af-8c3a-3908f8ded14b.jpg", "https://a.vpimg2.com/upload/merchandise/pdcvop/00104218/10004116/1888376429-5408900331663446016-625.jpg" ], "categoryName": "女式羽绒服", "haiTao": 0, "cat2ndName": "女上装", "isSubsidyActivityGoods": false, "cat1stName": "女装", "vipPrice": "209.00", "commission": "16.72", "productSales": "10万+", "sn": "102721113002-1306", "cat1stId": 311, "goodsName": "森马羽绒服女中长款2022冬新款工装仿狐狸毛毛领宽松外套个性", "brandName": "森马", "brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/LOGO/10004116/2c20b3d6ac3a4238820c7db662cc723b/primary.png", "brandStoreSn": "10004116", "sellTimeFrom": 1537845115000, "schemeStartTime": 1671762264000, "schemeEndTime": 2145888000000, "sourceType": 0, "sellTimeTo": 1735660800000, "brandId": 1710613157, "goodsThumbUrl": "https://a.vpimg2.com/upload/merchandise/pdcvis/104218/2022/1024/191/0ed87526-5f54-4cf5-a280-64270aee2894_750x750_50.jpg", "cat2ndId": 312, "spuId": "SPU-11D35528800001FF", "storeInfo": { "storeName": "唯品自营", "storeId": "ST00000" }, "estimatePrice": "", "goodsMainPicture": "https://a.vpimg2.com/upload/merchandise/pdcvis/104218/2022/1024/191/0ed87526-5f54-4cf5-a280-64270aee2894.jpg", "destUrl": "https://m.vip.com/product-1710613157-6920037873415152645.html", "categoryId": 390562, "status": 1 } ], "pageSize": 20, "sortFields": [ { "fieldName": "PRICE", "fieldDesc": "价格排序" }, { "fieldName": "DISCOUNT", "fieldDesc": "折扣排序" }, { "fieldName": "SALES", "fieldDesc": "销量排序" }, { "fieldName": "COMMISSION_RATE", "fieldDesc": "佣金比例排序" }, { "fieldName": "COMMISSION", "fieldDesc": "佣金排序" } ], "page": 1 }, "request_id": "BZaiCTy" }

错误码

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

在线
客服

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

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部