参数名称 | 类型 | 是否必填 | 参数描述 | 备注 |
---|---|---|---|---|
api_key | String | 是 | 系统分配的ApiKey | |
api_target | String | 是 | 调用接口名称 | com_cmall_familyhas_api_ApiHomeColumnNew |
api_input | String | 是 | 输入参数 | 应用输入参数的JSON格式 |
参数名称 | 类型 | 必填 | 示例 | 参数描述 | 备注 |
---|---|---|---|---|---|
sysDateTime | String | 否 | 2015-03-10 22:22:22 | 当前时间 | |
buyerType | String | 否 | 4497469400050001:内购会员,4497469400050002:注册会员 | 用户类型 | 4497469400050002 |
navCode | String | 否 | 449716040037 推荐 | 导航项编码 | 编码从首页导航栏接口获取 |
yuLan_time_point | String | 否 | 时间节点 | 预览专用 | |
viewType | String | 否 | 4497471600100001:APP首页,4497471600100002:Wap商城首页,4497471600100003:Web商城首页 | 展示平台 | 默认为app首页 |
version | int | 否 | 版本号 | 仅用于扩展,无需传入 | |
yuLan_column_type | String | 否 | 栏目类型 | 预览专用 | |
picType | String | 否 | 图片格式 | jpg | |
yuLan_navCode | String | 否 | 预览的导航项编码 | 预览专用 | |
maxWidth | String | 否 | 图片最大宽度 | ||
yuLan_column_name | String | 否 | 栏目名称 | 预览专用 | |
isPurchase | Integer | 否 | 是否显示内购 | 默认值为0,显示内购活动传递1 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
sysTime | String | 服务器时间 | |
maybeLove | String | 猜你喜欢栏目显示控制 | 4497480100020001 显示,4497480100020002 隐藏 |
resultCode | int | 返回标记 | 如果返回标记1则为API调用成功 否则则是错误编号 |
navCode | String | 导航项编码 | 编码从首页导航栏接口获取 |
resultMessage | String | 返回消息 | 返回的消息描述 |
columnList | HomeColumn[] | 其他栏目List |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
sellPrice | String | 销售价 | |
labelsPic | String | 商品标签对应的图片地址 | |
tvTips | String | 直播商品促销语 | |
mainpicUrl | String | 图片 | |
allSkuRealStock | int | sku关联商品下的所有sku实际库存 | |
proClassifyTag | String | 添加商品分类(LD商品,普通商品,跨境商品,跨境直邮,平台入驻,缤纷商品)标签字段 | |
product_first_id | String | 商品一级分类编号 | 商品一级分类编号 |
eventType | String | 活动编号 | 当活动编号为4497472600010018(会员日折扣)/4497472600010030(打折促销)时,取discount字段显示;当为4497472600010024拼团活动时,取saveValue做拼团标签显示;其他值时按其他活动取saveValue显示 |
couponValue | String | 分销券优惠面额 | |
labelsInfo | PlusModelProductLabel[] | 商品标签详细信息 | |
adPicUrl | String | 广告图 | |
evaluationContent | String | 558商品评价封面评价内容 | |
saveValue | String | 活动节省 | |
labelsList | String[] | 商品标签 | 3.9.2已作废 |
productStatus | String | 商品状态 | 4497153900060002:上架 |
product_second | String | 商品二级分类名称 | 商品二级分类名称 |
product_third | String | 商品三级分类名称 | 商品三级分类名称 |
salesNums | int | 商品销量 (虚拟销量+真实销量) | |
highPraiseRate | String | 好评率 | |
flagTheSea | String | 是否海外购 | 0:否,1:是 |
productCode | String | 商品编号 | |
videoAd | String | 广告语 | 栏目类型为视频直播模板时此字段有效:4497471600010020 |
skuName | String | 默认SKU名称 | 默认SKU名称 |
hostNames | String | 关联主持人 | 多个主持人逗号分隔 |
skuCode | String | 默认SKU编号 | 默认SKU编号 |
discount | String | 折扣 | |
isActivity | String | 是否活动价 | 栏目类型为视频直播模板时此字段有效:4497471600010020 |
tagForImg | ImgAd[] | 图文标签 | 138天历史最低价 |
tagInfoList | TagInfo[] | 带样式的商品活动标签 | |
product_third_id | String | 商品三级分类编号 | 商品三级分类编号 |
markPrice | String | 市场价 | |
tagList | String[] | 标签集合 | 秒杀、闪购、拼团、特价、会员日、满减、赠品(最多展示三个) |
product_second_id | String | 商品二级分类编号 | 商品二级分类编号 |
rt_showType | String | 首页右两栏商品前端展示模式 | 4497471600830001:不显示,4497471600830002:商品价格,4497471600830003:商品名称 |
productName | String | 商品名称 | |
product_first | String | 商品一级分类名称 | 商品一级分类名称 |
playStatus | int | 直播状态 | 0表示已播,1表示正在直播,2表示未直播 |
memberLevel | String | 等级名称 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
manyCollage | String | 几人团 | 示例:2人团 |
shareTitle | String | 分享标题 | |
shareLink | String | 分享链接 | |
descriptionColor | String | 描述颜色 | |
endTime | String | 结束时间 | |
shareContent | String | 分享内容 | |
startTime | String | 开始时间 | |
title | String | 标题 | |
showmoreLinkvalue | String | 链接值 | |
videoUrlTV | String | TV直播链接 | 栏目类型为TV直播时此字段有效:4497471600010010、4497471600010040 |
activityPnm | String | 活动PNM码 | |
posion | int | 位置 | |
formId | String | TV节目id | TV节目id |
description | String | 描述 | |
ygActivityName | String | 活动名称 | |
contentList | HomeColumnContent[] | 内容List | |
showmoreLinktype | String | 链接类型 | 4497471600020001:URL 4497471600020002:关键词搜索4497471600020003:分类搜索 4497471600020004:商品详情 4497471600020005:显示浮层 4497471600020006: 抽奖 4497471600020016: 抽奖 4497471600020017: 抽奖 |
picHeight | int | 图片高度 | 栏目类型为一栏广告或轮播广告时生效时此字段有效:4497471600010002,4497471600010001 |
collageType | String | 拼团类型 | 拼团类型:(4497473400050001:普通团,4497473400050002:邀新团) |
picUrl | String | TV直播封面图片 | 栏目类型为TV直播时此字段有效:4497471600010010、4497471600010040 |
columnCode | String | 栏目编号 | COL150316100001 |
isLoot | String | 是否抢光 | 449746250001:是,449746250002:否 |
categoryCode | String | 分类编号 | 针对跳转为商品列表类型,搜索为关键字‘分类名称’,再加上分类编号作为优化补充 |
videoLink | String | 封面商品视频链接 | 栏目类型为视频直播模板时此字段有效:4497471600010020 |
picOriginHeight | int | 图片高度 | 栏目类型为两栏或多栏广告或左两栏、右两栏推荐时此字段有效;558商品评价封面图高度 |
productInfo | HomeColumnContentProductInfo | 商品信息 | 链接类型为“商品详情:4497471600020004”此字段有效 |
sharePic | String | 分享图片 | |
titleColor | String | 标题颜色 | |
rateOfProgress | String | 活动商品进行的进度 | 目前参与进度显示的商品活动有 拼团列表,秒杀列表,闪购列表 |
picture | String | 图片地址;558商品评价封面图地址 | |
playbackUrl | String | 视频回放链接 | |
floorModel | String | 楼层模板 | |
picOriginWidth | int | 图片宽度 | 栏目类型为两栏或多栏广告或左两栏、右两栏推荐时此字段有效;558商品评价封面图宽度 |
isShare | String | 是否分享 | 链接类型为“URL”此字段有效; 449746250001:是 449746250002:否 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
updateTime | String | 更新时间 | |
width | long | 商品列表图片宽 | |
eventLabelPicSkip | String | 活动图片跳转链接 | 396需求 活动图片跳转链接 |
labelPosition | String | 标签自定义位置 | 449748430001.左上 449748430005.通栏下 |
endTime | String | 结束时间 | |
flagEnable | Integer | 是否可用 | 1:可用,0:不可用 |
startTime | String | 开始时间 | |
height | long | 商品列表图片高 | |
listPic | String | 商品列表图片 | |
excludeLive | String | 排除直播品 | 449747110002 是 449747110001 否 |
infoPic | String | 商品详情图片 | |
infoActivityPic | String | 商品详情活动标签 | 接口返回eventLabelPic 396需求 活动图片,比如618活动的横条 |
labelName | String | 标签名称 | |
labelCode | String | 标签编号 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
title | String | 标题 | |
descText | String | 描述标题 | |
recoCode | String | 推荐编码 | 导航编码 |
posion | int | 位置 | |
maybeLove | String | 是否猜你喜欢 | 4497480100020001:是,4497480100020002:否,如果为猜你喜欢,导航下商品数据访问原猜你喜欢接口,如果为其他,访问接口com_cmall_familyhas_api_ApiForRecommendProduct,入参为该实体下recoCode |
参数名称 | 类型 | 参数描述 | 备注 |
---|
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
ccvid | String | 视频id | CC视频id |
videoSource | String | 视频来源 | 01:CC,02:腾讯 |
video_url | String | 腾讯云短视频url | video视频url |
evaluationImgUrl | String | 评价图片 | |
video_code | String | 腾讯云短视频id | video视频id |
isVideo | String | 是否是视频 | 0否1是 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
playbackUrl | String | 视频回放链接 | |
productMainPic | String | 商品主图 | |
productCode | String | 商品编号 | |
formId | String | TV节目id | TV节目id |
beginTime | String | 节目开始时间,例:2021-03-26 14:50:09 | |
productName | String | 商品名称 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
showmoreTitle | String | ‘显示更多’标题 | 显示更多时此字段有效 |
columnType | String | 栏目类型 | 4497471600010001:轮播广告 4497471600010002:一栏广告 4497471600010003:二栏广告 4497471600010004:导航栏 4497471600010005:一栏推荐 4497471600010006:右两栏推荐 4497471600010007:左两栏推荐 4497471600010008:商品推荐 4497471600010009:两栏多行推荐 4497471600010010:TV直播 4497471600010011:闪购 4497471600010012:通知模板 4497471600010013:三栏两行推荐 4497471600010014:两栏两行推荐 4497471600010015:楼层模板 4497471600010022:秒杀模板 4497471600010027:商品评价 4497471600010028:分销模板 4497471600010029:买家秀列表 449748590001:买家秀入口样式一 449748590002:买家秀入口样式二 4497471600010034:拼团大图样式 4497471600010039:推荐导航4497471600010040:右栏TV直播 |
numLan | String | 多栏广告栏数 | 多栏广告栏数,多栏广告此字段有效;4497471600360001-4497471600360004依次为一栏-四栏, |
endTime | String | 结束时间 | |
startTime | String | 开始时间 | |
total_integral | String | 评价+晒单可以获得的总积分 | 如果有待评价或者待晒单的订单,计算可获得积分总和 |
showmoreLinkvalue | String | ‘显示更多’链接值 | 显示更多时此字段有效 |
buyerShowIcon | String | 买家秀图标 | 买家秀入口样式2返回 |
activityPnm | String | 活动PNM码 | |
rightTwoProductForContent | HomeColumnContent[] | 右两栏商品List | 小程序需要该字段与contentList内部字段一致 |
showName | String | 是否显示栏目名称 | 449746250001:是,449746250002:否 |
hasEdgeDistance | String | 是否保留边距 | 4497479100010001:否;4497479100010002:是 |
ygActivityName | String | 活动名称 | |
noticeMessage | String | 消息模板内容 | |
contentList | HomeColumnContent[] | 内容List | |
columnName | String | 栏目名称 | |
beforeTowProduct | ProductInfo[] | 上两档商品 | |
guessLikeOrEvaluation | String | 区分猜你喜欢还是商品评价 | 猜你喜欢:4497471600590001;商品评价:4497471600590002 |
canEvaluateMainpic | String | 可评价晒单的商品主图 | 如果有待评价或者待晒单的订单,去最新订单商品图 |
buyerShowAvatarList | String[] | 买家秀的用户头像List | 买家秀入口样式2返回使用 |
buyerShowList | BuyerShow[] | 买家秀列表List | 买家秀列表模板/买家秀入口样式1 共用 |
showmoreLinktype | String | ‘显示更多’链接类型 | 显示更多时此字段有效; 4497471600020001:URL 4497471600020002:关键词搜索 4497471600020003:分类搜索 4497471600020004:商品详情 4497471600020009:拼团列表4497471600020010:秒杀列表(544新增)4497471600020015:拼团大图(564新增)需要做版本兼容,564以下版本,替换成拼团列表 |
columnBgpic | PicInfo | 模版背景图 | 栏目类型为导航栏与右栏TV直播魔板时时此字段有效:4497471600010004/4497471600010040 |
ifShowLiveInteractionFlag | String | 视频模板是否开启直播互动标识 | 0:不开启,1:开启 |
futureProgram | String | 未开始的TV节目档数 | 栏目类型为TV直播滑动时此字段有效:4497471600010016 |
columnNameColor | String | 栏目名称颜色 | |
categoryCode | String | 分类编号 | 针对跳转为商品列表类型,搜索为关键字‘分类名称’,再加上分类编号作为优化补充 |
isDisplayAfterLogin | String | 登录后是否显示,0否1是 | |
intervalSecond | int | 轮播间隔 | 单位:秒,栏目类型为通知栏时此字段有效:4497471600010012 |
isRemind | String | 是否显示评价或晒单送积分顶部悬浮提醒框 | 有待评价或者待晒单的订单则显示提醒框:0否1是 |
isShowmore | String | 是否显示更多 | 链接类型为“URL”此字段有效; 449746250001:是 449746250002:否 |
columnsPerRow | String | 功能圈每行显示个数 | 4497480100030001:一行4栏,4497480100030002:一行5栏 |
sysTime | String | 服务器时间 | |
pageType | String | 页面类型 | 0:首页,1:TV页 |
tagType | String | 评价中心标签 | 1 待评价、2 待晒单 、 3 已评价 |
homePositionLinkType | String | 首页定位栏目链接类型 | 商品评价:4497471600580001 |
recommendColumnList | RecommendColumn[] | 推荐导航List | |
beforeTwoProductForContent | HomeColumnContent[] | 上两档商品List | 小程序需要该字段与contentList内部字段一致 |
columnID | String | 栏目ID | |
columnTypeName | String | 栏目名称 | |
totalPage | int | 买家秀内容分页总页码 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
picNewUrl | String | 现图片地址 | |
height | Integer | 图片高度 | |
width | Integer | 图片宽度 | |
picOldUrl | String | 原图片地址 | |
oldWidth | Integer | 原图片宽度 | |
originWidth | int | 数据库中图片宽度 | |
oldHeight | Integer | 原图片高度 | |
originHeight | int | 数据库中图片高度 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
sellPrice | String | 销售价 | |
productCode | String | 商品编号 | |
manyCollage | String | 几人团 | 示例:2人团 |
markPrice | String | 市场价 | |
mainpicUrl | String | 图片 | |
proClassifyTag | String | 添加商品分类(LD商品,普通商品,跨境商品,跨境直邮,平台入驻,缤纷商品)标签字段 | |
tagList | String[] | 标签集合 | 秒杀、闪购、拼团、特价、会员日、满减、赠品(最多展示三个) |
labelsInfo | PlusModelProductLabel[] | 商品标签详细信息 | |
productName | String | 商品名称 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
imgUrl | String | 图片地址 | https://tupian.jpg |
type | String | 标签类型 | 暂时无用,后续拓展使用 |
ads | String | 广告语 | 138天历史最低价 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
buyerShowMoney | String | 买家秀收益 | |
isFollow | String | 当前用户是否关注 | 0 否 ; 1 是 |
createTime | String | 评论发表时间 | |
nickname | String | 晒单人昵称 | |
buyerShowUid | String | 买家秀uid | |
avatar | String | 晒单人头像 | |
isApprove | String | 当前用户是否点赞 | 0 否 ; 1 是 |
sortNum | int | 是否置顶 | 0:未置顶; 非0:置顶 |
prodPicUrl | String | 商品图片 | 主要供买家秀入口样式1使用 |
approveNum | String | 买家秀点赞量 | |
orderAssessment | String | 晒单内容 | |
readNum | String | 买家秀阅读量 | |
evaProductList | EvaProduct[] | 短视频推荐商品信息 | |
evaluationImgList | EvaluationImg[] | 买家秀图片或者视频list | |
evaProduct | EvaProduct | 买家秀商品信息 | |
evaluationNum | String | 买家秀评价量 | |
memberCode | String | 晒单人编号 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
style | String | 标签样式 | 0: 默认样式、1: 橙意会员卡样式、2:立省样式(右栏TV直播需要样式) |
name | String | 标签名称 | 秒杀、闪购、会员日 |