唯品会关键词商品查询接口
需要授权
1122人使用

根据关键字查询商品列表,支持指定排序字段

如果调用接口出现 user has no union auth,requestId:genByGoodsIdWithOauth

下载“唯享客”app登录即可



接口地址: http://api.tbk.dingdanxia.com/vip/query 在线测试
请求参数、 调用方式 GET/POST

参数接口

参数类型

必填

示例

说明

apikey

string

接口秘钥,请登录后台获取

signature

string

接口签名,查看创建规则,(可在后台开启或关闭,关闭状态可不需要此参数)

keyword

String

女装

关键词

page

Integer

1

页码

pageSize

Integer

20

页面大小:默认20,最大50

fieldName

String

排序字段 价格-PRICE、折扣-DISCOUNT、佣金-COMMISSION、佣金比例-佣金比例、销量-SALES

order

Integer

排序顺序:0-正序,1-逆序,默认正序

priceStart

String

价格区间---start

priceEnd

String

价格区间---end

queryReputation

Boolean

是否查询商品评价信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询,影响接口性能

queryStoreServiceCapability

Boolean

是否查询店铺服务能力信息:默认不查询,该数据在详情页有返回,没有特殊需求,建议不查询,影响接口性能

queryStock

Boolean

是否查询库存:默认不查询

queryActivity

Boolean

是否查询商品活动信息:默认不查询

queryPrepay

Boolean

是否查询商品预付信息:默认不查询

返回参数说明

标记

类型

例子

说明

goodsId

String

商品id

goodsName

String

商品名称

goodsDesc

String

商品描述,字段暂不输出

destUrl

String

商品落地页

goodsThumbUrl

String

商品缩略图

goodsCarouselPictures

List<String>

商品轮播图:根据商品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<String>

商品详情图片:根据商品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

店铺信息

L storeId

String

店铺id

L storeName

String

店铺名称

commentsInfo

GoodsCommentsInfo

商品评价信息

L comments

Integer

商品评论数

L goodCommentsShare

String

商品好评率:百分比,不带百分号

storeServiceCapability

StoreServiceCapability

商品所属店铺服务能力评价

L storeScore

String

店铺评分:保留两位小数

L storeRankRate

String

店铺同品类排名比例:例如10表示前10%

brandId

Long

商品所属档期(专场)id

schemeStartTime

Long

商品所属推广方案开始时间:时间戳,单位:毫秒

saleStockStatus

Integer

商品库存状态:1-已抢光,2-有库存,3-有机会,当列表查询库存或者查询商品详情时返回

status

Integer

商品状态:0-下架,1-上架

prepayInfo

PrepayInfo

商品预付信息

L isPrepay

Integer

是否预付商品:0-否,1-是

L prepayPrice

String

预付到手价:元

L firstAmount

String

预付首款金额:元

L lastAmount

String

预付尾款金额:元

L prepayFavAmount

String

预付优惠金额: 元

L deductionPrice

String

抵扣价格(首款+优惠金额):元

L prepayDiscount

String

预付折扣:(唯品价-优惠金额)/唯品价 保留两位小数的数字字符串

L prepayFirstStartTime

Long

首款支付开始时间:时间戳,单位毫秒

L prepayFirstEndTime

Long

首款支付结束时间:时间戳,单位毫秒

L prepayLastStartTime

Long

尾款支付开始时间:时间戳,单位毫秒

L prepayLastEndTime

Long

尾款支付结束时间:时间戳,单位毫秒

joinedActivities

List<ActivityInfo>

商品参与活动信息:未参与活动集合为空

L actType

Integer

活动类型:18-唯品快抢

L actName

String

活动名称

L beginTime

Long

开始时间:时间戳,单位毫秒

L endTime

Long

结束时间:时间戳,单位毫秒

L foreShowBeginTime

Long

预热开始时间:时间戳,单位毫秒

返回示例
{
	"code": 200,
	"msg": "请求成功【success】",
	"total_results": 593376,
	"data": [{
			"marketPrice": "499.00",
			"commissionRate": "8",
			"goodsId": "6918175059064222031",
			"discount": "0.14",
			"categoryName": "女式卫衣~尚未启用",
			"cat2ndName": "女上装",
			"cat1stName": "女装",
			"vipPrice": "68.00",
			"commission": "5.44",
			"cat1stId": 311,
			"goodsName": "春秋新款女式休闲连帽纯色宽松卫衣薄外套上衣",
			"brandName": "huagaa",
			"brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/ea291021b472460e89c1ad09188226f4/10032626/primary.png",
			"brandStoreSn": "10032626",
			"sellTimeFrom": 1538185867000,
			"schemeStartTime": 1582178723000,
			"schemeEndTime": 2145888000000,
			"sourceType": 0,
			"sellTimeTo": 1735660800000,
			"brandId": 1710618799,
			"goodsThumbUrl": "https://a.vpimg2.com/upload/merchandise/pdcvis/612109/2019/1025/75/e32ec32e-3f2a-4796-9eb5-fa31d81ac36f_750x750_50.jpg",
			"cat2ndId": 312,
			"storeInfo": {
				"storeName": "唯品自营",
				"storeId": "ST00000"
			},
			"goodsMainPicture": "https://a.vpimg2.com/upload/merchandise/pdcvis/612109/2019/1025/75/e32ec32e-3f2a-4796-9eb5-fa31d81ac36f.jpg",
			"destUrl": "https://m.vip.com/product-1710618799-6918175059064222031.html",
			"categoryId": 390557,
			"status": 1
		},
		{
			"marketPrice": "599.00",
			"commissionRate": "8",
			"goodsId": "6918134515807663183",
			"discount": "0.11",
			"categoryName": "女式针织衫~尚未启用",
			"cat2ndName": "女上装",
			"cat1stName": "女装",
			"vipPrice": "63.00",
			"commission": "5.04",
			"cat1stId": 311,
			"goodsName": "2019秋装新款女式休闲套头蕾丝拼接方领针织衫薄款打毛衣上衣",
			"brandName": "huagaa",
			"brandLogoFull": "http://a.vpimg3.com/upload/brandcool/0/ea291021b472460e89c1ad09188226f4/10032626/primary.png",
			"brandStoreSn": "10032626",
			"sellTimeFrom": 1538185867000,
			"schemeStartTime": 1582178723000,
			"schemeEndTime": 2145888000000,
			"sourceType": 0,
			"sellTimeTo": 1735660800000,
			"brandId": 1710618799,
			"goodsThumbUrl": "https://a.vpimg2.com/upload/merchandise/pdcvis/612109/2019/0321/116/cc731d0f-592b-4c9a-8536-6e63d641dab4_750x750_50.jpg",
			"cat2ndId": 312,
			"storeInfo": {
				"storeName": "唯品自营",
				"storeId": "ST00000"
			},
			"goodsMainPicture": "https://a.vpimg4.com/upload/merchandise/pdcvis/612109/2019/0321/116/cc731d0f-592b-4c9a-8536-6e63d641dab4.jpg",
			"destUrl": "https://m.vip.com/product-1710618799-6918134515807663183.html",
			"categoryId": 390558,
			"status": 1
		}
	]
}			  
返回错误码说明

错误码

错误描述

解决办法

200

返回成功

-1

数据返回失败

请查看 msg 返回提示

4001

接口秘钥不能为空

请传入接口秘钥

4002

接口秘钥出错

登录后台查看接口秘钥是否一致

4003

参数不正确

请检查参数是否符合文档要求

4004

服务已到期请及时续费

登录后台续费

4005

该接口当日调用量已超限

升级套餐

4006

无权调用该接口

升级套餐

4007

接口不存在

4008

signature不正

查看签名构建规则确保正确无误。

4009

点卡已用完

请登录控制台-服务购买-充值点卡

4010

请购买接口次数包才能调用此接口

需充值次数包

4011

次数包已用完,请重新购买

需充值次数包

4012

请求客户端ip未加入白名单

将ip加入白名单

4013

联盟账号授权已过期

请登录控制台【授权管理】下重新授权您的相关账号

4014

PID异常

请登录控制台【授权管理】-【淘宝授权】,检查您的推广位PID是否填写,或是否填写正确。