店铺相关直播列表

简介

获取指定店铺相关的直播列表数据。

接口

    POST /shop/v1/liveList

request body

字段	类型	必选	描述
filter	object	否	过滤参数
orderby	object	否	排序参数
page	integer	否	默认:1
pagesize	integer	否	默认:10

filter 可选值

字段	类型	必选	描述
seller_id	string	否	店铺 ID
creator_uid	string	否	店铺关联达人uid
creator_unique_id	string	否	店铺关联达人唯一ID @xxxxxxx
seller_name	string	否	店铺名称
region	string	否	店铺所在国家/地区

seller_name 和 region 必须同时传

orderby 可选值

字段	必选	描述
start_time	否	开播时间
product_count	否	直播间商品数
total_user_count	否	总观看人数
units_sold	否	销量
gmv	否	销售额

request example

curl 'https://openapi.fastmoss.com/shop/v1/liveList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "filter": {
        "seller_id": "7495500842223700917",
        # "creator_uid": "6913013214088004614",
        # "creator_unique_id": "caffeinecandleschaos",

        # "seller_name": "Caffeine, Candles & Chaos",
        # "region": "US",
    },
    "orderby": [{
        "field": "start_time",
        "order": "desc"
    }],
    # "orderby": [{
    #     "field": "product_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "total_user_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "units_sold",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "gmv",
    #     "order": "desc"
    # }],
    "page": 1,
    "pagesize": 10
}'

response body

data.list

字段	类型	描述
title	string	直播间标题
room_id	string	直播间 ID
seller_id	string	店铺 ID
uid	string	店铺关联达人uid
cover	string	封面图片 URL
main_category_name	string	主推类目名称
main_category_id	int	主推类目 ID
start_time	int	开播时间
units_sold	int	销量
gmv	float	销售额
product_count	int	直播间商品数
total_user	int	总观看人数
duration	int	直播时长(秒)
max_user_count	int	最大同时在线人数
inc_follower_count	int	涨粉数
share_count	int	分享数
is_live	int	是否正在直播
live_type	int	直播类型 1:店铺直播 2:达人直播
creator	object	关联达人信息

data.list.creator

字段	类型	描述
uid	string	用户 ID
nickname	string	用户昵称
unique_id	string	用户唯一 ID
avatar	string	用户头像 URL
region	string	用户所在国家/地区
follower_count	int	用户粉丝数
category_id	int	用户类目 ID
category_name	string	用户类目名称

data.total

字段	类型	描述
total	string	总记录数

response example

{
  "code": 0,
  "data": {
    "total": 11943,
    "list": [
      {
        "title": "Food and snacks",
        "room_id": "7539139975317703438",
        "cover": "https://s.500fd.com/tt_live/7411364270883588910~tplv-obj.image",
        "main_category_id": 24,
        "main_category_name": "Food & Beverages",
        "creator": {
          "uid": "73083231876554752",
          "avatar": "https://s.500fd.com/tt_author/5aa17bc74b4fd2b91ae364d2a2c6e4d6~tplv-tiktokx-cropcenter:1080:1080.jpeg",
          "region": "US",
          "nickname": "Courtney Luper 🗝️✨",
          "unique_id": "courtneyluper",
          "follower_count": 17183,
          "category_id": 5,
          "category_name": "Food & Beverage"
        },
        "start_time": 1755343248,
        "units_sold": 1939,
        "gmv": 4253.69,
        "product_count": 99,
        "total_user": 84333,
        "duration": 37159,
        "max_user_count": 430,
        "inc_follower_count": 243,
        "share_count": 188,
        "is_live": 0,
        "live_type": 2
      }
    ]
  },
  "message": "success",
  "timestamp": 1773751121,
  "request_id": "76d984e2-e0f8-d04c-dc2d-c1fc9a18ffda"
}