接口使用场景等说明:本接口用于查询唯品会联盟猜你喜欢商品列表。暂不支持排序 。
注:返回授权用户的商品列表信息最多返回40条 ,也有可能算法可能无推荐商品,因此数据可能为空,请做好判断。
环境 | http 地址 | https 地址 |
---|---|---|
正式环境 | http://api.veapi.cn/vip/vip_userecommend | 暂无 |
参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
page | Integer | 否 | 1 | 分页页码:从1开始 |
pageSize | Integer | 否 | 20 | 分页大小:默认20 |
inStock | Integer | 否 | 是否有货 1:有货、 0:无货 ,默认1 | |
goodsSaleStats | Integer | 否 | 1 | 商品售卖状态 默认1(在售), 2(预热), 3(在售+预热) |
offlineStore | Integer | 否 | 1 | 筛选线下店商品:1只返线下店,0或者不传只返回特卖会 |
plat | Integer | 否 | 1 | 用户平台:1-PC,2-APP,3-小程序,不传默认为APP |
deviceType | String | 否 | 设备号类型:IMEI,IDFA,OAID,有则传入 | |
deviceValue | String | 否 | 设备号MD5加密后的值,有则传入,IDFA大写后md5,IMER小写后md5,OAID原文md5 | |
ip | String | 否 | 用户ip地址 | |
longitude | String | 否 | 29.590961456298828 | 经度 |
latitude | String | 否 | 106.51573181152344 | 纬度 |
warehouse | String | 否 | 分仓 :VIP_NH:广州仓,VIP_SH:上海仓, VIP_BJ:北京仓,VIP_CD:成都仓, VIP_HZ:华中仓, ALL:全国仓 | |
chanTag | String | 否 | 自定义渠道标识 | |
queryCpsInfo | Integer | 否 | 是否返回cps链接:0-不查询,1-tra_from参数,2-小程序链接,默认为0,查询多个时按照位运算处理,例如:3表示查询tra_from参数+小程序链接 | |
queryFuturePrice | Boolean | 否 | 是否查询未来价信息:默认不查询 | |
openId | String | 否 | 556599542235 | 自定义的标记渠道用户在渠道侧的用户唯一标识(必传)(如已接入sdk,该值为渠道用户授权绑定唯品会账号的标识,如没接入sdk,该值为渠道用户在渠道侧的用户唯一标识)不能含有特殊字符,仅限字母、数字、下划线,长度最大32,用于识别用户并给用户返利分佣(非常重要!传错影响给用户返利分佣)如果当前调用与用户无关,比如后台job触发拉取商品,则传默认标识:default_open_id (转链接口不论是否实时调用都必须传实际的 open_id)。调转链接口与商品接口时,同一用户openId传参需要一致订单里面会带上转链时所传的openId信息。 |
realCall | Boolean | 否 | false | 2023.7.1后新增的参数:是否实时调用,true:由用户实时触发的请求,实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false:不是由用户实时触发,由渠道后台job触发的请求,比如渠道后台job定期调联盟接口拉取商品到渠道自己的库,请按实际情况传该参数。 |
GET/POST http://api.veapi.cn/vip/vip_userecommend?vekey=xxx&plat=2
$api="http://api.veapi.cn/vip/vip_userecommend?vekey=xxx&plat=2"; $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_userecommend?vekey=xxx&plat=2"; // 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_userecommend?vekey=xxx&plat=2" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
参数名称 | 参数类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 否 | 店铺信息 | |
commentsInfo | Goodscommentsinfo | 否 | 商品评价信息 | |
storeServiceCapability | Storeservicecapability | 否 | 商品所属店铺服务能力评价 | |
brandId | Long | 否 | 商品所属档期(专场)id | |
schemeStartTime | Long | 否 | 商品所属推广方案开始时间:时间戳,单位:毫秒 | |
saleStockStatus | Integer | 否 | 商品库存状态:1-已抢光,2-有库存,3-有机会,当列表查询库存或者查询商品详情时返回 | |
status | Integer | 否 | 商品状态:0-下架,1-上架 | |
prepayInfo | Prepayinfo | 否 | 商品预付信息 | |
└─ 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 | 否 | 结束时间:时间戳,单位毫秒 | |
couponInfo | Pmscouponinfo | 否 | 红包信息 | |
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 | List | 否 | 对应sku信息 | |
└─ sizeId | String | 否 | 商品尺码id(唯品会体系下和skuId等同) | |
└─ saleProps | Map | 否 | 售卖属性信息(134 - 颜色,453 - 尺码) | |
└─ leavingStock | Integer | 否 | 剩余库存:查询库存时返回 | |
└─ saleStockStatus | Integer | 否 | 商品库存状态:1-已抢光,2-有库存,3-有机会 | |
└─ vipPrice | String | 否 | 唯品价:单位元 | |
└─ marketPrice | String | 否 | 市场价:单位元 | |
exclusiveCoupon | Map | 否 | 渠道专属红包:目前仅开放单品券,没有则返回空 | |
└─ couponNo | String | 否 | 优惠券批次号 | |
└─ couponName | String | 否 | 优惠劵名称 | |
└─ fav | String | 否 | 优惠金额:单位-元,查询详情时返回 | |
└─ buy | String | 否 | 使用门槛:单位-元,查询详情时返回 | |
└─ activateBeginTime | Long | 否 | 券激活开始时间,毫秒级时间戳 | |
└─ activateEndTime | Long | 否 | 券激活结束时间,毫秒级时间戳 | |
└─ useBeginTime | Long | 否 | 使用开始时间,毫秒级时间戳 | |
└─ useEndTime | Long | 否 | 使用结束时间,毫秒级时间戳 | |
└─ totalAmount | Long | 否 | 生成劵的总量:查询详情时返回 | |
└─ activedAmount | Long | 否 | 劵已激活的数量:查询详情时返回 | |
└─ receiveUrl | String | 否 | 专属领券页地址 | |
cpsInfo | Map |
否 | cps推广信息:目前只返回小程序链接和通用追踪参数,其他链接请移步转链接口,1-通用推广参数(tra_from),2-唯品会微信小程序链接 | |
sn | String | 否 | 商品货号/商品原编号 | |
tagNames | List |
否 | 商品标签 | |
whiteImage | String | 否 | 商品透明底图 | |
futurePriceMsg | String | 否 | 商品未来价信息 | |
isSubsidyActivityGoods | Boolean | 是 | 是否为补贴活动商品标识,默认为false | |
subsidyActivityAmount | String | 否 | 补贴活动奖励金额(单位:元) | |
subsidyTaskNo | String | 否 | 补贴活动任务编码 | |
couponPriceType | Integer | 否 | 券后价类型:0-否,1-公开券后价,2-隐藏券后价 | |
estimatePrice | String | 否 | 商品预估价格 | |
goodsSoldNumDesc | String | 否 | 商品销量文案(仅2小时榜单和今日榜单会返回),例如:1万+ | |
productSales | String | 否 | 商品销量 |
{ "error": "0", "msg": "接口调用成功!", "data": { "goodsInfoList": [ { "marketPrice": "420.00", "commissionRate": "1", "goodsId": "6917940288052200145", "discount": "0.54", "couponPriceType": 0, "categoryName": "爽肤水", "haiTao": 1, "cat2ndName": "面部护理", "isSubsidyActivityGoods": false, "cat1stName": "美容护肤", "vipPrice": "199.00", "commission": "1.99", "productSales": "10万+", "sn": "3147758030297", "cat1stId": 1012, "goodsName": "兰蔻 大粉水清滢柔肤水400ml 保湿爽肤 多个版本随机发货", "brandName": "Lancome", "brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/6a113b5768d149cea48444bc5c2a05e6/10000521/primary.png", "brandStoreSn": "10000521", "sellTimeFrom": 1538940602000, "schemeStartTime": 1635510695000, "schemeEndTime": 2517544800000, "goodsSoldNumDesc": "", "sourceType": 0, "sellTimeTo": 1735660800000, "brandId": 1710620913, "goodsThumbUrl": "https://a.vpimg2.com/upload/merchandise/pdcvis/2022/10/15/134/22005d16-9559-476b-8dea-f811caf9b68f_750x750_50.jpg", "cat2ndId": 1014, "spuId": "SPU-02EC140A808006EF", "storeInfo": { "storeName": "唯品自营", "storeId": "ST00000" }, "estimatePrice": "", "goodsMainPicture": "https://a.vpimg4.com/upload/merchandise/pdcvis/2022/10/15/134/22005d16-9559-476b-8dea-f811caf9b68f.jpg", "destUrl": "https://m.vip.com/product-1710620913-6917940288052200145.html", "categoryId": 390657, "status": 1 } ], "pageSize": 20, "page": 1 }, "request_id": "RfcnkH4" }