Skip to content

直播间菜单商品列表

请求路径

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://gateway.nuoyunapi.com/Api/Room/getRoomMenuGoods/2.0.0
  • 频率限制:10秒100次

请求参数

参数必选类型描述
room_idinteger直播间ID
uidinteger用户ID
custom_menu_idinteger菜单ID
pageinteger第几页(最小值1)
page_sizeinteger一页显示多少(最小值1,最大值100)
keywordstring搜索关键词
custom_menu_goods_category_idinteger竖屏直播间橱窗字段ID(没有传0)

请求示例

示例1:获取直播间菜单商品列表

json
{
    "room_id": 100001,
    "uid": 10001,
    "custom_menu_id": 1001,
    "custom_menu_goods_category_id": 100,
    "page": 1,
    "page_size": 15
}

示例2:搜索指定关键词的商品

json
{
    "room_id": 100001,
    "uid": 10001,
    "custom_menu_id": 1001,
    "custom_menu_goods_category_id": 0,
    "keyword": "手机",
    "page": 1,
    "page_size": 20
}

响应参数

参数必选类型描述
codeinteger状态码:200-成功,400-失败
msgstring提示信息
dataobject商品数据

data 参数结构

参数必选类型描述
totalinteger商品总量
listarray商品列表

list 参数结构

参数必选类型描述
idinteger商品ID
imgstring商品图片
namestring商品名称
unitstring商品单位
is_skuinteger是否SKU商品 1:是 2:否
pricestring商品价格
lowest_pricestring砍价 - 商品底价
underlined_pricestring划线价
stockinteger库存
custom_menu_idinteger菜单ID
recommendinteger推荐商品 1:是
explaininteger讲解商品 1:是 2:否
heat_numinteger商品讲解热度
is_display_stockinteger显示状态 1:显示;2:隐藏
welfare_activity_idinteger福利购活动id
is_to_store_discountinteger1:到店折扣,2:不是到店折扣
to_store_discount_contentstring到店折扣内容
is_coupon_typeinteger1:优惠券商品 2:不是优惠券商品
is_show_roominteger是否在直播间显示 1显示 2隐藏
sale_typeinteger开售类型 1--立即开售 2--定时开售
sale_timeinteger立即开售时间(时间戳)
sale_time_datestring立即开售时间
sale_statusinteger销售状态 1:关闭 2:开启
seckillinteger秒杀状态。1:关闭;2:开启
seckill_confobject秒杀配置信息
linkTypestring购买方式(text文字链接,pic图片链接,local本地购买,applet小程序购买)
linkstring购买方式链接
linkPicPathstring购买方式链接(图片)
applet_buy_conf_linkstring链接 小程序购买
applet_buy_conf_original_idstring原始id 小程序购买
applet_buy_conf_appidstringappid 小程序购买
storageinteger库存
groupon_infoobject拼团活动信息
bargain_activity_infoobject砍价活动信息
is_subjectinteger是否是知识付费 1 是 2 不是
typestring商品类型。goods:实体商品,virtual:虚拟商品
sortinteger排序
selling_pointstring商品卖点
goods_watch_statusinteger商品直播看点状态 1:正常 2:失效
goods_watch_idinteger商品直播看点id
goods_watch_expirestring商品直播看点失效时间

seckill_conf 参数结构

参数必选类型描述
start_timeinteger秒杀开始时间
end_timestring秒杀结束时间
start_timestampinteger秒杀开始时间(时间戳)
end_timestampinteger秒杀结束时间(时间戳)
total_stockinteger秒杀库存
pricestring秒杀价格

groupon_info 参数结构

参数必选类型描述
people_numberinteger团购人数
lowest_pricestring最低价格
end_timestring结束时间

bargain_activity_info 参数结构

参数必选类型描述
statusinteger2-未开始,3-进行中,4-已结束
lowest_pricestring底价
end_timestring结束时间

响应示例

成功响应示例

json
{
    "code": 200,
    "data": {
        "total": 2,
        "list": [
            {
                "id": 10001,
                "img": "https://example.com/images/product1.jpg",
                "name": "示例商品1",
                "unit": "个",
                "is_sku": 2,
                "price": "99.00",
                "lowest_price": "89.00",
                "underlined_price": "129.00",
                "stock": 100,
                "custom_menu_id": 1001,
                "recommend": 1,
                "explain": 1,
                "heat_num": 50,
                "is_display_stock": 1,
                "welfare_activity_id": 0,
                "is_to_store_discount": 1,
                "to_store_discount_content": "{\"type\":\"4\",\"original_price\":129,\"front_money\":99}",
                "is_coupon_type": 2,
                "is_show_room": 1,
                "sale_type": 1,
                "sale_time": 0,
                "sale_time_date": "",
                "sale_status": 2,
                "seckill": 1,
                "linkType": "local",
                "link": "",
                "linkPicPath": "",
                "applet_buy_conf_link": "",
                "applet_buy_conf_original_id": "",
                "applet_buy_conf_appid": "",
                "storage": 100,
                "seckill_conf": {},
                "groupon_info": {},
                "bargain_activity_info": {},
                "is_subject": 2,
                "type": "goods",
                "sort": 1,
                "selling_point": "优质商品,值得购买",
                "goods_watch_status": 1,
                "goods_watch_id": 1001,
                "goods_watch_expire": ""
            },
            {
                "id": 10002,
                "img": "https://example.com/images/product2.jpg",
                "name": "示例商品2",
                "unit": "件",
                "is_sku": 2,
                "price": "199.00",
                "lowest_price": "179.00",
                "underlined_price": "259.00",
                "stock": 50,
                "custom_menu_id": 1001,
                "recommend": 0,
                "explain": 2,
                "heat_num": 30,
                "is_display_stock": 1,
                "welfare_activity_id": 0,
                "is_to_store_discount": 2,
                "to_store_discount_content": "",
                "is_coupon_type": 2,
                "is_show_room": 1,
                "sale_type": 1,
                "sale_time": 0,
                "sale_time_date": "",
                "sale_status": 2,
                "seckill": 1,
                "linkType": "local",
                "link": "",
                "linkPicPath": "",
                "applet_buy_conf_link": "",
                "applet_buy_conf_original_id": "",
                "applet_buy_conf_appid": "",
                "storage": 50,
                "seckill_conf": {},
                "groupon_info": {},
                "bargain_activity_info": {},
                "is_subject": 2,
                "type": "virtual",
                "sort": 2,
                "selling_point": "热销商品,限时优惠",
                "goods_watch_status": 1,
                "goods_watch_id": 1002,
                "goods_watch_expire": ""
            }
        ]
    },
    "msg": "Success"
}

搜索无结果示例

json
{
    "code": 200,
    "msg": "Success",
    "data": {
        "total": 0,
        "list": []
    }
}