暂无说明
参数 | 类型 | 请求参数参考值 | 是否必须 | 说明 |
apkey | String | xxxxxxx | 是 | 用户中心 - 系统设置 - 平台设置 中查看APKEY密钥 (点我获取)(*必要) |
key | String | Vxxxxxxx | 是 | 唯品会授权账号调用key,可在会员中心“唯品会授权列表”页获取,为V开头的字符串 |
page | Number | 1 | 是 | 页码 |
pageSize | Number | 20 | 分页大小:默认20,最大100 | |
queryReputation | String | false | 是否查询商品评价信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询 | |
queryStoreServiceCapability | String | false | 是否查询店铺服务能力信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询 | |
sourceType | Number | 0 | 请求源类型:0-频道,1-组货 | |
jxCode | String | 精选组货码 | 当请求源类型为组货时必传,精选组货码:http://doc.21ds.cn/index?project_id=4685763267728060&doc_id=4725023554212881 | |
fieldName | String | COMMISSION | 排序字段: COMMISSION-佣金,PRICE-价格,COMM_RATIO-佣金比例,DISCOUNT-折扣 | |
order | Number | 1 | 排序顺序:0-正序,1-逆序,默认正序 | |
queryStock | String | false | 是否查询库存:默认不查询 | |
queryActivity | String | false | 是否查询商品活动信息:默认不查询 | |
queryPrepay | String | false | 是否查询商品预付信息:默认不查询 | |
channelType | String | 0 | 频道类型:0-超高佣,1-出单爆款; 当请求类型为频道时必传 | |
chanTag | String | 是 | 1、chanTag=pid,即推广位标识 (必传),用来标记推广中的某个资源位,比如APP的banner、icon等(不能含有特殊字符,仅限字母、数字、下划线, 长度最大64) 2、如果没有广告位 则传默认广告位标识: default_pid | |
openId | String | 是 | 1、渠道用户在渠道侧的用户唯一标识(必传)(如已接入sdk,该值为渠道用户授权绑定唯品会账号的标识 ,如没接入sdk,该值为渠道用户在渠道侧的用户唯一标识) 2、不能含有特殊字符,仅限字母、数字、下划线, 长度最大32,用于识别用户并给用户返利分佣(非常重要!传错影响给用户返利分佣) 3、如果当前调用与用户无关 比如后台job触发拉取商品 则传默认标识:default_open_id 4、调转链接口与商品接口时,同一用户openId传参需要一致 5、订单里面会带上转链时所传的openId信息 | |
realCall | String | 是 | 1、是否实时调用(必传),true:由用户实时触发的请求,实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false:不是由用户实时触发 2、由渠道后台job触发的请求,比如渠道后台job定期调联盟接口拉取商品到渠道自己的库,请按实际情况传该参数 |
返回参数 | 类型 | 参数说明 | 扩展说明 |
data | Json | 返回数据列表 | |
├ total | Number | 商品总数 | |
├ list | Json | 商品列表 | |
├ ├ goodsId | String | 商品id | |
├ ├ goodsName | String | 商品名称 | |
├ ├ goodsDesc | String | 商品描述,字段暂不输出 | |
├ ├ destUrl | String | 商品落地页 | |
├ ├ goodsThumbUrl | String | 商品缩略图 | |
├ ├ goodsCarouselPictures | Json | 商品轮播图 | 根据商品id查询时返回,商品列表不返回 |
├ ├ goodsMainPicture | String | 商品主图 | |
├ ├ categoryId | Number | 商品三级分类id | |
├ ├ categoryName | String | 商品三级分类 | |
├ ├ sourceType | Number | 商品类型 | 0-自营,1-MP |
├ ├ marketPrice | String | 市场价(元) | |
├ ├ vipPrice | String | 唯品价(元) | |
├ ├ commissionRate | String | 佣金比例(%) | |
├ ├ commission | String | 佣金金额(元) | |
├ ├ discount | String | 折扣 | 唯品价/市场价 保留两位小数字符串 |
├ ├ goodsDetailPictures | Json | 商品详情图片:根据商品id查询商品信息时返回,商品列表不返回 | |
├ ├ cat1stId | Number | 商品一级分类id | |
├ ├ cat1stName | String | 商品一级分类名称 | |
├ ├ cat2ndId | Number | 商品二级分类id | |
├ ├ cat2ndName | String | 商品二级分类名称 | |
├ ├ brandStoreSn | String | 商品品牌sn | |
├ ├ brandName | String | 商品品牌名称 | |
├ ├ brandLogoFull | String | 商品品牌logo全路径地址 | |
├ ├ schemeEndTime | Number | 商品推广计划有效期预估截止时间 | 仅为预估时间,仅做参考;时间戳,单位:毫秒 |
├ ├ sellTimeFrom | Number | 商品售卖开始时间,时间戳,单位毫秒 | |
├ ├ sellTimeTo | Number | 商品售卖结束时间,时间戳, 单位毫秒 | |
├ ├ weight | Number | 推广权重,用于确定推广该商品的优先级,权重值越大,优先级越高 | |
├ ├ storeInfo | Json | 店铺信息 | |
├ ├ ├ storeId | String | 店铺id | |
├ ├ ├ storeName | String | 店铺名称 | |
├ ├ commentsInfo | Json | 商品评价信息 | |
├ ├ ├ comments | Number | 商品评论数 | |
├ ├ ├ goodCommentsShare | String | 商品好评率:百分比,不带百分号 | |
├ ├ storeServiceCapability | Json | 商品所属店铺服务能力评价 | |
├ ├ ├ storeScore | String | 店铺评分:保留两位小数 | |
├ ├ ├ storeRankRate | String | 店铺同品类排名比例:例如10表示前10% | |
├ ├ brandId | Number | 商品所属档期(专场)id | |
├ ├ schemeStartTime | Number | 商品所属推广方案开始时间:时间戳,单位:毫秒 | |
├ ├ saleStockStatus | Number | 商品库存状态:1-已抢光,2-有库存,3-有机会,当列表查询库存或者查询商品详情时返回 | |
├ ├ status | Number | 商品状态:0-下架,1-上架 | |
├ ├ prepayInfo | Json | 商品预付信息 | |
├ ├ ├ isPrepay | Number | 是否预付商品:0-否,1-是 | |
├ ├ ├ prepayPrice | String | 预付到手价:元 | |
├ ├ ├ firstAmount | String | 预付首款金额:元 | |
├ ├ ├ lastAmount | String | 预付尾款金额:元 | |
├ ├ ├ prepayFavAmount | String | 预付优惠金额: 元 | |
├ ├ ├ deductionPrice | String | 抵扣价格(首款+优惠金额):元 | |
├ ├ ├ prepayDiscount | String | 预付折扣:(唯品价-优惠金额)/唯品价 保留两位小数的数字字符串 | |
├ ├ ├ prepayFirstStartTime | Number | 首款支付开始时间:时间戳,单位毫秒 | |
├ ├ ├ prepayFirstEndTime | Number | 首款支付结束时间:时间戳,单位毫秒 | |
├ ├ ├ prepayLastStartTime | Number | 尾款支付开始时间:时间戳,单位毫秒 | |
├ ├ ├ prepayLastEndTime | Number | 尾款支付结束时间:时间戳,单位毫秒 | |
├ ├ joinedActivities | Json | 商品参与活动信息:未参与活动集合为空 | |
├ ├ ├ actType | Number | 活动类型:18-唯品快抢 | |
├ ├ ├ actName | String | 活动名称 | |
├ ├ ├ beginTime | Number | 开始时间:时间戳,单位毫秒 | |
├ ├ ├ endTime | Number | 结束时间:时间戳,单位毫秒 | |
├ ├ ├ foreShowBeginTime | Number | 预热开始时间:时间戳,单位毫秒 |
{"code":200,"data":{"total":68,"list":[{"marketPrice":"4299.00","commissionRate":"11","goodsId":"6917918421524918858","discount":"0.25","categoryName":"连衣裙~尚未启用","cat2ndName":"连衣裙/连体裤~尚未启用","cat1stName":"女装","vipPrice":"1069.00","commission":"117.59","cat1stId":311,"goodsName":"女装V领无袖中长连衣裙","brandName":"PORTS","brandLogoFull":"http://a.vpimg3.com/upload/brandcool/0/9ceb303392a24414964d8e86506c28b6/10001327/primary.png","brandStoreSn":"10001327","sellTimeFrom":1537944496000,"schemeStartTime":1584410400000,"schemeEndTime":1584583200000,"sourceType":0,"sellTimeTo":1735660800000,"brandId":1710615498,"goodsThumbUrl":"https://a.vpimg4.com/upload/merchandise/pdcvis/2018/05/23/129/518ac6af-8a5e-4932-84f6-33dba6398df1.jpg","cat2ndId":384263,"storeInfo":{"storeName":"唯品自营","storeId":"ST00000"},"destUrl":"https://m.vip.com/product-1710615498-6917918421524918858.html","categoryId":391033,"status":1}]},"msg":"success"}
code/http_status | 说明 |
200 | 数据获取成功 |
-1 | 数据获取失败 |
401 | IP没有添加白名单 |
429 | 访问次数超限 |
403 | 关键参数丢失 |
405 | 请求方式不对 |