帮助与文档

> >
接口名称 调用函数/调用说明 参数说明 params callback数据说明
初始化 var sdk = new shopSDK({key}); key:用户appkey
获取appkey shopSDK.getKey() 返回引入shopSDK.js的appkey
获取产品列表(查询商品列表) sdk.getProducts(params,callback);

params:可为空{};

callback:回调函数,返回根据指定搜索条件

查询到的商品列表

 

参数key 参数类型 参数示例 参数说明 是否必传
  keyWord  String ‘真维斯’ 商品名称关键字/商品关键字/品类名称
minPrice Integer 1 最低价格
maxPrice  Integer 10 最高价格
transportStrategyId Long ’123‘ 配送策略ID
lableList List<Long> [’123‘,’456‘] 标签ID集合
pageSize Integer 20 页码
pageIndex  Integer 1 行数
timeSort  Integer 0 按照时间最早开始查询或最晚时间开始查询:

1表示升序,2表示降序 ,0表示不启用

priceSort Integer 0 按照价格高低排序执行查询 :

1表示升序,2表示降序,0表示不启用

salesSort  Integer 0 按照销量高低执行查询:

1表示升序,2表示降序,0表示不启用

productIds Long [‘123123123’] 产品ID

 

callback数据

key 类型 value示例 说明
productId Long “3456” 产品ID
productName String “针织衫” 产品名称
productSales Integer 400 产品销量
commodityList 商品信息集合
commodityId Long “123456” 商品唯一标识
commoditySales Integer 300 商品销售总量
currentCost Integer 25 商品价格
imgUrl
key 类型 value示例 说明
src String “http://a.png” 照片Url
height integer 100 长度
width integer 200 宽度

 

customProductFields 自字义字段
fieldEnName String “other” 字段名
fieldValue String none 字段值
id Long “123456” 字段ID
productId Long “123456” 字段产品ID

 

 

获取产品详情 getProductDetail(productId,callback);

productId:必传参数

callback:回调函数,返回根据产品Id

查询到的产品信息

参数key 参数类型 参数示例 参数说明 是否必传
productId Long ‘123 3’ 产品ID

 

key 类型 value示例 说明
maxPrice  Integer 10 最高价
minPrice Integer 1 最低价
productId Long “123456” 产品唯一标识
productName String  “毛衣” 产品名称
productSales Integer 100 销售总量
 productAdditionalInfos 产品详情介绍图片
link String “http: “ 详情连接
imgUrl
key 类型 value示例 说明
src String “http” 照片url
height integer 1 长度
width Integer 1 高度

 

 productImgUrls 产品头部滚动图片
imgUrl
key 类型 value示例 说明
src String “http” 照片Url
height integer 1 长度
width Integer 1 宽度

 

 

获取商品详情  getCommodityDetails(productId,callback)

productId:必传参数

callback:回调函数,返回根据产品ID获取

该产品下商品信息(价格、型号、颜色、库存等)

参数key 参数类型 参数示例 参数说明 是否必传
productId Long ‘1233’ 产品Id

 

 

 

 

key 类型 value示例 说明
commodityList
commodityId Long “123456” 商品唯一标识
currentCost Integer 100 商品价格
usableStock Integer 100 库存数量
status Integer 1 库存状态:0表示正常,1表示下架,2表示库存不足
imgUrl
key 类型 value示例 说明
src String “http” 照片Url
height integer 1 长度
width Integer 1 宽度

 

productPropertyList 规格信息汇总
propertyKey String “颜色” 规格属性名称
propertyValues
propertyValue  String  “红色”  规格属性值
 commodityIds List<Long> [“123456”,…..] 规格属性值关联商品ID集合

 

获取配送策略 getTransportStrategy( version,callback)

version:必传参数

callback:回调函数,返回配送策略,用于商品筛选

参数key 参数类型 参数示例 参数说明 是否必传
version Long 123 版本号

 

 

 

 

key 类型 value示例 说明
strategyName String “全局包邮” 策略名称
strategyId Long “12345” 策略Id

 

 

获取产品标签 getLabels(size,callback);

size:必传参数

callback:回调函数,返回产品标签,用于商品筛选

参数key 参数类型 参数示例 参数说明 是否必传
size int 10 展示标签个数

 

 

 

 

key 类型 value示例 说明
labelId Long “12344” 标签Id
laobelName String “秋款” 标签名称

 

 

获取评论列表 getComments( params,callback);

params:必传参数

callback:回调函数,返回产品评论列表

参数key 参数类型 参数示例 参数说明 是否必传
productId Long ”346508“ 产品ID
commentStars Integer 1 1~5 星级,   不传|0 默认全部
level Integer 1 1“好评”(5分);2 “中评”(2-4分);
3 “差评”(1分);
不传|0 默认全部
havePicture Integer 1 1 有图,2 无图,   不传|0 默认全部
pageIndex Integer 1 页码
pageSize Integer 20 页面行数

 

key 类型 value示例 说明
anonymity boolean true 是否匿名
buyerName String  “张三” 买家名称
comment  String  “好产品”  评论内容
commentStars  Integer  1  评论星级
productName  String  “产品”  产品名称
propertyDescribe  String  “红色”  型号名称
commentImgUrls
key 类型 value示例 说明
src String “http” 照片Url
height integer 1 长度
width Integer 1 宽度

 

相关文档