此接口的返回数据的字段可参考:http://www.ecapi.cn/index/index/openapi/id/191.shtml?ptype=5,数据一致,这里不再列出
参数 | 类型 | 请求参数参考值 | 是否必须 | 说明 |
apkey | String | xxxxxxx | 是 | 用户中心 - 系统设置 - 平台设置 中查看APKEY密钥 (点我获取)(*必要) |
keyword | String | 毛衣 | 是 | 关键词 |
fieldName | String | 排序字段 | ||
key | String | Vxxxxxxx | 是 | 唯品会授权账号调用key,可在会员中心“唯品会授权列表”页获取,为V开头的字符串 |
order | Number | 1 | 排序顺序:0-正序,1-逆序,默认正序 | |
page | Number | 1 | 是 | 页码 |
pageSize | Number | 20 | 页面大小:默认20,最大50 | |
priceStart | String | 价格区间---start | ||
priceEnd | String | 价格区间---end | ||
queryReputation | String | false | 是否查询商品评价信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询,影响接口性能 | |
queryStoreServiceCapability | String | false | 是否查询店铺服务能力信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询,影响接口性能 | |
queryStock | String | false | 是否查询库存:默认不查询 | |
queryActivity | String | false | 是否查询商品活动信息:默认不查询 | |
queryPrepay | String | false | 是否查询商品预付信息:默认不查询 | |
plat | String | 用户平台:1-PC,2-APP,3-小程序,不传默认为APP | ||
deviceType | String | 设备号类型:IMEI,IDFA,OAID,有则传入 | ||
deviceValue | String | 设备号MD5加密后的值,有则传入 | ||
ip | String | 用户ip地址 | ||
longitude | String | 经度 如:29.590961456298828 | ||
latitude | String | 纬度 如:106.51573181152344 | ||
chanTag | String | xxx | 是 | 1、chanTag=pid,即推广位标识 (必传),用来标记推广中的某个资源位,比如APP的banner、icon等(不能含有特殊字符,仅限字母、数字、下划线, 长度最大64) 2、如果没有广告位 则传默认广告位标识: default_pid |
queryExclusiveCoupon | String | true | 是否查询专属红包信息:默认不查询 | |
openId | String | xxx | 是 | 1、渠道用户在渠道侧的用户唯一标识(必传)(如已接入sdk,该值为渠道用户授权绑定唯品会账号的标识 ,如没接入sdk,该值为渠道用户在渠道侧的用户唯一标识) 2、不能含有特殊字符,仅限字母、数字、下划线, 长度最大32,用于识别用户并给用户返利分佣(非常重要!传错影响给用户返利分佣) 3、如果当前调用与用户无关 比如后台job触发拉取商品 则传默认标识:default_open_id 4、调转链接口与商品接口时,同一用户openId传参需要一致 5、订单里面会带上转链时所传的openId信息 |
realCall | String | xxxx | 是 | 1、是否实时调用(必传),true:由用户实时触发的请求,实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false:不是由用户实时触发 2、由渠道后台job触发的请求,比如渠道后台job定期调联盟接口拉取商品到渠道自己的库,请按实际情况传该参数 |
返回参数 | 类型 | 参数说明 | 扩展说明 |
{"code":200,"data":{"total":51553,"list":[{"marketPrice":"489.00","commissionRate":"8","goodsId":"6918527454878745046","discount":"0.16","categoryName":"女式毛衣~尚未启用","cat2ndName":"女上装","cat1stName":"女装","vipPrice":"76.00","commission":"6.08","cat1stId":311,"goodsName":"秋冬新款蝴蝶结套头休闲宽松毛衣女打底外穿慵懒风半高领女式毛衣","brandName":"傲立","brandLogoFull":"http://a.vpimg3.com/upload/brandcool/0/9e5e831aecd44d979f9a723f4d3ebecc/10031912/primary.png","brandStoreSn":"10031912","sellTimeFrom":1537940911000,"schemeStartTime":1582178723000,"schemeEndTime":2145888000000,"sourceType":0,"sellTimeTo":1735660800000,"brandId":1710615350,"goodsThumbUrl":"https://a.vpimg4.com/upload/merchandise/pdcvis/612262/2019/1120/126/12d385a4-ca3e-411e-b194-3199b184fb4d_750x750_50.jpg","cat2ndId":312,"storeInfo":{"storeName":"唯品自营","storeId":"ST00000"},"goodsMainPicture":"https://a.vpimg3.com/upload/merchandise/pdcvis/612262/2019/1120/126/12d385a4-ca3e-411e-b194-3199b184fb4d.jpg","destUrl":"https://m.vip.com/product-1710615350-6918527454878745046.html","categoryId":390559,"status":1}]},"msg":"success"}
code/http_status | 说明 |
200 | 数据获取成功 |
-1 | 数据获取失败 |
401 | IP没有添加白名单 |
429 | 访问次数超限 |
403 | 关键参数丢失 |
405 | 请求方式不对 |